gen_pkcs3: add comment explaining rationale
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2012
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182   <revnumber>
183 .version
184   </revnumber>
185   <date>
186 .fulldate
187   </date>
188   <authorinitials>EM</authorinitials>
189 </revision></revhistory>
190 <copyright><year>
191 .copyyear
192            </year><holder>University of Cambridge</holder></copyright>
193 </bookinfo>
194 .literal off
195
196
197 . /////////////////////////////////////////////////////////////////////////////
198 . This chunk of literal XML implements index entries of the form "x, see y" and
199 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
200 . at the top level, so we have to put the .chapter directive first.
201 . /////////////////////////////////////////////////////////////////////////////
202
203 .chapter "Introduction" "CHID1"
204 .literal xml
205
206 <indexterm role="variable">
207   <primary>$1, $2, etc.</primary>
208   <see><emphasis>numerical variables</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>address</primary>
212   <secondary>rewriting</secondary>
213   <see><emphasis>rewriting</emphasis></see>
214 </indexterm>
215 <indexterm role="concept">
216   <primary>Bounce Address Tag Validation</primary>
217   <see><emphasis>BATV</emphasis></see>
218 </indexterm>
219 <indexterm role="concept">
220   <primary>Client SMTP Authorization</primary>
221   <see><emphasis>CSA</emphasis></see>
222 </indexterm>
223 <indexterm role="concept">
224   <primary>CR character</primary>
225   <see><emphasis>carriage return</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>CRL</primary>
229   <see><emphasis>certificate revocation list</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>delivery</primary>
233   <secondary>failure report</secondary>
234   <see><emphasis>bounce message</emphasis></see>
235 </indexterm>
236 <indexterm role="concept">
237   <primary>dialup</primary>
238   <see><emphasis>intermittently connected hosts</emphasis></see>
239 </indexterm>
240 <indexterm role="concept">
241   <primary>exiscan</primary>
242   <see><emphasis>content scanning</emphasis></see>
243 </indexterm>
244 <indexterm role="concept">
245   <primary>failover</primary>
246   <see><emphasis>fallback</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>fallover</primary>
250   <see><emphasis>fallback</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>filter</primary>
254   <secondary>Sieve</secondary>
255   <see><emphasis>Sieve filter</emphasis></see>
256 </indexterm>
257 <indexterm role="concept">
258   <primary>ident</primary>
259   <see><emphasis>RFC 1413</emphasis></see>
260 </indexterm>
261 <indexterm role="concept">
262   <primary>LF character</primary>
263   <see><emphasis>linefeed</emphasis></see>
264 </indexterm>
265 <indexterm role="concept">
266   <primary>maximum</primary>
267   <seealso><emphasis>limit</emphasis></seealso>
268 </indexterm>
269 <indexterm role="concept">
270   <primary>monitor</primary>
271   <see><emphasis>Exim monitor</emphasis></see>
272 </indexterm>
273 <indexterm role="concept">
274   <primary>no_<emphasis>xxx</emphasis></primary>
275   <see>entry for xxx</see>
276 </indexterm>
277 <indexterm role="concept">
278   <primary>NUL</primary>
279   <see><emphasis>binary zero</emphasis></see>
280 </indexterm>
281 <indexterm role="concept">
282   <primary>passwd file</primary>
283   <see><emphasis>/etc/passwd</emphasis></see>
284 </indexterm>
285 <indexterm role="concept">
286   <primary>process id</primary>
287   <see><emphasis>pid</emphasis></see>
288 </indexterm>
289 <indexterm role="concept">
290   <primary>RBL</primary>
291   <see><emphasis>DNS list</emphasis></see>
292 </indexterm>
293 <indexterm role="concept">
294   <primary>redirection</primary>
295   <see><emphasis>address redirection</emphasis></see>
296 </indexterm>
297 <indexterm role="concept">
298   <primary>return path</primary>
299   <seealso><emphasis>envelope sender</emphasis></seealso>
300 </indexterm>
301 <indexterm role="concept">
302   <primary>scanning</primary>
303   <see><emphasis>content scanning</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>SSL</primary>
307   <see><emphasis>TLS</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>string</primary>
311   <secondary>expansion</secondary>
312   <see><emphasis>expansion</emphasis></see>
313 </indexterm>
314 <indexterm role="concept">
315   <primary>top bit</primary>
316   <see><emphasis>8-bit characters</emphasis></see>
317 </indexterm>
318 <indexterm role="concept">
319   <primary>variables</primary>
320   <see><emphasis>expansion, variables</emphasis></see>
321 </indexterm>
322 <indexterm role="concept">
323   <primary>zero, binary</primary>
324   <see><emphasis>binary zero</emphasis></see>
325 </indexterm>
326
327 .literal off
328
329
330 . /////////////////////////////////////////////////////////////////////////////
331 . This is the real start of the first chapter. See the comment above as to why
332 . we can't have the .chapter line here.
333 . chapter "Introduction"
334 . /////////////////////////////////////////////////////////////////////////////
335
336 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
337 Unix-like operating systems. It was designed on the assumption that it would be
338 run on hosts that are permanently connected to the Internet. However, it can be
339 used on intermittently connected hosts with suitable configuration adjustments.
340
341 Configuration files currently exist for the following operating systems: AIX,
342 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
343 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
344 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
345 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
346 Some of these operating systems are no longer current and cannot easily be
347 tested, so the configuration files may no longer work in practice.
348
349 There are also configuration files for compiling Exim in the Cygwin environment
350 that can be installed on systems running Windows. However, this document does
351 not contain any information about running Exim in the Cygwin environment.
352
353 The terms and conditions for the use and distribution of Exim are contained in
354 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
355 Public Licence, a copy of which may be found in the file &_LICENCE_&.
356
357 The use, supply or promotion of Exim for the purpose of sending bulk,
358 unsolicited electronic mail is incompatible with the basic aims of the program,
359 which revolve around the free provision of a service that enhances the quality
360 of personal communications. The author of Exim regards indiscriminate
361 mass-mailing as an antisocial, irresponsible abuse of the Internet.
362
363 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
364 experience of running and working on the Smail 3 code, I could never have
365 contemplated starting to write a new MTA. Many of the ideas and user interfaces
366 were originally taken from Smail 3, though the actual code of Exim is entirely
367 new, and has developed far beyond the initial concept.
368
369 Many people, both in Cambridge and around the world, have contributed to the
370 development and the testing of Exim, and to porting it to various operating
371 systems. I am grateful to them all. The distribution now contains a file called
372 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
373 contributors.
374
375
376 .section "Exim documentation" "SECID1"
377 . Keep this example change bar when updating the documentation!
378
379 .new
380 .cindex "documentation"
381 This edition of the Exim specification applies to version &version() of Exim.
382 Substantive changes from the &previousversion; edition are marked in some
383 renditions of the document; this paragraph is so marked if the rendition is
384 capable of showing a change indicator.
385 .wen
386
387 This document is very much a reference manual; it is not a tutorial. The reader
388 is expected to have some familiarity with the SMTP mail transfer protocol and
389 with general Unix system administration. Although there are some discussions
390 and examples in places, the information is mostly organized in a way that makes
391 it easy to look up, rather than in a natural order for sequential reading.
392 Furthermore, the manual aims to cover every aspect of Exim in detail, including
393 a number of rarely-used, special-purpose features that are unlikely to be of
394 very wide interest.
395
396 .cindex "books about Exim"
397 An &"easier"& discussion of Exim which provides more in-depth explanatory,
398 introductory, and tutorial material can be found in a book entitled &'The Exim
399 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
400 (&url(http://www.uit.co.uk/exim-book/)).
401
402 This book also contains a chapter that gives a general introduction to SMTP and
403 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
404 with the latest release of Exim. (Note that the earlier book about Exim,
405 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
406
407 .cindex "Debian" "information sources"
408 If you are using a Debian distribution of Exim, you will find information about
409 Debian-specific features in the file
410 &_/usr/share/doc/exim4-base/README.Debian_&.
411 The command &(man update-exim.conf)& is another source of Debian-specific
412 information.
413
414 .cindex "&_doc/NewStuff_&"
415 .cindex "&_doc/ChangeLog_&"
416 .cindex "change log"
417 As the program develops, there may be features in newer versions that have not
418 yet made it into this document, which is updated only when the most significant
419 digit of the fractional part of the version number changes. Specifications of
420 new features that are not yet in this manual are placed in the file
421 &_doc/NewStuff_& in the Exim distribution.
422
423 Some features may be classified as &"experimental"&. These may change
424 incompatibly while they are developing, or even be withdrawn. For this reason,
425 they are not documented in this manual. Information about experimental features
426 can be found in the file &_doc/experimental.txt_&.
427
428 All changes to the program (whether new features, bug fixes, or other kinds of
429 change) are noted briefly in the file called &_doc/ChangeLog_&.
430
431 .cindex "&_doc/spec.txt_&"
432 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
433 that it can easily be searched with a text editor. Other files in the &_doc_&
434 directory are:
435
436 .table2 100pt
437 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
438 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
439 .row &_exim.8_&              "a man page of Exim's command line options"
440 .row &_experimental.txt_&    "documentation of experimental features"
441 .row &_filter.txt_&          "specification of the filter language"
442 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
443 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
444 .endtable
445
446 The main specification and the specification of the filtering language are also
447 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
448 &<<SECTavail>>& below tells you how to get hold of these.
449
450
451
452 .section "FTP and web sites" "SECID2"
453 .cindex "web site"
454 .cindex "FTP site"
455 The primary site for Exim source distributions is currently the University of
456 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
457 distribution'& below. In addition, there is a web site and an FTP site at
458 &%exim.org%&. These are now also hosted at the University of Cambridge. The
459 &%exim.org%& site was previously hosted for a number of years by Energis
460 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
461
462 .cindex "wiki"
463 .cindex "FAQ"
464 As well as Exim distribution tar files, the Exim web site contains a number of
465 differently formatted versions of the documentation. A recent addition to the
466 online information is the Exim wiki (&url(http://wiki.exim.org)),
467 which contains what used to be a separate FAQ, as well as various other
468 examples, tips, and know-how that have been contributed by Exim users.
469
470 .cindex Bugzilla
471 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
472 this to report bugs, and also to add items to the wish list. Please search
473 first to check that you are not duplicating a previous entry.
474
475
476
477 .section "Mailing lists" "SECID3"
478 .cindex "mailing lists" "for Exim users"
479 The following Exim mailing lists exist:
480
481 .table2 140pt
482 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
483 .row &'exim-users@exim.org'&      "General discussion list"
484 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
485 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
486 .endtable
487
488 You can subscribe to these lists, change your existing subscriptions, and view
489 or search the archives via the mailing lists link on the Exim home page.
490 .cindex "Debian" "mailing list for"
491 If you are using a Debian distribution of Exim, you may wish to subscribe to
492 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
493 via this web page:
494 .display
495 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
496 .endd
497 Please ask Debian-specific questions on this list and not on the general Exim
498 lists.
499
500 .section "Exim training" "SECID4"
501 .cindex "training courses"
502 Training courses in Cambridge (UK) used to be run annually by the author of
503 Exim, before he retired. At the time of writing, there are no plans to run
504 further Exim courses in Cambridge. However, if that changes, relevant
505 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
506
507 .section "Bug reports" "SECID5"
508 .cindex "bug reports"
509 .cindex "reporting bugs"
510 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
511 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
512 whether some behaviour is a bug or not, the best thing to do is to post a
513 message to the &'exim-dev'& mailing list and have it discussed.
514
515
516
517 .section "Where to find the Exim distribution" "SECTavail"
518 .cindex "FTP site"
519 .cindex "distribution" "ftp site"
520 The master ftp site for the Exim distribution is
521 .display
522 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
523 .endd
524 This is mirrored by
525 .display
526 &*ftp://ftp.exim.org/pub/exim*&
527 .endd
528 The file references that follow are relative to the &_exim_& directories at
529 these sites. There are now quite a number of independent mirror sites around
530 the world. Those that I know about are listed in the file called &_Mirrors_&.
531
532 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
533 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
534 distributions), and &_Testing_& for testing versions. In the &_exim4_&
535 subdirectory, the current release can always be found in files called
536 .display
537 &_exim-n.nn.tar.gz_&
538 &_exim-n.nn.tar.bz2_&
539 .endd
540 where &'n.nn'& is the highest such version number in the directory. The two
541 files contain identical data; the only difference is the type of compression.
542 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
543
544 .cindex "distribution" "signing details"
545 .cindex "distribution" "public key"
546 .cindex "public key for signed distribution"
547 .new
548 The distributions will be PGP signed by an individual key of the Release
549 Coordinator.  This key will have a uid containing an email address in the
550 &'exim.org'& domain and will have signatures from other people, including
551 other Exim maintainers.  We expect that the key will be in the "strong set" of
552 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
553 PGP key, a version of which can be found in the release directory in the file
554 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
555 such as &'pool.sks-keyservers.net'&.
556
557 At time of last update, releases were being made by Phil Pennock and signed with
558 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
559 A trust path from Nigel's key to Phil's can be observed at
560 &url(https://www.security.spodhuis.org/exim-trustpath).
561 .wen
562
563 The signatures for the tar bundles are in:
564 .display
565 &_exim-n.nn.tar.gz.asc_&
566 &_exim-n.nn.tar.bz2.asc_&
567 .endd
568 For each released version, the log of changes is made separately available in a
569 separate file in the directory &_ChangeLogs_& so that it is possible to
570 find out what has changed without having to download the entire distribution.
571
572 .cindex "documentation" "available formats"
573 The main distribution contains ASCII versions of this specification and other
574 documentation; other formats of the documents are available in separate files
575 inside the &_exim4_& directory of the FTP site:
576 .display
577 &_exim-html-n.nn.tar.gz_&
578 &_exim-pdf-n.nn.tar.gz_&
579 &_exim-postscript-n.nn.tar.gz_&
580 &_exim-texinfo-n.nn.tar.gz_&
581 .endd
582 These tar files contain only the &_doc_& directory, not the complete
583 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
584
585
586 .section "Limitations" "SECID6"
587 .ilist
588 .cindex "limitations of Exim"
589 .cindex "bang paths" "not handled by Exim"
590 Exim is designed for use as an Internet MTA, and therefore handles addresses in
591 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
592 simple two-component bang paths can be converted by a straightforward rewriting
593 configuration. This restriction does not prevent Exim from being interfaced to
594 UUCP as a transport mechanism, provided that domain addresses are used.
595 .next
596 .cindex "domainless addresses"
597 .cindex "address" "without domain"
598 Exim insists that every address it handles has a domain attached. For incoming
599 local messages, domainless addresses are automatically qualified with a
600 configured domain value. Configuration options specify from which remote
601 systems unqualified addresses are acceptable. These are then qualified on
602 arrival.
603 .next
604 .cindex "transport" "external"
605 .cindex "external transports"
606 The only external transport mechanisms that are currently implemented are SMTP
607 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
608 transport is available, and there are facilities for writing messages to files
609 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
610 to send messages to other transport mechanisms such as UUCP, provided they can
611 handle domain-style addresses. Batched SMTP input is also catered for.
612 .next
613 Exim is not designed for storing mail for dial-in hosts. When the volumes of
614 such mail are large, it is better to get the messages &"delivered"& into files
615 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
616 other means.
617 .next
618 Although Exim does have basic facilities for scanning incoming messages, these
619 are not comprehensive enough to do full virus or spam scanning. Such operations
620 are best carried out using additional specialized software packages. If you
621 compile Exim with the content-scanning extension, straightforward interfaces to
622 a number of common scanners are provided.
623 .endlist
624
625
626 .section "Run time configuration" "SECID7"
627 Exim's run time configuration is held in a single text file that is divided
628 into a number of sections. The entries in this file consist of keywords and
629 values, in the style of Smail 3 configuration files. A default configuration
630 file which is suitable for simple online installations is provided in the
631 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
632
633
634 .section "Calling interface" "SECID8"
635 .cindex "Sendmail compatibility" "command line interface"
636 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
637 can be a straight replacement for &_/usr/lib/sendmail_& or
638 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
639 about Sendmail in order to run Exim. For actions other than sending messages,
640 Sendmail-compatible options also exist, but those that produce output (for
641 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
642 format. There are also some additional options that are compatible with Smail
643 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
644 documents all Exim's command line options. This information is automatically
645 made into the man page that forms part of the Exim distribution.
646
647 Control of messages on the queue can be done via certain privileged command
648 line options. There is also an optional monitor program called &'eximon'&,
649 which displays current information in an X window, and which contains a menu
650 interface to Exim's command line administration options.
651
652
653
654 .section "Terminology" "SECID9"
655 .cindex "terminology definitions"
656 .cindex "body of message" "definition of"
657 The &'body'& of a message is the actual data that the sender wants to transmit.
658 It is the last part of a message, and is separated from the &'header'& (see
659 below) by a blank line.
660
661 .cindex "bounce message" "definition of"
662 When a message cannot be delivered, it is normally returned to the sender in a
663 delivery failure message or a &"non-delivery report"& (NDR). The term
664 &'bounce'& is commonly used for this action, and the error reports are often
665 called &'bounce messages'&. This is a convenient shorthand for &"delivery
666 failure error report"&. Such messages have an empty sender address in the
667 message's &'envelope'& (see below) to ensure that they cannot themselves give
668 rise to further bounce messages.
669
670 The term &'default'& appears frequently in this manual. It is used to qualify a
671 value which is used in the absence of any setting in the configuration. It may
672 also qualify an action which is taken unless a configuration setting specifies
673 otherwise.
674
675 The term &'defer'& is used when the delivery of a message to a specific
676 destination cannot immediately take place for some reason (a remote host may be
677 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
678 until a later time.
679
680 The word &'domain'& is sometimes used to mean all but the first component of a
681 host's name. It is &'not'& used in that sense here, where it normally refers to
682 the part of an email address following the @ sign.
683
684 .cindex "envelope, definition of"
685 .cindex "sender" "definition of"
686 A message in transit has an associated &'envelope'&, as well as a header and a
687 body. The envelope contains a sender address (to which bounce messages should
688 be delivered), and any number of recipient addresses. References to the
689 sender or the recipients of a message usually mean the addresses in the
690 envelope. An MTA uses these addresses for delivery, and for returning bounce
691 messages, not the addresses that appear in the header lines.
692
693 .cindex "message" "header, definition of"
694 .cindex "header section" "definition of"
695 The &'header'& of a message is the first part of a message's text, consisting
696 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
697 &'Subject:'&, etc. Long header lines can be split over several text lines by
698 indenting the continuations. The header is separated from the body by a blank
699 line.
700
701 .cindex "local part" "definition of"
702 .cindex "domain" "definition of"
703 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
704 part of an email address that precedes the @ sign. The part that follows the
705 @ sign is called the &'domain'& or &'mail domain'&.
706
707 .cindex "local delivery" "definition of"
708 .cindex "remote delivery, definition of"
709 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
710 delivery to a file or a pipe on the local host from delivery by SMTP over
711 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
712 host it is running on are &'remote'&.
713
714 .cindex "return path" "definition of"
715 &'Return path'& is another name that is used for the sender address in a
716 message's envelope.
717
718 .cindex "queue" "definition of"
719 The term &'queue'& is used to refer to the set of messages awaiting delivery,
720 because this term is in widespread use in the context of MTAs. However, in
721 Exim's case the reality is more like a pool than a queue, because there is
722 normally no ordering of waiting messages.
723
724 .cindex "queue runner" "definition of"
725 The term &'queue runner'& is used to describe a process that scans the queue
726 and attempts to deliver those messages whose retry times have come. This term
727 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
728 the waiting messages are normally processed in an unpredictable order.
729
730 .cindex "spool directory" "definition of"
731 The term &'spool directory'& is used for a directory in which Exim keeps the
732 messages on its queue &-- that is, those that it is in the process of
733 delivering. This should not be confused with the directory in which local
734 mailboxes are stored, which is called a &"spool directory"& by some people. In
735 the Exim documentation, &"spool"& is always used in the first sense.
736
737
738
739
740
741
742 . ////////////////////////////////////////////////////////////////////////////
743 . ////////////////////////////////////////////////////////////////////////////
744
745 .chapter "Incorporated code" "CHID2"
746 .cindex "incorporated code"
747 .cindex "regular expressions" "library"
748 .cindex "PCRE"
749 A number of pieces of external code are included in the Exim distribution.
750
751 .ilist
752 Regular expressions are supported in the main Exim program and in the
753 Exim monitor using the freely-distributable PCRE library, copyright
754 &copy; University of Cambridge. The source to PCRE is no longer shipped with
755 Exim, so you will need to use the version of PCRE shipped with your system,
756 or obtain and install the full version of the library from
757 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
758 .next
759 .cindex "cdb" "acknowledgment"
760 Support for the cdb (Constant DataBase) lookup method is provided by code
761 contributed by Nigel Metheringham of (at the time he contributed it) Planet
762 Online Ltd. The implementation is completely contained within the code of Exim.
763 It does not link against an external cdb library. The code contains the
764 following statements:
765
766 .blockquote
767 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
768
769 This program is free software; you can redistribute it and/or modify it under
770 the terms of the GNU General Public License as published by the Free Software
771 Foundation; either version 2 of the License, or (at your option) any later
772 version.
773 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
774 the spec and sample code for cdb can be obtained from
775 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
776 some code from Dan Bernstein's implementation (which has no license
777 restrictions applied to it).
778 .endblockquote
779 .next
780 .cindex "SPA authentication"
781 .cindex "Samba project"
782 .cindex "Microsoft Secure Password Authentication"
783 Client support for Microsoft's &'Secure Password Authentication'& is provided
784 by code contributed by Marc Prud'hommeaux. Server support was contributed by
785 Tom Kistner. This includes code taken from the Samba project, which is released
786 under the Gnu GPL.
787 .next
788 .cindex "Cyrus"
789 .cindex "&'pwcheck'& daemon"
790 .cindex "&'pwauthd'& daemon"
791 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
792 by code taken from the Cyrus-SASL library and adapted by Alexander S.
793 Sabourenkov. The permission notice appears below, in accordance with the
794 conditions expressed therein.
795
796 .blockquote
797 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
798
799 Redistribution and use in source and binary forms, with or without
800 modification, are permitted provided that the following conditions
801 are met:
802
803 .olist
804 Redistributions of source code must retain the above copyright
805 notice, this list of conditions and the following disclaimer.
806 .next
807 Redistributions in binary form must reproduce the above copyright
808 notice, this list of conditions and the following disclaimer in
809 the documentation and/or other materials provided with the
810 distribution.
811 .next
812 The name &"Carnegie Mellon University"& must not be used to
813 endorse or promote products derived from this software without
814 prior written permission. For permission or any other legal
815 details, please contact
816 .display
817               Office of Technology Transfer
818               Carnegie Mellon University
819               5000 Forbes Avenue
820               Pittsburgh, PA  15213-3890
821               (412) 268-4387, fax: (412) 268-7395
822               tech-transfer@andrew.cmu.edu
823 .endd
824 .next
825 Redistributions of any form whatsoever must retain the following
826 acknowledgment:
827
828 &"This product includes software developed by Computing Services
829 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
830
831 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
832 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
833 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
834 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
835 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
836 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
837 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
838 .endlist
839 .endblockquote
840
841 .next
842 .cindex "Exim monitor" "acknowledgment"
843 .cindex "X-windows"
844 .cindex "Athena"
845 The Exim Monitor program, which is an X-Window application, includes
846 modified versions of the Athena StripChart and TextPop widgets.
847 This code is copyright by DEC and MIT, and their permission notice appears
848 below, in accordance with the conditions expressed therein.
849
850 .blockquote
851 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
852 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
853
854 All Rights Reserved
855
856 Permission to use, copy, modify, and distribute this software and its
857 documentation for any purpose and without fee is hereby granted,
858 provided that the above copyright notice appear in all copies and that
859 both that copyright notice and this permission notice appear in
860 supporting documentation, and that the names of Digital or MIT not be
861 used in advertising or publicity pertaining to distribution of the
862 software without specific, written prior permission.
863
864 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
865 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
866 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
867 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
868 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
869 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
870 SOFTWARE.
871 .endblockquote
872
873 .next
874 Many people have contributed code fragments, some large, some small, that were
875 not covered by any specific licence requirements. It is assumed that the
876 contributors are happy to see their code incorporated into Exim under the GPL.
877 .endlist
878
879
880
881
882
883 . ////////////////////////////////////////////////////////////////////////////
884 . ////////////////////////////////////////////////////////////////////////////
885
886 .chapter "How Exim receives and delivers mail" "CHID11" &&&
887          "Receiving and delivering mail"
888
889
890 .section "Overall philosophy" "SECID10"
891 .cindex "design philosophy"
892 Exim is designed to work efficiently on systems that are permanently connected
893 to the Internet and are handling a general mix of mail. In such circumstances,
894 most messages can be delivered immediately. Consequently, Exim does not
895 maintain independent queues of messages for specific domains or hosts, though
896 it does try to send several messages in a single SMTP connection after a host
897 has been down, and it also maintains per-host retry information.
898
899
900 .section "Policy control" "SECID11"
901 .cindex "policy control" "overview"
902 Policy controls are now an important feature of MTAs that are connected to the
903 Internet. Perhaps their most important job is to stop MTAs being abused as
904 &"open relays"& by misguided individuals who send out vast amounts of
905 unsolicited junk, and want to disguise its source. Exim provides flexible
906 facilities for specifying policy controls on incoming mail:
907
908 .ilist
909 .cindex "&ACL;" "introduction"
910 Exim 4 (unlike previous versions of Exim) implements policy controls on
911 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
912 series of statements that may either grant or deny access. ACLs can be used at
913 several places in the SMTP dialogue while receiving a message from a remote
914 host. However, the most common places are after each RCPT command, and at the
915 very end of the message. The sysadmin can specify conditions for accepting or
916 rejecting individual recipients or the entire message, respectively, at these
917 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
918 error code.
919 .next
920 An ACL is also available for locally generated, non-SMTP messages. In this
921 case, the only available actions are to accept or deny the entire message.
922 .next
923 When Exim is compiled with the content-scanning extension, facilities are
924 provided in the ACL mechanism for passing the message to external virus and/or
925 spam scanning software. The result of such a scan is passed back to the ACL,
926 which can then use it to decide what to do with the message.
927 .next
928 When a message has been received, either from a remote host or from the local
929 host, but before the final acknowledgment has been sent, a locally supplied C
930 function called &[local_scan()]& can be run to inspect the message and decide
931 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
932 is accepted, the list of recipients can be modified by the function.
933 .next
934 Using the &[local_scan()]& mechanism is another way of calling external scanner
935 software. The &%SA-Exim%& add-on package works this way. It does not require
936 Exim to be compiled with the content-scanning extension.
937 .next
938 After a message has been accepted, a further checking mechanism is available in
939 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
940 runs at the start of every delivery process.
941 .endlist
942
943
944
945 .section "User filters" "SECID12"
946 .cindex "filter" "introduction"
947 .cindex "Sieve filter"
948 In a conventional Exim configuration, users are able to run private filters by
949 setting up appropriate &_.forward_& files in their home directories. See
950 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
951 configuration needed to support this, and the separate document entitled
952 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
953 of filtering are available:
954
955 .ilist
956 Sieve filters are written in the standard filtering language that is defined
957 by RFC 3028.
958 .next
959 Exim filters are written in a syntax that is unique to Exim, but which is more
960 powerful than Sieve, which it pre-dates.
961 .endlist
962
963 User filters are run as part of the routing process, described below.
964
965
966
967 .section "Message identification" "SECTmessiden"
968 .cindex "message ids" "details of format"
969 .cindex "format" "of message id"
970 .cindex "id of message"
971 .cindex "base62"
972 .cindex "base36"
973 .cindex "Darwin"
974 .cindex "Cygwin"
975 Every message handled by Exim is given a &'message id'& which is sixteen
976 characters long. It is divided into three parts, separated by hyphens, for
977 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
978 normally encoding numbers in base 62. However, in the Darwin operating
979 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
980 (avoiding the use of lower case letters) is used instead, because the message
981 id is used to construct file names, and the names of files in those systems are
982 not always case-sensitive.
983
984 .cindex "pid (process id)" "re-use of"
985 The detail of the contents of the message id have changed as Exim has evolved.
986 Earlier versions relied on the operating system not re-using a process id (pid)
987 within one second. On modern operating systems, this assumption can no longer
988 be made, so the algorithm had to be changed. To retain backward compatibility,
989 the format of the message id was retained, which is why the following rules are
990 somewhat eccentric:
991
992 .ilist
993 The first six characters of the message id are the time at which the message
994 started to be received, to a granularity of one second. That is, this field
995 contains the number of seconds since the start of the epoch (the normal Unix
996 way of representing the date and time of day).
997 .next
998 After the first hyphen, the next six characters are the id of the process that
999 received the message.
1000 .next
1001 There are two different possibilities for the final two characters:
1002 .olist
1003 .oindex "&%localhost_number%&"
1004 If &%localhost_number%& is not set, this value is the fractional part of the
1005 time of reception, normally in units of 1/2000 of a second, but for systems
1006 that must use base 36 instead of base 62 (because of case-insensitive file
1007 systems), the units are 1/1000 of a second.
1008 .next
1009 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1010 the fractional part of the time, which in this case is in units of 1/200
1011 (1/100) of a second.
1012 .endlist
1013 .endlist
1014
1015 After a message has been received, Exim waits for the clock to tick at the
1016 appropriate resolution before proceeding, so that if another message is
1017 received by the same process, or by another process with the same (re-used)
1018 pid, it is guaranteed that the time will be different. In most cases, the clock
1019 will already have ticked while the message was being received.
1020
1021
1022 .section "Receiving mail" "SECID13"
1023 .cindex "receiving mail"
1024 .cindex "message" "reception"
1025 The only way Exim can receive mail from another host is using SMTP over
1026 TCP/IP, in which case the sender and recipient addresses are transferred using
1027 SMTP commands. However, from a locally running process (such as a user's MUA),
1028 there are several possibilities:
1029
1030 .ilist
1031 If the process runs Exim with the &%-bm%& option, the message is read
1032 non-interactively (usually via a pipe), with the recipients taken from the
1033 command line, or from the body of the message if &%-t%& is also used.
1034 .next
1035 If the process runs Exim with the &%-bS%& option, the message is also read
1036 non-interactively, but in this case the recipients are listed at the start of
1037 the message in a series of SMTP RCPT commands, terminated by a DATA
1038 command. This is so-called &"batch SMTP"& format,
1039 but it isn't really SMTP. The SMTP commands are just another way of passing
1040 envelope addresses in a non-interactive submission.
1041 .next
1042 If the process runs Exim with the &%-bs%& option, the message is read
1043 interactively, using the SMTP protocol. A two-way pipe is normally used for
1044 passing data between the local process and the Exim process.
1045 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1046 example, the ACLs for SMTP commands are used for this form of submission.
1047 .next
1048 A local process may also make a TCP/IP call to the host's loopback address
1049 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1050 does not treat the loopback address specially. It treats all such connections
1051 in the same way as connections from other hosts.
1052 .endlist
1053
1054
1055 .cindex "message sender, constructed by Exim"
1056 .cindex "sender" "constructed by Exim"
1057 In the three cases that do not involve TCP/IP, the sender address is
1058 constructed from the login name of the user that called Exim and a default
1059 qualification domain (which can be set by the &%qualify_domain%& configuration
1060 option). For local or batch SMTP, a sender address that is passed using the
1061 SMTP MAIL command is ignored. However, the system administrator may allow
1062 certain users (&"trusted users"&) to specify a different sender address
1063 unconditionally, or all users to specify certain forms of different sender
1064 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1065 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1066 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1067 users to change sender addresses.
1068
1069 Messages received by either of the non-interactive mechanisms are subject to
1070 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1071 (either over TCP/IP, or interacting with a local process) can be checked by a
1072 number of ACLs that operate at different times during the SMTP session. Either
1073 individual recipients, or the entire message, can be rejected if local policy
1074 requirements are not met. The &[local_scan()]& function (see chapter
1075 &<<CHAPlocalscan>>&) is run for all incoming messages.
1076
1077 Exim can be configured not to start a delivery process when a message is
1078 received; this can be unconditional, or depend on the number of incoming SMTP
1079 connections or the system load. In these situations, new messages wait on the
1080 queue until a queue runner process picks them up. However, in standard
1081 configurations under normal conditions, delivery is started as soon as a
1082 message is received.
1083
1084
1085
1086
1087
1088 .section "Handling an incoming message" "SECID14"
1089 .cindex "spool directory" "files that hold a message"
1090 .cindex "file" "how a message is held"
1091 When Exim accepts a message, it writes two files in its spool directory. The
1092 first contains the envelope information, the current status of the message, and
1093 the header lines, and the second contains the body of the message. The names of
1094 the two spool files consist of the message id, followed by &`-H`& for the
1095 file containing the envelope and header, and &`-D`& for the data file.
1096
1097 .cindex "spool directory" "&_input_& sub-directory"
1098 By default all these message files are held in a single directory called
1099 &_input_& inside the general Exim spool directory. Some operating systems do
1100 not perform very well if the number of files in a directory gets large; to
1101 improve performance in such cases, the &%split_spool_directory%& option can be
1102 used. This causes Exim to split up the input files into 62 sub-directories
1103 whose names are single letters or digits. When this is done, the queue is
1104 processed one sub-directory at a time instead of all at once, which can improve
1105 overall performance even when there are not enough files in each directory to
1106 affect file system performance.
1107
1108 The envelope information consists of the address of the message's sender and
1109 the addresses of the recipients. This information is entirely separate from
1110 any addresses contained in the header lines. The status of the message includes
1111 a list of recipients who have already received the message. The format of the
1112 first spool file is described in chapter &<<CHAPspool>>&.
1113
1114 .cindex "rewriting" "addresses"
1115 Address rewriting that is specified in the rewrite section of the configuration
1116 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1117 both in the header lines and the envelope, at the time the message is accepted.
1118 If during the course of delivery additional addresses are generated (for
1119 example, via aliasing), these new addresses are rewritten as soon as they are
1120 generated. At the time a message is actually delivered (transported) further
1121 rewriting can take place; because this is a transport option, it can be
1122 different for different forms of delivery. It is also possible to specify the
1123 addition or removal of certain header lines at the time the message is
1124 delivered (see chapters &<<CHAProutergeneric>>& and
1125 &<<CHAPtransportgeneric>>&).
1126
1127
1128
1129 .section "Life of a message" "SECID15"
1130 .cindex "message" "life of"
1131 .cindex "message" "frozen"
1132 A message remains in the spool directory until it is completely delivered to
1133 its recipients or to an error address, or until it is deleted by an
1134 administrator or by the user who originally created it. In cases when delivery
1135 cannot proceed &-- for example, when a message can neither be delivered to its
1136 recipients nor returned to its sender, the message is marked &"frozen"& on the
1137 spool, and no more deliveries are attempted.
1138
1139 .cindex "frozen messages" "thawing"
1140 .cindex "message" "thawing frozen"
1141 An administrator can &"thaw"& such messages when the problem has been
1142 corrected, and can also freeze individual messages by hand if necessary. In
1143 addition, an administrator can force a delivery error, causing a bounce message
1144 to be sent.
1145
1146 .oindex "&%timeout_frozen_after%&"
1147 .oindex "&%ignore_bounce_errors_after%&"
1148 There are options called &%ignore_bounce_errors_after%& and
1149 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1150 The first applies only to frozen bounces, the second to any frozen messages.
1151
1152 .cindex "message" "log file for"
1153 .cindex "log" "file for each message"
1154 While Exim is working on a message, it writes information about each delivery
1155 attempt to its main log file. This includes successful, unsuccessful, and
1156 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1157 lines are also written to a separate &'message log'& file for each message.
1158 These logs are solely for the benefit of the administrator, and are normally
1159 deleted along with the spool files when processing of a message is complete.
1160 The use of individual message logs can be disabled by setting
1161 &%no_message_logs%&; this might give an improvement in performance on very busy
1162 systems.
1163
1164 .cindex "journal file"
1165 .cindex "file" "journal"
1166 All the information Exim itself needs to set up a delivery is kept in the first
1167 spool file, along with the header lines. When a successful delivery occurs, the
1168 address is immediately written at the end of a journal file, whose name is the
1169 message id followed by &`-J`&. At the end of a delivery run, if there are some
1170 addresses left to be tried again later, the first spool file (the &`-H`& file)
1171 is updated to indicate which these are, and the journal file is then deleted.
1172 Updating the spool file is done by writing a new file and renaming it, to
1173 minimize the possibility of data loss.
1174
1175 Should the system or the program crash after a successful delivery but before
1176 the spool file has been updated, the journal is left lying around. The next
1177 time Exim attempts to deliver the message, it reads the journal file and
1178 updates the spool file before proceeding. This minimizes the chances of double
1179 deliveries caused by crashes.
1180
1181
1182
1183 .section "Processing an address for delivery" "SECTprocaddress"
1184 .cindex "drivers" "definition of"
1185 .cindex "router" "definition of"
1186 .cindex "transport" "definition of"
1187 The main delivery processing elements of Exim are called &'routers'& and
1188 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1189 number of them is provided in the source distribution, and compile-time options
1190 specify which ones are included in the binary. Run time options specify which
1191 ones are actually used for delivering messages.
1192
1193 .cindex "drivers" "instance definition"
1194 Each driver that is specified in the run time configuration is an &'instance'&
1195 of that particular driver type. Multiple instances are allowed; for example,
1196 you can set up several different &(smtp)& transports, each with different
1197 option values that might specify different ports or different timeouts. Each
1198 instance has its own identifying name. In what follows we will normally use the
1199 instance name when discussing one particular instance (that is, one specific
1200 configuration of the driver), and the generic driver name when discussing
1201 the driver's features in general.
1202
1203 A &'router'& is a driver that operates on an address, either determining how
1204 its delivery should happen, by assigning it to a specific transport, or
1205 converting the address into one or more new addresses (for example, via an
1206 alias file). A router may also explicitly choose to fail an address, causing it
1207 to be bounced.
1208
1209 A &'transport'& is a driver that transmits a copy of the message from Exim's
1210 spool to some destination. There are two kinds of transport: for a &'local'&
1211 transport, the destination is a file or a pipe on the local host, whereas for a
1212 &'remote'& transport the destination is some other host. A message is passed
1213 to a specific transport as a result of successful routing. If a message has
1214 several recipients, it may be passed to a number of different transports.
1215
1216 .cindex "preconditions" "definition of"
1217 An address is processed by passing it to each configured router instance in
1218 turn, subject to certain preconditions, until a router accepts the address or
1219 specifies that it should be bounced. We will describe this process in more
1220 detail shortly. First, as a simple example, we consider how each recipient
1221 address in a message is processed in a small configuration of three routers.
1222
1223 To make this a more concrete example, it is described in terms of some actual
1224 routers, but remember, this is only an example. You can configure Exim's
1225 routers in many different ways, and there may be any number of routers in a
1226 configuration.
1227
1228 The first router that is specified in a configuration is often one that handles
1229 addresses in domains that are not recognized specially by the local host. These
1230 are typically addresses for arbitrary domains on the Internet. A precondition
1231 is set up which looks for the special domains known to the host (for example,
1232 its own domain name), and the router is run for addresses that do &'not'&
1233 match. Typically, this is a router that looks up domains in the DNS in order to
1234 find the hosts to which this address routes. If it succeeds, the address is
1235 assigned to a suitable SMTP transport; if it does not succeed, the router is
1236 configured to fail the address.
1237
1238 The second router is reached only when the domain is recognized as one that
1239 &"belongs"& to the local host. This router does redirection &-- also known as
1240 aliasing and forwarding. When it generates one or more new addresses from the
1241 original, each of them is routed independently from the start. Otherwise, the
1242 router may cause an address to fail, or it may simply decline to handle the
1243 address, in which case the address is passed to the next router.
1244
1245 The final router in many configurations is one that checks to see if the
1246 address belongs to a local mailbox. The precondition may involve a check to
1247 see if the local part is the name of a login account, or it may look up the
1248 local part in a file or a database. If its preconditions are not met, or if
1249 the router declines, we have reached the end of the routers. When this happens,
1250 the address is bounced.
1251
1252
1253
1254 .section "Processing an address for verification" "SECID16"
1255 .cindex "router" "for verification"
1256 .cindex "verifying address" "overview"
1257 As well as being used to decide how to deliver to an address, Exim's routers
1258 are also used for &'address verification'&. Verification can be requested as
1259 one of the checks to be performed in an ACL for incoming messages, on both
1260 sender and recipient addresses, and it can be tested using the &%-bv%& and
1261 &%-bvs%& command line options.
1262
1263 When an address is being verified, the routers are run in &"verify mode"&. This
1264 does not affect the way the routers work, but it is a state that can be
1265 detected. By this means, a router can be skipped or made to behave differently
1266 when verifying. A common example is a configuration in which the first router
1267 sends all messages to a message-scanning program, unless they have been
1268 previously scanned. Thus, the first router accepts all addresses without any
1269 checking, making it useless for verifying. Normally, the &%no_verify%& option
1270 would be set for such a router, causing it to be skipped in verify mode.
1271
1272
1273
1274
1275 .section "Running an individual router" "SECTrunindrou"
1276 .cindex "router" "running details"
1277 .cindex "preconditions" "checking"
1278 .cindex "router" "result of running"
1279 As explained in the example above, a number of preconditions are checked before
1280 running a router. If any are not met, the router is skipped, and the address is
1281 passed to the next router. When all the preconditions on a router &'are'& met,
1282 the router is run. What happens next depends on the outcome, which is one of
1283 the following:
1284
1285 .ilist
1286 &'accept'&: The router accepts the address, and either assigns it to a
1287 transport, or generates one or more &"child"& addresses. Processing the
1288 original address ceases,
1289 .oindex "&%unseen%&"
1290 unless the &%unseen%& option is set on the router. This option
1291 can be used to set up multiple deliveries with different routing (for example,
1292 for keeping archive copies of messages). When &%unseen%& is set, the address is
1293 passed to the next router. Normally, however, an &'accept'& return marks the
1294 end of routing.
1295
1296 Any child addresses generated by the router are processed independently,
1297 starting with the first router by default. It is possible to change this by
1298 setting the &%redirect_router%& option to specify which router to start at for
1299 child addresses. Unlike &%pass_router%& (see below) the router specified by
1300 &%redirect_router%& may be anywhere in the router configuration.
1301 .next
1302 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1303 requests that the address be passed to another router. By default the address
1304 is passed to the next router, but this can be changed by setting the
1305 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1306 must be below the current router (to avoid loops).
1307 .next
1308 &'decline'&: The router declines to accept the address because it does not
1309 recognize it at all. By default, the address is passed to the next router, but
1310 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1311 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1312 &'decline'& into &'fail'&.
1313 .next
1314 &'fail'&: The router determines that the address should fail, and queues it for
1315 the generation of a bounce message. There is no further processing of the
1316 original address unless &%unseen%& is set on the router.
1317 .next
1318 &'defer'&: The router cannot handle the address at the present time. (A
1319 database may be offline, or a DNS lookup may have timed out.) No further
1320 processing of the address happens in this delivery attempt. It is tried again
1321 next time the message is considered for delivery.
1322 .next
1323 &'error'&: There is some error in the router (for example, a syntax error in
1324 its configuration). The action is as for defer.
1325 .endlist
1326
1327 If an address reaches the end of the routers without having been accepted by
1328 any of them, it is bounced as unrouteable. The default error message in this
1329 situation is &"unrouteable address"&, but you can set your own message by
1330 making use of the &%cannot_route_message%& option. This can be set for any
1331 router; the value from the last router that &"saw"& the address is used.
1332
1333 Sometimes while routing you want to fail a delivery when some conditions are
1334 met but others are not, instead of passing the address on for further routing.
1335 You can do this by having a second router that explicitly fails the delivery
1336 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1337 facility for this purpose.
1338
1339
1340 .section "Duplicate addresses" "SECID17"
1341 .cindex "case of local parts"
1342 .cindex "address duplicate, discarding"
1343 .cindex "duplicate addresses"
1344 Once routing is complete, Exim scans the addresses that are assigned to local
1345 and remote transports, and discards any duplicates that it finds. During this
1346 check, local parts are treated as case-sensitive. This happens only when
1347 actually delivering a message; when testing routers with &%-bt%&, all the
1348 routed addresses are shown.
1349
1350
1351
1352 .section "Router preconditions" "SECTrouprecon"
1353 .cindex "router" "preconditions, order of processing"
1354 .cindex "preconditions" "order of processing"
1355 The preconditions that are tested for each router are listed below, in the
1356 order in which they are tested. The individual configuration options are
1357 described in more detail in chapter &<<CHAProutergeneric>>&.
1358
1359 .ilist
1360 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1361 the local parts handled by the router may or must have certain prefixes and/or
1362 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1363 skipped. These conditions are tested first. When an affix is present, it is
1364 removed from the local part before further processing, including the evaluation
1365 of any other conditions.
1366 .next
1367 Routers can be designated for use only when not verifying an address, that is,
1368 only when routing it for delivery (or testing its delivery routing). If the
1369 &%verify%& option is set false, the router is skipped when Exim is verifying an
1370 address.
1371 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1372 &%verify_recipient%&, which independently control the use of the router for
1373 sender and recipient verification. You can set these options directly if
1374 you want a router to be used for only one type of verification.
1375 Note that cutthrough delivery is classed as a recipient verification
1376 for this purpose.
1377 .next
1378 If the &%address_test%& option is set false, the router is skipped when Exim is
1379 run with the &%-bt%& option to test an address routing. This can be helpful
1380 when the first router sends all new messages to a scanner of some sort; it
1381 makes it possible to use &%-bt%& to test subsequent delivery routing without
1382 having to simulate the effect of the scanner.
1383 .next
1384 Routers can be designated for use only when verifying an address, as
1385 opposed to routing it for delivery. The &%verify_only%& option controls this.
1386 Again, cutthrough delibery counts as a verification.
1387 .next
1388 Individual routers can be explicitly skipped when running the routers to
1389 check an address given in the SMTP EXPN command (see the &%expn%& option).
1390 .next
1391 If the &%domains%& option is set, the domain of the address must be in the set
1392 of domains that it defines.
1393 .next
1394 .vindex "&$local_part_prefix$&"
1395 .vindex "&$local_part$&"
1396 .vindex "&$local_part_suffix$&"
1397 If the &%local_parts%& option is set, the local part of the address must be in
1398 the set of local parts that it defines. If &%local_part_prefix%& or
1399 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1400 part before this check. If you want to do precondition tests on local parts
1401 that include affixes, you can do so by using a &%condition%& option (see below)
1402 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1403 &$local_part_suffix$& as necessary.
1404 .next
1405 .vindex "&$local_user_uid$&"
1406 .vindex "&$local_user_gid$&"
1407 .vindex "&$home$&"
1408 If the &%check_local_user%& option is set, the local part must be the name of
1409 an account on the local host. If this check succeeds, the uid and gid of the
1410 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1411 user's home directory is placed in &$home$&; these values can be used in the
1412 remaining preconditions.
1413 .next
1414 If the &%router_home_directory%& option is set, it is expanded at this point,
1415 because it overrides the value of &$home$&. If this expansion were left till
1416 later, the value of &$home$& as set by &%check_local_user%& would be used in
1417 subsequent tests. Having two different values of &$home$& in the same router
1418 could lead to confusion.
1419 .next
1420 If the &%senders%& option is set, the envelope sender address must be in the
1421 set of addresses that it defines.
1422 .next
1423 If the &%require_files%& option is set, the existence or non-existence of
1424 specified files is tested.
1425 .next
1426 .cindex "customizing" "precondition"
1427 If the &%condition%& option is set, it is evaluated and tested. This option
1428 uses an expanded string to allow you to set up your own custom preconditions.
1429 Expanded strings are described in chapter &<<CHAPexpand>>&.
1430 .endlist
1431
1432
1433 Note that &%require_files%& comes near the end of the list, so you cannot use
1434 it to check for the existence of a file in which to lookup up a domain, local
1435 part, or sender. However, as these options are all expanded, you can use the
1436 &%exists%& expansion condition to make such tests within each condition. The
1437 &%require_files%& option is intended for checking files that the router may be
1438 going to use internally, or which are needed by a specific transport (for
1439 example, &_.procmailrc_&).
1440
1441
1442
1443 .section "Delivery in detail" "SECID18"
1444 .cindex "delivery" "in detail"
1445 When a message is to be delivered, the sequence of events is as follows:
1446
1447 .ilist
1448 If a system-wide filter file is specified, the message is passed to it. The
1449 filter may add recipients to the message, replace the recipients, discard the
1450 message, cause a new message to be generated, or cause the message delivery to
1451 fail. The format of the system filter file is the same as for Exim user filter
1452 files, described in the separate document entitled &'Exim's interfaces to mail
1453 filtering'&.
1454 .cindex "Sieve filter" "not available for system filter"
1455 (&*Note*&: Sieve cannot be used for system filter files.)
1456
1457 Some additional features are available in system filters &-- see chapter
1458 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1459 filter only once per delivery attempt, however many recipients it has. However,
1460 if there are several delivery attempts because one or more addresses could not
1461 be immediately delivered, the system filter is run each time. The filter
1462 condition &%first_delivery%& can be used to detect the first run of the system
1463 filter.
1464 .next
1465 Each recipient address is offered to each configured router in turn, subject to
1466 its preconditions, until one is able to handle it. If no router can handle the
1467 address, that is, if they all decline, the address is failed. Because routers
1468 can be targeted at particular domains, several locally handled domains can be
1469 processed entirely independently of each other.
1470 .next
1471 .cindex "routing" "loops in"
1472 .cindex "loop" "while routing"
1473 A router that accepts an address may assign it to a local or a remote
1474 transport. However, the transport is not run at this time. Instead, the address
1475 is placed on a list for the particular transport, which will be run later.
1476 Alternatively, the router may generate one or more new addresses (typically
1477 from alias, forward, or filter files). New addresses are fed back into this
1478 process from the top, but in order to avoid loops, a router ignores any address
1479 which has an identically-named ancestor that was processed by itself.
1480 .next
1481 When all the routing has been done, addresses that have been successfully
1482 handled are passed to their assigned transports. When local transports are
1483 doing real local deliveries, they handle only one address at a time, but if a
1484 local transport is being used as a pseudo-remote transport (for example, to
1485 collect batched SMTP messages for transmission by some other means) multiple
1486 addresses can be handled. Remote transports can always handle more than one
1487 address at a time, but can be configured not to do so, or to restrict multiple
1488 addresses to the same domain.
1489 .next
1490 Each local delivery to a file or a pipe runs in a separate process under a
1491 non-privileged uid, and these deliveries are run one at a time. Remote
1492 deliveries also run in separate processes, normally under a uid that is private
1493 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1494 run in parallel. The maximum number of simultaneous remote deliveries for any
1495 one message is set by the &%remote_max_parallel%& option.
1496 The order in which deliveries are done is not defined, except that all local
1497 deliveries happen before any remote deliveries.
1498 .next
1499 .cindex "queue runner"
1500 When it encounters a local delivery during a queue run, Exim checks its retry
1501 database to see if there has been a previous temporary delivery failure for the
1502 address before running the local transport. If there was a previous failure,
1503 Exim does not attempt a new delivery until the retry time for the address is
1504 reached. However, this happens only for delivery attempts that are part of a
1505 queue run. Local deliveries are always attempted when delivery immediately
1506 follows message reception, even if retry times are set for them. This makes for
1507 better behaviour if one particular message is causing problems (for example,
1508 causing quota overflow, or provoking an error in a filter file).
1509 .next
1510 .cindex "delivery" "retry in remote transports"
1511 Remote transports do their own retry handling, since an address may be
1512 deliverable to one of a number of hosts, each of which may have a different
1513 retry time. If there have been previous temporary failures and no host has
1514 reached its retry time, no delivery is attempted, whether in a queue run or
1515 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1516 .next
1517 If there were any permanent errors, a bounce message is returned to an
1518 appropriate address (the sender in the common case), with details of the error
1519 for each failing address. Exim can be configured to send copies of bounce
1520 messages to other addresses.
1521 .next
1522 .cindex "delivery" "deferral"
1523 If one or more addresses suffered a temporary failure, the message is left on
1524 the queue, to be tried again later. Delivery of these addresses is said to be
1525 &'deferred'&.
1526 .next
1527 When all the recipient addresses have either been delivered or bounced,
1528 handling of the message is complete. The spool files and message log are
1529 deleted, though the message log can optionally be preserved if required.
1530 .endlist
1531
1532
1533
1534
1535 .section "Retry mechanism" "SECID19"
1536 .cindex "delivery" "retry mechanism"
1537 .cindex "retry" "description of mechanism"
1538 .cindex "queue runner"
1539 Exim's mechanism for retrying messages that fail to get delivered at the first
1540 attempt is the queue runner process. You must either run an Exim daemon that
1541 uses the &%-q%& option with a time interval to start queue runners at regular
1542 intervals, or use some other means (such as &'cron'&) to start them. If you do
1543 not arrange for queue runners to be run, messages that fail temporarily at the
1544 first attempt will remain on your queue for ever. A queue runner process works
1545 its way through the queue, one message at a time, trying each delivery that has
1546 passed its retry time.
1547 You can run several queue runners at once.
1548
1549 Exim uses a set of configured rules to determine when next to retry the failing
1550 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1551 should give up trying to deliver to the address, at which point it generates a
1552 bounce message. If no retry rules are set for a particular host, address, and
1553 error combination, no retries are attempted, and temporary errors are treated
1554 as permanent.
1555
1556
1557
1558 .section "Temporary delivery failure" "SECID20"
1559 .cindex "delivery" "temporary failure"
1560 There are many reasons why a message may not be immediately deliverable to a
1561 particular address. Failure to connect to a remote machine (because it, or the
1562 connection to it, is down) is one of the most common. Temporary failures may be
1563 detected during routing as well as during the transport stage of delivery.
1564 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1565 is on a file system where the user is over quota. Exim can be configured to
1566 impose its own quotas on local mailboxes; where system quotas are set they will
1567 also apply.
1568
1569 If a host is unreachable for a period of time, a number of messages may be
1570 waiting for it by the time it recovers, and sending them in a single SMTP
1571 connection is clearly beneficial. Whenever a delivery to a remote host is
1572 deferred,
1573 .cindex "hints database"
1574 Exim makes a note in its hints database, and whenever a successful
1575 SMTP delivery has happened, it looks to see if any other messages are waiting
1576 for the same host. If any are found, they are sent over the same SMTP
1577 connection, subject to a configuration limit as to the maximum number in any
1578 one connection.
1579
1580
1581
1582 .section "Permanent delivery failure" "SECID21"
1583 .cindex "delivery" "permanent failure"
1584 .cindex "bounce message" "when generated"
1585 When a message cannot be delivered to some or all of its intended recipients, a
1586 bounce message is generated. Temporary delivery failures turn into permanent
1587 errors when their timeout expires. All the addresses that fail in a given
1588 delivery attempt are listed in a single message. If the original message has
1589 many recipients, it is possible for some addresses to fail in one delivery
1590 attempt and others to fail subsequently, giving rise to more than one bounce
1591 message. The wording of bounce messages can be customized by the administrator.
1592 See chapter &<<CHAPemsgcust>>& for details.
1593
1594 .cindex "&'X-Failed-Recipients:'& header line"
1595 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1596 failed addresses, for the benefit of programs that try to analyse such messages
1597 automatically.
1598
1599 .cindex "bounce message" "recipient of"
1600 A bounce message is normally sent to the sender of the original message, as
1601 obtained from the message's envelope. For incoming SMTP messages, this is the
1602 address given in the MAIL command. However, when an address is expanded via a
1603 forward or alias file, an alternative address can be specified for delivery
1604 failures of the generated addresses. For a mailing list expansion (see section
1605 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1606 of the list.
1607
1608
1609
1610 .section "Failures to deliver bounce messages" "SECID22"
1611 .cindex "bounce message" "failure to deliver"
1612 If a bounce message (either locally generated or received from a remote host)
1613 itself suffers a permanent delivery failure, the message is left on the queue,
1614 but it is frozen, awaiting the attention of an administrator. There are options
1615 that can be used to make Exim discard such failed messages, or to keep them
1616 for only a short time (see &%timeout_frozen_after%& and
1617 &%ignore_bounce_errors_after%&).
1618
1619
1620
1621
1622
1623 . ////////////////////////////////////////////////////////////////////////////
1624 . ////////////////////////////////////////////////////////////////////////////
1625
1626 .chapter "Building and installing Exim" "CHID3"
1627 .scindex IIDbuex "building Exim"
1628
1629 .section "Unpacking" "SECID23"
1630 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1631 creates a directory with the name of the current release (for example,
1632 &_exim-&version()_&) into which the following files are placed:
1633
1634 .table2 140pt
1635 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1636 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1637   documented"
1638 .irow &_LICENCE_&         "the GNU General Public Licence"
1639 .irow &_Makefile_&        "top-level make file"
1640 .irow &_NOTICE_&          "conditions for the use of Exim"
1641 .irow &_README_&          "list of files, directories and simple build &&&
1642   instructions"
1643 .endtable
1644
1645 Other files whose names begin with &_README_& may also be present. The
1646 following subdirectories are created:
1647
1648 .table2 140pt
1649 .irow &_Local_&           "an empty directory for local configuration files"
1650 .irow &_OS_&              "OS-specific files"
1651 .irow &_doc_&             "documentation files"
1652 .irow &_exim_monitor_&    "source files for the Exim monitor"
1653 .irow &_scripts_&         "scripts used in the build process"
1654 .irow &_src_&             "remaining source files"
1655 .irow &_util_&            "independent utilities"
1656 .endtable
1657
1658 The main utility programs are contained in the &_src_& directory, and are built
1659 with the Exim binary. The &_util_& directory contains a few optional scripts
1660 that may be useful to some sites.
1661
1662
1663 .section "Multiple machine architectures and operating systems" "SECID24"
1664 .cindex "building Exim" "multiple OS/architectures"
1665 The building process for Exim is arranged to make it easy to build binaries for
1666 a number of different architectures and operating systems from the same set of
1667 source files. Compilation does not take place in the &_src_& directory.
1668 Instead, a &'build directory'& is created for each architecture and operating
1669 system.
1670 .cindex "symbolic link" "to build directory"
1671 Symbolic links to the sources are installed in this directory, which is where
1672 the actual building takes place. In most cases, Exim can discover the machine
1673 architecture and operating system for itself, but the defaults can be
1674 overridden if necessary.
1675
1676
1677 .section "PCRE library" "SECTpcre"
1678 .cindex "PCRE library"
1679 Exim no longer has an embedded PCRE library as the vast majority of
1680 modern systems include PCRE as a system library, although you may need
1681 to install the PCRE or PCRE development package for your operating
1682 system. If your system has a normal PCRE installation the Exim build
1683 process will need no further configuration. If the library or the
1684 headers are in an unusual location you will need to either set the PCRE_LIBS
1685 and INCLUDE directives appropriately,
1686 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1687 If your operating system has no
1688 PCRE support then you will need to obtain and build the current PCRE
1689 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1690 More information on PCRE is available at &url(http://www.pcre.org/).
1691
1692 .section "DBM libraries" "SECTdb"
1693 .cindex "DBM libraries" "discussion of"
1694 .cindex "hints database" "DBM files used for"
1695 Even if you do not use any DBM files in your configuration, Exim still needs a
1696 DBM library in order to operate, because it uses indexed files for its hints
1697 databases. Unfortunately, there are a number of DBM libraries in existence, and
1698 different operating systems often have different ones installed.
1699
1700 .cindex "Solaris" "DBM library for"
1701 .cindex "IRIX, DBM library for"
1702 .cindex "BSD, DBM library for"
1703 .cindex "Linux, DBM library for"
1704 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1705 Linux distribution, the DBM configuration should happen automatically, and you
1706 may be able to ignore this section. Otherwise, you may have to learn more than
1707 you would like about DBM libraries from what follows.
1708
1709 .cindex "&'ndbm'& DBM library"
1710 Licensed versions of Unix normally contain a library of DBM functions operating
1711 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1712 versions of Unix seem to vary in what they contain as standard. In particular,
1713 some early versions of Linux have no default DBM library, and different
1714 distributors have chosen to bundle different libraries with their packaged
1715 versions. However, the more recent releases seem to have standardized on the
1716 Berkeley DB library.
1717
1718 Different DBM libraries have different conventions for naming the files they
1719 use. When a program opens a file called &_dbmfile_&, there are several
1720 possibilities:
1721
1722 .olist
1723 A traditional &'ndbm'& implementation, such as that supplied as part of
1724 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1725 .next
1726 .cindex "&'gdbm'& DBM library"
1727 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1728 compatibility interface it makes two different hard links to it with names
1729 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1730 file name is used unmodified.
1731 .next
1732 .cindex "Berkeley DB library"
1733 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1734 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1735 programmer exactly the same as the traditional &'ndbm'& implementation.
1736 .next
1737 If the Berkeley package is used in its native mode, it operates on a single
1738 file called &_dbmfile_&; the programmer's interface is somewhat different to
1739 the traditional &'ndbm'& interface.
1740 .next
1741 To complicate things further, there are several very different versions of the
1742 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1743 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1744 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1745 versions of Berkeley DB can be obtained from
1746 &url(http://www.sleepycat.com/).
1747 .next
1748 .cindex "&'tdb'& DBM library"
1749 Yet another DBM library, called &'tdb'&, is available from
1750 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1751 operates on a single file.
1752 .endlist
1753
1754 .cindex "USE_DB"
1755 .cindex "DBM libraries" "configuration for building"
1756 Exim and its utilities can be compiled to use any of these interfaces. In order
1757 to use any version of the Berkeley DB package in native mode, you must set
1758 USE_DB in an appropriate configuration file (typically
1759 &_Local/Makefile_&). For example:
1760 .code
1761 USE_DB=yes
1762 .endd
1763 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1764 error is diagnosed if you set more than one of these.
1765
1766 At the lowest level, the build-time configuration sets none of these options,
1767 thereby assuming an interface of type (1). However, some operating system
1768 configuration files (for example, those for the BSD operating systems and
1769 Linux) assume type (4) by setting USE_DB as their default, and the
1770 configuration files for Cygwin set USE_GDBM. Anything you set in
1771 &_Local/Makefile_&, however, overrides these system defaults.
1772
1773 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1774 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1775 in one of these lines:
1776 .code
1777 DBMLIB = -ldb
1778 DBMLIB = -ltdb
1779 .endd
1780 Settings like that will work if the DBM library is installed in the standard
1781 place. Sometimes it is not, and the library's header file may also not be in
1782 the default path. You may need to set INCLUDE to specify where the header
1783 file is, and to specify the path to the library more fully in DBMLIB, as in
1784 this example:
1785 .code
1786 INCLUDE=-I/usr/local/include/db-4.1
1787 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1788 .endd
1789 There is further detailed discussion about the various DBM libraries in the
1790 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1791
1792
1793
1794 .section "Pre-building configuration" "SECID25"
1795 .cindex "building Exim" "pre-building configuration"
1796 .cindex "configuration for building Exim"
1797 .cindex "&_Local/Makefile_&"
1798 .cindex "&_src/EDITME_&"
1799 Before building Exim, a local configuration file that specifies options
1800 independent of any operating system has to be created with the name
1801 &_Local/Makefile_&. A template for this file is supplied as the file
1802 &_src/EDITME_&, and it contains full descriptions of all the option settings
1803 therein. These descriptions are therefore not repeated here. If you are
1804 building Exim for the first time, the simplest thing to do is to copy
1805 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1806
1807 There are three settings that you must supply, because Exim will not build
1808 without them. They are the location of the run time configuration file
1809 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1810 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1811 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1812 a colon-separated list of file names; Exim uses the first of them that exists.
1813
1814 There are a few other parameters that can be specified either at build time or
1815 at run time, to enable the same binary to be used on a number of different
1816 machines. However, if the locations of Exim's spool directory and log file
1817 directory (if not within the spool directory) are fixed, it is recommended that
1818 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1819 detected early in Exim's execution (such as a malformed configuration file) can
1820 be logged.
1821
1822 .cindex "content scanning" "specifying at build time"
1823 Exim's interfaces for calling virus and spam scanning software directly from
1824 access control lists are not compiled by default. If you want to include these
1825 facilities, you need to set
1826 .code
1827 WITH_CONTENT_SCAN=yes
1828 .endd
1829 in your &_Local/Makefile_&. For details of the facilities themselves, see
1830 chapter &<<CHAPexiscan>>&.
1831
1832
1833 .cindex "&_Local/eximon.conf_&"
1834 .cindex "&_exim_monitor/EDITME_&"
1835 If you are going to build the Exim monitor, a similar configuration process is
1836 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1837 your installation and saved under the name &_Local/eximon.conf_&. If you are
1838 happy with the default settings described in &_exim_monitor/EDITME_&,
1839 &_Local/eximon.conf_& can be empty, but it must exist.
1840
1841 This is all the configuration that is needed in straightforward cases for known
1842 operating systems. However, the building process is set up so that it is easy
1843 to override options that are set by default or by operating-system-specific
1844 configuration files, for example to change the name of the C compiler, which
1845 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1846 do this.
1847
1848
1849
1850 .section "Support for iconv()" "SECID26"
1851 .cindex "&[iconv()]& support"
1852 .cindex "RFC 2047"
1853 The contents of header lines in messages may be encoded according to the rules
1854 described RFC 2047. This makes it possible to transmit characters that are not
1855 in the ASCII character set, and to label them as being in a particular
1856 character set. When Exim is inspecting header lines by means of the &%$h_%&
1857 mechanism, it decodes them, and translates them into a specified character set
1858 (default ISO-8859-1). The translation is possible only if the operating system
1859 supports the &[iconv()]& function.
1860
1861 However, some of the operating systems that supply &[iconv()]& do not support
1862 very many conversions. The GNU &%libiconv%& library (available from
1863 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1864 systems to remedy this deficiency, as well as on systems that do not supply
1865 &[iconv()]& at all. After installing &%libiconv%&, you should add
1866 .code
1867 HAVE_ICONV=yes
1868 .endd
1869 to your &_Local/Makefile_& and rebuild Exim.
1870
1871
1872
1873 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1874 .cindex "TLS" "including support for TLS"
1875 .cindex "encryption" "including support for"
1876 .cindex "SUPPORT_TLS"
1877 .cindex "OpenSSL" "building Exim with"
1878 .cindex "GnuTLS" "building Exim with"
1879 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1880 command as per RFC 2487. It can also support legacy clients that expect to
1881 start a TLS session immediately on connection to a non-standard port (see the
1882 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1883 line option).
1884
1885 If you want to build Exim with TLS support, you must first install either the
1886 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1887 implementing SSL.
1888
1889 If OpenSSL is installed, you should set
1890 .code
1891 SUPPORT_TLS=yes
1892 TLS_LIBS=-lssl -lcrypto
1893 .endd
1894 in &_Local/Makefile_&. You may also need to specify the locations of the
1895 OpenSSL library and include files. For example:
1896 .code
1897 SUPPORT_TLS=yes
1898 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1899 TLS_INCLUDE=-I/usr/local/openssl/include/
1900 .endd
1901 .cindex "pkg-config" "OpenSSL"
1902 If you have &'pkg-config'& available, then instead you can just use:
1903 .code
1904 SUPPORT_TLS=yes
1905 USE_OPENSSL_PC=openssl
1906 .endd
1907 .cindex "USE_GNUTLS"
1908 If GnuTLS is installed, you should set
1909 .code
1910 SUPPORT_TLS=yes
1911 USE_GNUTLS=yes
1912 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1913 .endd
1914 in &_Local/Makefile_&, and again you may need to specify the locations of the
1915 library and include files. For example:
1916 .code
1917 SUPPORT_TLS=yes
1918 USE_GNUTLS=yes
1919 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1920 TLS_INCLUDE=-I/usr/gnu/include
1921 .endd
1922 .cindex "pkg-config" "GnuTLS"
1923 If you have &'pkg-config'& available, then instead you can just use:
1924 .code
1925 SUPPORT_TLS=yes
1926 USE_GNUTLS=yes
1927 USE_GNUTLS_PC=gnutls
1928 .endd
1929
1930 You do not need to set TLS_INCLUDE if the relevant directory is already
1931 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1932 given in chapter &<<CHAPTLS>>&.
1933
1934
1935
1936
1937 .section "Use of tcpwrappers" "SECID27"
1938
1939 .cindex "tcpwrappers, building Exim to support"
1940 .cindex "USE_TCP_WRAPPERS"
1941 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1942 .cindex "tcp_wrappers_daemon_name"
1943 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1944 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1945 alternative to Exim's own checking facilities for installations that are
1946 already making use of &'tcpwrappers'& for other purposes. To do this, you
1947 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1948 &_tcpd.h_& to be available at compile time, and also ensure that the library
1949 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1950 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1951 you might have
1952 .code
1953 USE_TCP_WRAPPERS=yes
1954 CFLAGS=-O -I/usr/local/include
1955 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1956 .endd
1957 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1958 files is &"exim"&. For example, the line
1959 .code
1960 exim : LOCAL  192.168.1.  .friendly.domain.example
1961 .endd
1962 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1963 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1964 All other connections are denied. The daemon name used by &'tcpwrappers'&
1965 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1966 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1967 configure file. Consult the &'tcpwrappers'& documentation for
1968 further details.
1969
1970
1971 .section "Including support for IPv6" "SECID28"
1972 .cindex "IPv6" "including support for"
1973 Exim contains code for use on systems that have IPv6 support. Setting
1974 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1975 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1976 where the IPv6 support is not fully integrated into the normal include and
1977 library files.
1978
1979 Two different types of DNS record for handling IPv6 addresses have been
1980 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1981 currently seen as the mainstream. Another record type called A6 was proposed
1982 as better than AAAA because it had more flexibility. However, it was felt to be
1983 over-complex, and its status was reduced to &"experimental"&. It is not known
1984 if anyone is actually using A6 records. Exim has support for A6 records, but
1985 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1986 support has not been tested for some time.
1987
1988
1989
1990 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1991 .cindex "lookup modules"
1992 .cindex "dynamic modules"
1993 .cindex ".so building"
1994 On some platforms, Exim supports not compiling all lookup types directly into
1995 the main binary, instead putting some into external modules which can be loaded
1996 on demand.
1997 This permits packagers to build Exim with support for lookups with extensive
1998 library dependencies without requiring all users to install all of those
1999 dependencies.
2000 Most, but not all, lookup types can be built this way.
2001
2002 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2003 installed; Exim will only load modules from that directory, as a security
2004 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2005 for your OS; see &_OS/Makefile-Linux_& for an example.
2006 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2007 see &_src/EDITME_& for details.
2008
2009 Then, for each module to be loaded dynamically, define the relevant
2010 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2011 For example, this will build in lsearch but load sqlite and mysql support
2012 on demand:
2013 .code
2014 LOOKUP_LSEARCH=yes
2015 LOOKUP_SQLITE=2
2016 LOOKUP_MYSQL=2
2017 .endd
2018
2019
2020 .section "The building process" "SECID29"
2021 .cindex "build directory"
2022 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2023 created, run &'make'& at the top level. It determines the architecture and
2024 operating system types, and creates a build directory if one does not exist.
2025 For example, on a Sun system running Solaris 8, the directory
2026 &_build-SunOS5-5.8-sparc_& is created.
2027 .cindex "symbolic link" "to source files"
2028 Symbolic links to relevant source files are installed in the build directory.
2029
2030 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2031 building process fails if it is set.
2032
2033 If this is the first time &'make'& has been run, it calls a script that builds
2034 a make file inside the build directory, using the configuration files from the
2035 &_Local_& directory. The new make file is then passed to another instance of
2036 &'make'&. This does the real work, building a number of utility scripts, and
2037 then compiling and linking the binaries for the Exim monitor (if configured), a
2038 number of utility programs, and finally Exim itself. The command &`make
2039 makefile`& can be used to force a rebuild of the make file in the build
2040 directory, should this ever be necessary.
2041
2042 If you have problems building Exim, check for any comments there may be in the
2043 &_README_& file concerning your operating system, and also take a look at the
2044 FAQ, where some common problems are covered.
2045
2046
2047
2048 .section 'Output from &"make"&' "SECID283"
2049 The output produced by the &'make'& process for compile lines is often very
2050 unreadable, because these lines can be very long. For this reason, the normal
2051 output is suppressed by default, and instead output similar to that which
2052 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2053 each module that is being compiled or linked. However, it is still possible to
2054 get the full output, by calling &'make'& like this:
2055 .code
2056 FULLECHO='' make -e
2057 .endd
2058 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2059 command reflection in &'make'&. When you ask for the full output, it is
2060 given in addition to the short output.
2061
2062
2063
2064 .section "Overriding build-time options for Exim" "SECToverride"
2065 .cindex "build-time options, overriding"
2066 The main make file that is created at the beginning of the building process
2067 consists of the concatenation of a number of files which set configuration
2068 values, followed by a fixed set of &'make'& instructions. If a value is set
2069 more than once, the last setting overrides any previous ones. This provides a
2070 convenient way of overriding defaults. The files that are concatenated are, in
2071 order:
2072 .display
2073 &_OS/Makefile-Default_&
2074 &_OS/Makefile-_&<&'ostype'&>
2075 &_Local/Makefile_&
2076 &_Local/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile-_&<&'archtype'&>
2078 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2079 &_OS/Makefile-Base_&
2080 .endd
2081 .cindex "&_Local/Makefile_&"
2082 .cindex "building Exim" "operating system type"
2083 .cindex "building Exim" "architecture type"
2084 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2085 architecture type. &_Local/Makefile_& is required to exist, and the building
2086 process fails if it is absent. The other three &_Local_& files are optional,
2087 and are often not needed.
2088
2089 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2090 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2091 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2092 values are used, thereby providing a means of forcing particular settings.
2093 Otherwise, the scripts try to get values from the &%uname%& command. If this
2094 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2095 of &'ad hoc'& transformations are then applied, to produce the standard names
2096 that Exim expects. You can run these scripts directly from the shell in order
2097 to find out what values are being used on your system.
2098
2099
2100 &_OS/Makefile-Default_& contains comments about the variables that are set
2101 therein. Some (but not all) are mentioned below. If there is something that
2102 needs changing, review the contents of this file and the contents of the make
2103 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2104 default values are.
2105
2106
2107 .cindex "building Exim" "overriding default settings"
2108 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2109 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2110 need to change the original files. Instead, you should make the changes by
2111 putting the new values in an appropriate &_Local_& file. For example,
2112 .cindex "Tru64-Unix build-time settings"
2113 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2114 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2115 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2116 called with the option &%-std1%&, to make it recognize some of the features of
2117 Standard C that Exim uses. (Most other compilers recognize Standard C by
2118 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2119 containing the lines
2120 .code
2121 CC=cc
2122 CFLAGS=-std1
2123 .endd
2124 If you are compiling for just one operating system, it may be easier to put
2125 these lines directly into &_Local/Makefile_&.
2126
2127 Keeping all your local configuration settings separate from the distributed
2128 files makes it easy to transfer them to new versions of Exim simply by copying
2129 the contents of the &_Local_& directory.
2130
2131
2132 .cindex "NIS lookup type" "including support for"
2133 .cindex "NIS+ lookup type" "including support for"
2134 .cindex "LDAP" "including support for"
2135 .cindex "lookup" "inclusion in binary"
2136 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2137 lookup, but not all systems have these components installed, so the default is
2138 not to include the relevant code in the binary. All the different kinds of file
2139 and database lookup that Exim supports are implemented as separate code modules
2140 which are included only if the relevant compile-time options are set. In the
2141 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2142 .code
2143 LOOKUP_LDAP=yes
2144 LOOKUP_NIS=yes
2145 LOOKUP_NISPLUS=yes
2146 .endd
2147 and similar settings apply to the other lookup types. They are all listed in
2148 &_src/EDITME_&. In many cases the relevant include files and interface
2149 libraries need to be installed before compiling Exim.
2150 .cindex "cdb" "including support for"
2151 However, there are some optional lookup types (such as cdb) for which
2152 the code is entirely contained within Exim, and no external include
2153 files or libraries are required. When a lookup type is not included in the
2154 binary, attempts to configure Exim to use it cause run time configuration
2155 errors.
2156
2157 .cindex "pkg-config" "lookups"
2158 .cindex "pkg-config" "authenticators"
2159 Many systems now use a tool called &'pkg-config'& to encapsulate information
2160 about how to compile against a library; Exim has some initial support for
2161 being able to use pkg-config for lookups and authenticators.  For any given
2162 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2163 variable with the &`_PC`& suffix in the name and assign as the value the
2164 name of the package to be queried.  The results of querying via the
2165 &'pkg-config'& command will be added to the appropriate Makefile variables
2166 with &`+=`& directives, so your version of &'make'& will need to support that
2167 syntax.  For instance:
2168 .code
2169 LOOKUP_SQLITE=yes
2170 LOOKUP_SQLITE_PC=sqlite3
2171 AUTH_GSASL=yes
2172 AUTH_GSASL_PC=libgsasl
2173 AUTH_HEIMDAL_GSSAPI=yes
2174 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2175 .endd
2176
2177 .cindex "Perl" "including support for"
2178 Exim can be linked with an embedded Perl interpreter, allowing Perl
2179 subroutines to be called during string expansion. To enable this facility,
2180 .code
2181 EXIM_PERL=perl.o
2182 .endd
2183 must be defined in &_Local/Makefile_&. Details of this facility are given in
2184 chapter &<<CHAPperl>>&.
2185
2186 .cindex "X11 libraries, location of"
2187 The location of the X11 libraries is something that varies a lot between
2188 operating systems, and there may be different versions of X11 to cope
2189 with. Exim itself makes no use of X11, but if you are compiling the Exim
2190 monitor, the X11 libraries must be available.
2191 The following three variables are set in &_OS/Makefile-Default_&:
2192 .code
2193 X11=/usr/X11R6
2194 XINCLUDE=-I$(X11)/include
2195 XLFLAGS=-L$(X11)/lib
2196 .endd
2197 These are overridden in some of the operating-system configuration files. For
2198 example, in &_OS/Makefile-SunOS5_& there is
2199 .code
2200 X11=/usr/openwin
2201 XINCLUDE=-I$(X11)/include
2202 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2203 .endd
2204 If you need to override the default setting for your operating system, place a
2205 definition of all three of these variables into your
2206 &_Local/Makefile-<ostype>_& file.
2207
2208 .cindex "EXTRALIBS"
2209 If you need to add any extra libraries to the link steps, these can be put in a
2210 variable called EXTRALIBS, which appears in all the link commands, but by
2211 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2212 command for linking the main Exim binary, and not for any associated utilities.
2213
2214 .cindex "DBM libraries" "configuration for building"
2215 There is also DBMLIB, which appears in the link commands for binaries that
2216 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2217 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2218 binary, and which can be used, for example, to include additional X11
2219 libraries.
2220
2221 .cindex "configuration file" "editing"
2222 The make file copes with rebuilding Exim correctly if any of the configuration
2223 files are edited. However, if an optional configuration file is deleted, it is
2224 necessary to touch the associated non-optional file (that is,
2225 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2226
2227
2228 .section "OS-specific header files" "SECID30"
2229 .cindex "&_os.h_&"
2230 .cindex "building Exim" "OS-specific C header files"
2231 The &_OS_& directory contains a number of files with names of the form
2232 &_os.h-<ostype>_&. These are system-specific C header files that should not
2233 normally need to be changed. There is a list of macro settings that are
2234 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2235 are porting Exim to a new operating system.
2236
2237
2238
2239 .section "Overriding build-time options for the monitor" "SECID31"
2240 .cindex "building Eximon"
2241 A similar process is used for overriding things when building the Exim monitor,
2242 where the files that are involved are
2243 .display
2244 &_OS/eximon.conf-Default_&
2245 &_OS/eximon.conf-_&<&'ostype'&>
2246 &_Local/eximon.conf_&
2247 &_Local/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf-_&<&'archtype'&>
2249 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2250 .endd
2251 .cindex "&_Local/eximon.conf_&"
2252 As with Exim itself, the final three files need not exist, and in this case the
2253 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2254 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2255 variables of the same name, preceded by EXIMON_. For example, setting
2256 EXIMON_LOG_DEPTH in the environment overrides the value of
2257 LOG_DEPTH at run time.
2258 .ecindex IIDbuex
2259
2260
2261 .section "Installing Exim binaries and scripts" "SECID32"
2262 .cindex "installing Exim"
2263 .cindex "BIN_DIRECTORY"
2264 The command &`make install`& runs the &(exim_install)& script with no
2265 arguments. The script copies binaries and utility scripts into the directory
2266 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2267 .cindex "setuid" "installing Exim with"
2268 The install script copies files only if they are newer than the files they are
2269 going to replace. The Exim binary is required to be owned by root and have the
2270 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2271 install`& as root so that it can set up the Exim binary in this way. However, in
2272 some special situations (for example, if a host is doing no local deliveries)
2273 it may be possible to run Exim without making the binary setuid root (see
2274 chapter &<<CHAPsecurity>>& for details).
2275
2276 .cindex "CONFIGURE_FILE"
2277 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2278 in &_Local/Makefile_&. If this names a single file, and the file does not
2279 exist, the default configuration file &_src/configure.default_& is copied there
2280 by the installation script. If a run time configuration file already exists, it
2281 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2282 alternative files, no default is installed.
2283
2284 .cindex "system aliases file"
2285 .cindex "&_/etc/aliases_&"
2286 One change is made to the default configuration file when it is installed: the
2287 default configuration contains a router that references a system aliases file.
2288 The path to this file is set to the value specified by
2289 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2290 If the system aliases file does not exist, the installation script creates it,
2291 and outputs a comment to the user.
2292
2293 The created file contains no aliases, but it does contain comments about the
2294 aliases a site should normally have. Mail aliases have traditionally been
2295 kept in &_/etc/aliases_&. However, some operating systems are now using
2296 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2297 Exim's configuration if necessary.
2298
2299 The default configuration uses the local host's name as the only local domain,
2300 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2301 running as the local user. System aliases and &_.forward_& files in users' home
2302 directories are supported, but no NIS or NIS+ support is configured. Domains
2303 other than the name of the local host are routed using the DNS, with delivery
2304 over SMTP.
2305
2306 It is possible to install Exim for special purposes (such as building a binary
2307 distribution) in a private part of the file system. You can do this by a
2308 command such as
2309 .code
2310 make DESTDIR=/some/directory/ install
2311 .endd
2312 This has the effect of pre-pending the specified directory to all the file
2313 paths, except the name of the system aliases file that appears in the default
2314 configuration. (If a default alias file is created, its name &'is'& modified.)
2315 For backwards compatibility, ROOT is used if DESTDIR is not set,
2316 but this usage is deprecated.
2317
2318 .cindex "installing Exim" "what is not installed"
2319 Running &'make install'& does not copy the Exim 4 conversion script
2320 &'convert4r4'&. You will probably run this only once if you are
2321 upgrading from Exim 3. None of the documentation files in the &_doc_&
2322 directory are copied, except for the info files when you have set
2323 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2324
2325 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2326 to their names. The Exim binary itself, however, is handled differently. It is
2327 installed under a name that includes the version number and the compile number,
2328 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2329 called &_exim_& to point to the binary. If you are updating a previous version
2330 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2331 from the directory (as seen by other processes).
2332
2333 .cindex "installing Exim" "testing the script"
2334 If you want to see what the &'make install'& will do before running it for
2335 real, you can pass the &%-n%& option to the installation script by this
2336 command:
2337 .code
2338 make INSTALL_ARG=-n install
2339 .endd
2340 The contents of the variable INSTALL_ARG are passed to the installation
2341 script. You do not need to be root to run this test. Alternatively, you can run
2342 the installation script directly, but this must be from within the build
2343 directory. For example, from the top-level Exim directory you could use this
2344 command:
2345 .code
2346 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2347 .endd
2348 .cindex "installing Exim" "install script options"
2349 There are two other options that can be supplied to the installation script.
2350
2351 .ilist
2352 &%-no_chown%& bypasses the call to change the owner of the installed binary
2353 to root, and the call to make it a setuid binary.
2354 .next
2355 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2356 installed binary.
2357 .endlist
2358
2359 INSTALL_ARG can be used to pass these options to the script. For example:
2360 .code
2361 make INSTALL_ARG=-no_symlink install
2362 .endd
2363 The installation script can also be given arguments specifying which files are
2364 to be copied. For example, to install just the Exim binary, and nothing else,
2365 without creating the symbolic link, you could use:
2366 .code
2367 make INSTALL_ARG='-no_symlink exim' install
2368 .endd
2369
2370
2371
2372 .section "Installing info documentation" "SECTinsinfdoc"
2373 .cindex "installing Exim" "&'info'& documentation"
2374 Not all systems use the GNU &'info'& system for documentation, and for this
2375 reason, the Texinfo source of Exim's documentation is not included in the main
2376 distribution. Instead it is available separately from the ftp site (see section
2377 &<<SECTavail>>&).
2378
2379 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2380 source of the documentation is found in the source tree, running &`make
2381 install`& automatically builds the info files and installs them.
2382
2383
2384
2385 .section "Setting up the spool directory" "SECID33"
2386 .cindex "spool directory" "creating"
2387 When it starts up, Exim tries to create its spool directory if it does not
2388 exist. The Exim uid and gid are used for the owner and group of the spool
2389 directory. Sub-directories are automatically created in the spool directory as
2390 necessary.
2391
2392
2393
2394
2395 .section "Testing" "SECID34"
2396 .cindex "testing" "installation"
2397 Having installed Exim, you can check that the run time configuration file is
2398 syntactically valid by running the following command, which assumes that the
2399 Exim binary directory is within your PATH environment variable:
2400 .code
2401 exim -bV
2402 .endd
2403 If there are any errors in the configuration file, Exim outputs error messages.
2404 Otherwise it outputs the version number and build date,
2405 the DBM library that is being used, and information about which drivers and
2406 other optional code modules are included in the binary.
2407 Some simple routing tests can be done by using the address testing option. For
2408 example,
2409 .display
2410 &`exim -bt`& <&'local username'&>
2411 .endd
2412 should verify that it recognizes a local mailbox, and
2413 .display
2414 &`exim -bt`& <&'remote address'&>
2415 .endd
2416 a remote one. Then try getting it to deliver mail, both locally and remotely.
2417 This can be done by passing messages directly to Exim, without going through a
2418 user agent. For example:
2419 .code
2420 exim -v postmaster@your.domain.example
2421 From: user@your.domain.example
2422 To: postmaster@your.domain.example
2423 Subject: Testing Exim
2424
2425 This is a test message.
2426 ^D
2427 .endd
2428 The &%-v%& option causes Exim to output some verification of what it is doing.
2429 In this case you should see copies of three log lines, one for the message's
2430 arrival, one for its delivery, and one containing &"Completed"&.
2431
2432 .cindex "delivery" "problems with"
2433 If you encounter problems, look at Exim's log files (&'mainlog'& and
2434 &'paniclog'&) to see if there is any relevant information there. Another source
2435 of information is running Exim with debugging turned on, by specifying the
2436 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2437 with debugging turned on by a command of the form
2438 .display
2439 &`exim -d -M`& <&'exim-message-id'&>
2440 .endd
2441 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2442 produces rather a lot of output, but you can cut this down to specific areas.
2443 For example, if you use &%-d-all+route%& only the debugging information
2444 relevant to routing is included. (See the &%-d%& option in chapter
2445 &<<CHAPcommandline>>& for more details.)
2446
2447 .cindex '&"sticky"& bit'
2448 .cindex "lock files"
2449 One specific problem that has shown up on some sites is the inability to do
2450 local deliveries into a shared mailbox directory, because it does not have the
2451 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2452 writing to a mailbox file, and if it cannot create the lock file, the delivery
2453 is deferred. You can get round this either by setting the &"sticky bit"& on the
2454 directory, or by setting a specific group for local deliveries and allowing
2455 that group to create files in the directory (see the comments above the
2456 &(local_delivery)& transport in the default configuration file). Another
2457 approach is to configure Exim not to use lock files, but just to rely on
2458 &[fcntl()]& locking instead. However, you should do this only if all user
2459 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2460 see chapter &<<CHAPappendfile>>&.
2461
2462 One thing that cannot be tested on a system that is already running an MTA is
2463 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2464 &%-oX%& option can be used to run an Exim daemon that listens on some other
2465 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2466 &'exim_checkaccess'& utility can be used to check out policy controls on
2467 incoming SMTP mail.
2468
2469 Testing a new version on a system that is already running Exim can most easily
2470 be done by building a binary with a different CONFIGURE_FILE setting. From
2471 within the run time configuration, all other file and directory names
2472 that Exim uses can be altered, in order to keep it entirely clear of the
2473 production version.
2474
2475
2476 .section "Replacing another MTA with Exim" "SECID35"
2477 .cindex "replacing another MTA"
2478 Building and installing Exim for the first time does not of itself put it in
2479 general use. The name by which the system's MTA is called by mail user agents
2480 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2481 operating system), and it is necessary to make this name point to the &'exim'&
2482 binary in order to get the user agents to pass messages to Exim. This is
2483 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2484 or &_/usr/lib/sendmail_&
2485 .cindex "symbolic link" "to &'exim'& binary"
2486 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2487 privilege and executable status from the old MTA. It is then necessary to stop
2488 and restart the mailer daemon, if one is running.
2489
2490 .cindex "FreeBSD, MTA indirection"
2491 .cindex "&_/etc/mail/mailer.conf_&"
2492 Some operating systems have introduced alternative ways of switching MTAs. For
2493 example, if you are running FreeBSD, you need to edit the file
2494 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2495 described. A typical example of the contents of this file for running Exim is
2496 as follows:
2497 .code
2498 sendmail            /usr/exim/bin/exim
2499 send-mail           /usr/exim/bin/exim
2500 mailq               /usr/exim/bin/exim -bp
2501 newaliases          /usr/bin/true
2502 .endd
2503 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2504 your Exim installation is &"live"&. Check it by sending a message from your
2505 favourite user agent.
2506
2507 You should consider what to tell your users about the change of MTA. Exim may
2508 have different capabilities to what was previously running, and there are
2509 various operational differences such as the text of messages produced by
2510 command line options and in bounce messages. If you allow your users to make
2511 use of Exim's filtering capabilities, you should make the document entitled
2512 &'Exim's interface to mail filtering'& available to them.
2513
2514
2515
2516 .section "Upgrading Exim" "SECID36"
2517 .cindex "upgrading Exim"
2518 If you are already running Exim on your host, building and installing a new
2519 version automatically makes it available to MUAs, or any other programs that
2520 call the MTA directly. However, if you are running an Exim daemon, you do need
2521 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2522 new binary. You do not need to stop processing mail in order to install a new
2523 version of Exim. The install script does not modify an existing runtime
2524 configuration file.
2525
2526
2527
2528
2529 .section "Stopping the Exim daemon on Solaris" "SECID37"
2530 .cindex "Solaris" "stopping Exim on"
2531 The standard command for stopping the mailer daemon on Solaris is
2532 .code
2533 /etc/init.d/sendmail stop
2534 .endd
2535 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2536 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2537 for the text &"sendmail"&; this is not present because the actual program name
2538 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2539 solution is to replace the line that finds the process id with something like
2540 .code
2541 pid=`cat /var/spool/exim/exim-daemon.pid`
2542 .endd
2543 to obtain the daemon's pid directly from the file that Exim saves it in.
2544
2545 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2546 still be received from local processes, and if automatic delivery is configured
2547 (the normal case), deliveries will still occur.
2548
2549
2550
2551
2552 . ////////////////////////////////////////////////////////////////////////////
2553 . ////////////////////////////////////////////////////////////////////////////
2554
2555 .chapter "The Exim command line" "CHAPcommandline"
2556 .scindex IIDclo1 "command line" "options"
2557 .scindex IIDclo2 "options" "command line"
2558 Exim's command line takes the standard Unix form of a sequence of options,
2559 each starting with a hyphen character, followed by a number of arguments. The
2560 options are compatible with the main options of Sendmail, and there are also
2561 some additional options, some of which are compatible with Smail 3. Certain
2562 combinations of options do not make sense, and provoke an error if used.
2563 The form of the arguments depends on which options are set.
2564
2565
2566 .section "Setting options by program name" "SECID38"
2567 .cindex "&'mailq'&"
2568 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2569 were present before any other options.
2570 The &%-bp%& option requests a listing of the contents of the mail queue on the
2571 standard output.
2572 This feature is for compatibility with some systems that contain a command of
2573 that name in one of the standard libraries, symbolically linked to
2574 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2575
2576 .cindex "&'rsmtp'&"
2577 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2578 were present before any other options, for compatibility with Smail. The
2579 &%-bS%& option is used for reading in a number of messages in batched SMTP
2580 format.
2581
2582 .cindex "&'rmail'&"
2583 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2584 &%-oee%& options were present before any other options, for compatibility with
2585 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2586
2587 .cindex "&'runq'&"
2588 .cindex "queue runner"
2589 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2590 were present before any other options, for compatibility with Smail. The &%-q%&
2591 option causes a single queue runner process to be started.
2592
2593 .cindex "&'newaliases'&"
2594 .cindex "alias file" "building"
2595 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2596 If Exim is called under the name &'newaliases'& it behaves as if the option
2597 &%-bi%& were present before any other options, for compatibility with Sendmail.
2598 This option is used for rebuilding Sendmail's alias file. Exim does not have
2599 the concept of a single alias file, but can be configured to run a given
2600 command if called with the &%-bi%& option.
2601
2602
2603 .section "Trusted and admin users" "SECTtrustedadmin"
2604 Some Exim options are available only to &'trusted users'& and others are
2605 available only to &'admin users'&. In the description below, the phrases &"Exim
2606 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2607 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2608 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2609
2610 .ilist
2611 .cindex "trusted users" "definition of"
2612 .cindex "user" "trusted definition of"
2613 The trusted users are root, the Exim user, any user listed in the
2614 &%trusted_users%& configuration option, and any user whose current group or any
2615 supplementary group is one of those listed in the &%trusted_groups%&
2616 configuration option. Note that the Exim group is not automatically trusted.
2617
2618 .cindex '&"From"& line'
2619 .cindex "envelope sender"
2620 Trusted users are always permitted to use the &%-f%& option or a leading
2621 &"From&~"& line to specify the envelope sender of a message that is passed to
2622 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2623 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2624 users to set envelope senders.
2625
2626 .cindex "&'From:'& header line"
2627 .cindex "&'Sender:'& header line"
2628 For a trusted user, there is never any check on the contents of the &'From:'&
2629 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2630 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2631
2632 Trusted users may also specify a host name, host address, interface address,
2633 protocol name, ident value, and authentication data when submitting a message
2634 locally. Thus, they are able to insert messages into Exim's queue locally that
2635 have the characteristics of messages received from a remote host. Untrusted
2636 users may in some circumstances use &%-f%&, but can never set the other values
2637 that are available to trusted users.
2638 .next
2639 .cindex "user" "admin definition of"
2640 .cindex "admin user" "definition of"
2641 The admin users are root, the Exim user, and any user that is a member of the
2642 Exim group or of any group listed in the &%admin_groups%& configuration option.
2643 The current group does not have to be one of these groups.
2644
2645 Admin users are permitted to list the queue, and to carry out certain
2646 operations on messages, for example, to force delivery failures. It is also
2647 necessary to be an admin user in order to see the full information provided by
2648 the Exim monitor, and full debugging output.
2649
2650 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2651 Exim to attempt delivery of messages on its queue is restricted to admin users.
2652 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2653 option false (that is, specifying &%no_prod_requires_admin%&).
2654
2655 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2656 is restricted to admin users unless &%queue_list_requires_admin%& is set
2657 false.
2658 .endlist
2659
2660
2661 &*Warning*&: If you configure your system so that admin users are able to
2662 edit Exim's configuration file, you are giving those users an easy way of
2663 getting root. There is further discussion of this issue at the start of chapter
2664 &<<CHAPconf>>&.
2665
2666
2667
2668
2669 .section "Command line options" "SECID39"
2670 Exim's command line options are described in alphabetical order below. If none
2671 of the options that specifies a specific action (such as starting the daemon or
2672 a queue runner, or testing an address, or receiving a message in a specific
2673 format, or listing the queue) are present, and there is at least one argument
2674 on the command line, &%-bm%& (accept a local message on the standard input,
2675 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2676 outputs a brief message about itself and exits.
2677
2678 . ////////////////////////////////////////////////////////////////////////////
2679 . Insert a stylized XML comment here, to identify the start of the command line
2680 . options. This is for the benefit of the Perl script that automatically
2681 . creates a man page for the options.
2682 . ////////////////////////////////////////////////////////////////////////////
2683
2684 .literal xml
2685 <!-- === Start of command line options === -->
2686 .literal off
2687
2688
2689 .vlist
2690 .vitem &%--%&
2691 .oindex "--"
2692 .cindex "options" "command line; terminating"
2693 This is a pseudo-option whose only purpose is to terminate the options and
2694 therefore to cause subsequent command line items to be treated as arguments
2695 rather than options, even if they begin with hyphens.
2696
2697 .vitem &%--help%&
2698 .oindex "&%--help%&"
2699 This option causes Exim to output a few sentences stating what it is.
2700 The same output is generated if the Exim binary is called with no options and
2701 no arguments.
2702
2703 .vitem &%--version%&
2704 .oindex "&%--version%&"
2705 This option is an alias for &%-bV%& and causes version information to be
2706 displayed.
2707
2708 .new
2709 .vitem &%-Ac%& &&&
2710        &%-Am%&
2711 .oindex "&%-Ac%&"
2712 .oindex "&%-Am%&"
2713 These options are used by Sendmail for selecting configuration files and are
2714 ignored by Exim.
2715 .wen
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$sender_domain$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 .new
2977 . // Keep :help first, then the rest in alphabetical order
2978 .vitem &%-bI:help%&
2979 .oindex "&%-bI:help%&"
2980 .cindex "querying exim information"
2981 We shall provide various options starting &`-bI:`& for querying Exim for
2982 information.  The output of many of these will be intended for machine
2983 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2984 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2985 options shall cause Exim to exit after producing the requested output.
2986
2987 .vitem &%-bI:dscp%&
2988 .oindex "&%-bI:dscp%&"
2989 .cindex "DSCP" "values"
2990 This option causes Exim to emit an alphabetically sorted list of all
2991 recognised DSCP names.
2992
2993 .vitem &%-bI:sieve%&
2994 .oindex "&%-bI:sieve%&"
2995 .cindex "Sieve filter" "capabilities"
2996 This option causes Exim to emit an alphabetically sorted list of all supported
2997 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2998 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2999 &`SIEVE`& capability response line.  As the precise list may depend upon
3000 compile-time build options, which this option will adapt to, this is the only
3001 way to guarantee a correct response.
3002 .wen
3003
3004 .vitem &%-bm%&
3005 .oindex "&%-bm%&"
3006 .cindex "local message reception"
3007 This option runs an Exim receiving process that accepts an incoming,
3008 locally-generated message on the standard input. The recipients are given as the
3009 command arguments (except when &%-t%& is also present &-- see below). Each
3010 argument can be a comma-separated list of RFC 2822 addresses. This is the
3011 default option for selecting the overall action of an Exim call; it is assumed
3012 if no other conflicting option is present.
3013
3014 If any addresses in the message are unqualified (have no domain), they are
3015 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3016 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3017 suppressing this for special cases.
3018
3019 Policy checks on the contents of local messages can be enforced by means of
3020 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3021
3022 .cindex "return code" "for &%-bm%&"
3023 The return code is zero if the message is successfully accepted. Otherwise, the
3024 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3025
3026 The format
3027 .cindex "message" "format"
3028 .cindex "format" "message"
3029 .cindex "&""From""& line"
3030 .cindex "UUCP" "&""From""& line"
3031 .cindex "Sendmail compatibility" "&""From""& line"
3032 of the message must be as defined in RFC 2822, except that, for
3033 compatibility with Sendmail and Smail, a line in one of the forms
3034 .code
3035 From sender Fri Jan  5 12:55 GMT 1997
3036 From sender Fri, 5 Jan 97 12:55:01
3037 .endd
3038 (with the weekday optional, and possibly with additional text after the date)
3039 is permitted to appear at the start of the message. There appears to be no
3040 authoritative specification of the format of this line. Exim recognizes it by
3041 matching against the regular expression defined by the &%uucp_from_pattern%&
3042 option, which can be changed if necessary.
3043
3044 .oindex "&%-f%&" "overriding &""From""& line"
3045 The specified sender is treated as if it were given as the argument to the
3046 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3047 preference to the address taken from the message. The caller of Exim must be a
3048 trusted user for the sender of a message to be set in this way.
3049
3050 .vitem &%-bmalware%&&~<&'filename'&>
3051 .oindex "&%-bmalware%&"
3052 .cindex "testing", "malware"
3053 .cindex "malware scan test"
3054 This debugging option causes Exim to scan the given file,
3055 using the malware scanning framework.  The option of &%av_scanner%& influences
3056 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3057 the expansion should have defaults which apply to this invocation.  ACLs are
3058 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3059 will never be populated and &%-bmalware%& will fail.
3060
3061 Exim will have changed working directory before resolving the filename, so
3062 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3063 user when it tries to open the file, rather than as the invoking user.
3064 This option requires admin privileges.
3065
3066 The &%-bmalware%& option will not be extended to be more generally useful,
3067 there are better tools for file-scanning.  This option exists to help
3068 administrators verify their Exim and AV scanner configuration.
3069
3070 .vitem &%-bnq%&
3071 .oindex "&%-bnq%&"
3072 .cindex "address qualification, suppressing"
3073 By default, Exim automatically qualifies unqualified addresses (those
3074 without domains) that appear in messages that are submitted locally (that
3075 is, not over TCP/IP). This qualification applies both to addresses in
3076 envelopes, and addresses in header lines. Sender addresses are qualified using
3077 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3078 defaults to the value of &%qualify_domain%&).
3079
3080 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3081 being used to re-submit messages that originally came from remote hosts after
3082 content scanning, you probably do not want to qualify unqualified addresses in
3083 header lines. (Such lines will be present only if you have not enabled a header
3084 syntax check in the appropriate ACL.)
3085
3086 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3087 messages that originate on the local host. When this is used, unqualified
3088 addresses in the envelope provoke errors (causing message rejection) and
3089 unqualified addresses in header lines are left alone.
3090
3091
3092 .vitem &%-bP%&
3093 .oindex "&%-bP%&"
3094 .cindex "configuration options" "extracting"
3095 .cindex "options" "configuration &-- extracting"
3096 If this option is given with no arguments, it causes the values of all Exim's
3097 main configuration options to be written to the standard output. The values
3098 of one or more specific options can be requested by giving their names as
3099 arguments, for example:
3100 .code
3101 exim -bP qualify_domain hold_domains
3102 .endd
3103 .cindex "hiding configuration option values"
3104 .cindex "configuration options" "hiding value of"
3105 .cindex "options" "hiding value of"
3106 However, any option setting that is preceded by the word &"hide"& in the
3107 configuration file is not shown in full, except to an admin user. For other
3108 users, the output is as in this example:
3109 .code
3110 mysql_servers = <value not displayable>
3111 .endd
3112 If &%configure_file%& is given as an argument, the name of the run time
3113 configuration file is output.
3114 If a list of configuration files was supplied, the value that is output here
3115 is the name of the file that was actually used.
3116
3117 .new
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121 .wen
3122
3123 .cindex "daemon" "process id (pid)"
3124 .cindex "pid (process id)" "of daemon"
3125 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3126 directories where log files and daemon pid files are written are output,
3127 respectively. If these values are unset, log files are written in a
3128 sub-directory of the spool directory called &%log%&, and the pid file is
3129 written directly into the spool directory.
3130
3131 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3132 .code
3133 exim -bP +local_domains
3134 .endd
3135 it searches for a matching named list of any type (domain, host, address, or
3136 local part) and outputs what it finds.
3137
3138 .cindex "options" "router &-- extracting"
3139 .cindex "options" "transport &-- extracting"
3140 .cindex "options" "authenticator &-- extracting"
3141 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3142 followed by the name of an appropriate driver instance, the option settings for
3143 that driver are output. For example:
3144 .code
3145 exim -bP transport local_delivery
3146 .endd
3147 The generic driver options are output first, followed by the driver's private
3148 options. A list of the names of drivers of a particular type can be obtained by
3149 using one of the words &%router_list%&, &%transport_list%&, or
3150 &%authenticator_list%&, and a complete list of all drivers with their option
3151 settings can be obtained by using &%routers%&, &%transports%&, or
3152 &%authenticators%&.
3153
3154 .cindex "options" "macro &-- extracting"
3155 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3156 are available, similarly to the drivers.  Because macros are sometimes used
3157 for storing passwords, this option is restricted.
3158 The output format is one item per line.
3159
3160 .vitem &%-bp%&
3161 .oindex "&%-bp%&"
3162 .cindex "queue" "listing messages on"
3163 .cindex "listing" "messages on the queue"
3164 This option requests a listing of the contents of the mail queue on the
3165 standard output. If the &%-bp%& option is followed by a list of message ids,
3166 just those messages are listed. By default, this option can be used only by an
3167 admin user. However, the &%queue_list_requires_admin%& option can be set false
3168 to allow any user to see the queue.
3169
3170 Each message on the queue is displayed as in the following example:
3171 .code
3172 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3173           red.king@looking-glass.fict.example
3174           <other addresses>
3175 .endd
3176 .cindex "message" "size in queue listing"
3177 .cindex "size" "of message"
3178 The first line contains the length of time the message has been on the queue
3179 (in this case 25 minutes), the size of the message (2.9K), the unique local
3180 identifier for the message, and the message sender, as contained in the
3181 envelope. For bounce messages, the sender address is empty, and appears as
3182 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3183 the default sender address, the user's login name is shown in parentheses
3184 before the sender address.
3185
3186 .cindex "frozen messages" "in queue listing"
3187 If the message is frozen (attempts to deliver it are suspended) then the text
3188 &"*** frozen ***"& is displayed at the end of this line.
3189
3190 The recipients of the message (taken from the envelope, not the headers) are
3191 displayed on subsequent lines. Those addresses to which the message has already
3192 been delivered are marked with the letter D. If an original address gets
3193 expanded into several addresses via an alias or forward file, the original is
3194 displayed with a D only when deliveries for all of its child addresses are
3195 complete.
3196
3197
3198 .vitem &%-bpa%&
3199 .oindex "&%-bpa%&"
3200 This option operates like &%-bp%&, but in addition it shows delivered addresses
3201 that were generated from the original top level address(es) in each message by
3202 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3203 of just &"D"&.
3204
3205
3206 .vitem &%-bpc%&
3207 .oindex "&%-bpc%&"
3208 .cindex "queue" "count of messages on"
3209 This option counts the number of messages on the queue, and writes the total
3210 to the standard output. It is restricted to admin users, unless
3211 &%queue_list_requires_admin%& is set false.
3212
3213
3214 .vitem &%-bpr%&
3215 .oindex "&%-bpr%&"
3216 This option operates like &%-bp%&, but the output is not sorted into
3217 chronological order of message arrival. This can speed it up when there are
3218 lots of messages on the queue, and is particularly useful if the output is
3219 going to be post-processed in a way that doesn't need the sorting.
3220
3221 .vitem &%-bpra%&
3222 .oindex "&%-bpra%&"
3223 This option is a combination of &%-bpr%& and &%-bpa%&.
3224
3225 .vitem &%-bpru%&
3226 .oindex "&%-bpru%&"
3227 This option is a combination of &%-bpr%& and &%-bpu%&.
3228
3229
3230 .vitem &%-bpu%&
3231 .oindex "&%-bpu%&"
3232 This option operates like &%-bp%& but shows only undelivered top-level
3233 addresses for each message displayed. Addresses generated by aliasing or
3234 forwarding are not shown, unless the message was deferred after processing by a
3235 router with the &%one_time%& option set.
3236
3237
3238 .vitem &%-brt%&
3239 .oindex "&%-brt%&"
3240 .cindex "testing" "retry configuration"
3241 .cindex "retry" "configuration testing"
3242 This option is for testing retry rules, and it must be followed by up to three
3243 arguments. It causes Exim to look for a retry rule that matches the values
3244 and to write it to the standard output. For example:
3245 .code
3246 exim -brt bach.comp.mus.example
3247 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3248 .endd
3249 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3250 argument, which is required, can be a complete address in the form
3251 &'local_part@domain'&, or it can be just a domain name. If the second argument
3252 contains a dot, it is interpreted as an optional second domain name; if no
3253 retry rule is found for the first argument, the second is tried. This ties in
3254 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3255 rule is found that matches the host, one that matches the mail domain is
3256 sought. Finally, an argument that is the name of a specific delivery error, as
3257 used in setting up retry rules, can be given. For example:
3258 .code
3259 exim -brt haydn.comp.mus.example quota_3d
3260 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3261 .endd
3262
3263 .vitem &%-brw%&
3264 .oindex "&%-brw%&"
3265 .cindex "testing" "rewriting"
3266 .cindex "rewriting" "testing"
3267 This option is for testing address rewriting rules, and it must be followed by
3268 a single argument, consisting of either a local part without a domain, or a
3269 complete address with a fully qualified domain. Exim outputs how this address
3270 would be rewritten for each possible place it might appear. See chapter
3271 &<<CHAPrewrite>>& for further details.
3272
3273 .vitem &%-bS%&
3274 .oindex "&%-bS%&"
3275 .cindex "SMTP" "batched incoming"
3276 .cindex "batched SMTP input"
3277 This option is used for batched SMTP input, which is an alternative interface
3278 for non-interactive local message submission. A number of messages can be
3279 submitted in a single run. However, despite its name, this is not really SMTP
3280 input. Exim reads each message's envelope from SMTP commands on the standard
3281 input, but generates no responses. If the caller is trusted, or
3282 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3283 believed; otherwise the sender is always the caller of Exim.
3284
3285 The message itself is read from the standard input, in SMTP format (leading
3286 dots doubled), terminated by a line containing just a single dot. An error is
3287 provoked if the terminating dot is missing. A further message may then follow.
3288
3289 As for other local message submissions, the contents of incoming batch SMTP
3290 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3291 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3292 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3293
3294 Some other SMTP commands are recognized in the input. HELO and EHLO act
3295 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3296 QUIT quits, ignoring the rest of the standard input.
3297
3298 .cindex "return code" "for &%-bS%&"
3299 If any error is encountered, reports are written to the standard output and
3300 error streams, and Exim gives up immediately. The return code is 0 if no error
3301 was detected; it is 1 if one or more messages were accepted before the error
3302 was detected; otherwise it is 2.
3303
3304 More details of input using batched SMTP are given in section
3305 &<<SECTincomingbatchedSMTP>>&.
3306
3307 .vitem &%-bs%&
3308 .oindex "&%-bs%&"
3309 .cindex "SMTP" "local input"
3310 .cindex "local SMTP input"
3311 This option causes Exim to accept one or more messages by reading SMTP commands
3312 on the standard input, and producing SMTP replies on the standard output. SMTP
3313 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3314 Some user agents use this interface as a way of passing locally-generated
3315 messages to the MTA.
3316
3317 In
3318 .cindex "sender" "source of"
3319 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3320 set, the senders of messages are taken from the SMTP MAIL commands.
3321 Otherwise the content of these commands is ignored and the sender is set up as
3322 the calling user. Unqualified addresses are automatically qualified using
3323 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3324 &%-bnq%& option is used.
3325
3326 .cindex "inetd"
3327 The
3328 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3329 using a listening daemon. Exim can distinguish the two cases by checking
3330 whether the standard input is a TCP/IP socket. When Exim is called from
3331 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3332 above concerning senders and qualification do not apply. In this situation,
3333 Exim behaves in exactly the same way as it does when receiving a message via
3334 the listening daemon.
3335
3336 .vitem &%-bt%&
3337 .oindex "&%-bt%&"
3338 .cindex "testing" "addresses"
3339 .cindex "address" "testing"
3340 This option runs Exim in address testing mode, in which each argument is taken
3341 as a recipient address to be tested for deliverability. The results are
3342 written to the standard output. If a test fails, and the caller is not an admin
3343 user, no details of the failure are output, because these might contain
3344 sensitive information such as usernames and passwords for database lookups.
3345
3346 If no arguments are given, Exim runs in an interactive manner, prompting with a
3347 right angle bracket for addresses to be tested.
3348
3349 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3350 &[readline()]& function, because it is running as &'root'& and there are
3351 security issues.
3352
3353 Each address is handled as if it were the recipient address of a message
3354 (compare the &%-bv%& option). It is passed to the routers and the result is
3355 written to the standard output. However, any router that has
3356 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3357 genuine routing tests if your first router passes everything to a scanner
3358 program.
3359
3360 .cindex "return code" "for &%-bt%&"
3361 The return code is 2 if any address failed outright; it is 1 if no address
3362 failed outright but at least one could not be resolved for some reason. Return
3363 code 0 is given only when all addresses succeed.
3364
3365 .cindex "duplicate addresses"
3366 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3367 addresses after routing is complete, so that only one delivery takes place.
3368 This does not happen when testing with &%-bt%&; the full results of routing are
3369 always shown.
3370
3371 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3372 routers in the configuration makes any tests on the sender address of a
3373 message,
3374 .oindex "&%-f%&" "for address testing"
3375 you can use the &%-f%& option to set an appropriate sender when running
3376 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3377 default qualifying domain. However, if you have set up (for example) routers
3378 whose behaviour depends on the contents of an incoming message, you cannot test
3379 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3380 doing such tests.
3381
3382 .vitem &%-bV%&
3383 .oindex "&%-bV%&"
3384 .cindex "version number of Exim"
3385 This option causes Exim to write the current version number, compilation
3386 number, and compilation date of the &'exim'& binary to the standard output.
3387 It also lists the DBM library that is being used, the optional modules (such as
3388 specific lookup types), the drivers that are included in the binary, and the
3389 name of the run time configuration file that is in use.
3390
3391 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3392 configuration file. However, this is a static check only. It cannot check
3393 values that are to be expanded. For example, although a misspelt ACL verb is
3394 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3395 alone to discover (for example) all the typos in the configuration; some
3396 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3397 dynamic testing facilities.
3398
3399 .vitem &%-bv%&
3400 .oindex "&%-bv%&"
3401 .cindex "verifying address" "using &%-bv%&"
3402 .cindex "address" "verification"
3403 This option runs Exim in address verification mode, in which each argument is
3404 taken as a recipient address to be verified by the routers. (This does
3405 not involve any verification callouts). During normal operation, verification
3406 happens mostly as a consequence processing a &%verify%& condition in an ACL
3407 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3408 including callouts, see the &%-bh%& and &%-bhc%& options.
3409
3410 If verification fails, and the caller is not an admin user, no details of the
3411 failure are output, because these might contain sensitive information such as
3412 usernames and passwords for database lookups.
3413
3414 If no arguments are given, Exim runs in an interactive manner, prompting with a
3415 right angle bracket for addresses to be verified.
3416
3417 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3418 &[readline()]& function, because it is running as &'exim'& and there are
3419 security issues.
3420
3421 Verification differs from address testing (the &%-bt%& option) in that routers
3422 that have &%no_verify%& set are skipped, and if the address is accepted by a
3423 router that has &%fail_verify%& set, verification fails. The address is
3424 verified as a recipient if &%-bv%& is used; to test verification for a sender
3425 address, &%-bvs%& should be used.
3426
3427 If the &%-v%& option is not set, the output consists of a single line for each
3428 address, stating whether it was verified or not, and giving a reason in the
3429 latter case. Without &%-v%&, generating more than one address by redirection
3430 causes verification to end successfully, without considering the generated
3431 addresses. However, if just one address is generated, processing continues,
3432 and the generated address must verify successfully for the overall verification
3433 to succeed.
3434
3435 When &%-v%& is set, more details are given of how the address has been handled,
3436 and in the case of address redirection, all the generated addresses are also
3437 considered. Verification may succeed for some and fail for others.
3438
3439 The
3440 .cindex "return code" "for &%-bv%&"
3441 return code is 2 if any address failed outright; it is 1 if no address
3442 failed outright but at least one could not be resolved for some reason. Return
3443 code 0 is given only when all addresses succeed.
3444
3445 If any of the routers in the configuration makes any tests on the sender
3446 address of a message, you should use the &%-f%& option to set an appropriate
3447 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3448 calling user at the default qualifying domain.
3449
3450 .vitem &%-bvs%&
3451 .oindex "&%-bvs%&"
3452 This option acts like &%-bv%&, but verifies the address as a sender rather
3453 than a recipient address. This affects any rewriting and qualification that
3454 might happen.
3455
3456 .vitem &%-bw%&
3457 .oindex "&%-bw%&"
3458 .cindex "daemon"
3459 .cindex "inetd"
3460 .cindex "inetd" "wait mode"
3461 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3462 similarly to the &%-bd%& option.  All port specifications on the command-line
3463 and in the configuration file are ignored.  Queue-running may not be specified.
3464
3465 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3466 listening for connections.  This permits the system to start up and have
3467 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3468 each port only when the first connection is received.
3469
3470 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3471 which the daemon will exit, which should cause inetd to listen once more.
3472
3473 .vitem &%-C%&&~<&'filelist'&>
3474 .oindex "&%-C%&"
3475 .cindex "configuration file" "alternate"
3476 .cindex "CONFIGURE_FILE"
3477 .cindex "alternate configuration file"
3478 This option causes Exim to find the run time configuration file from the given
3479 list instead of from the list specified by the CONFIGURE_FILE
3480 compile-time setting. Usually, the list will consist of just a single file
3481 name, but it can be a colon-separated list of names. In this case, the first
3482 file that exists is used. Failure to open an existing file stops Exim from
3483 proceeding any further along the list, and an error is generated.
3484
3485 When this option is used by a caller other than root, and the list is different
3486 from the compiled-in list, Exim gives up its root privilege immediately, and
3487 runs with the real and effective uid and gid set to those of the caller.
3488 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3489 file contains a list of full pathnames, one per line, for configuration files
3490 which are trusted. Root privilege is retained for any configuration file so
3491 listed, as long as the caller is the Exim user (or the user specified in the
3492 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3493 not writeable by inappropriate users or groups.
3494
3495 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3496 configuration using &%-C%& right through message reception and delivery,
3497 even if the caller is root. The reception works, but by that time, Exim is
3498 running as the Exim user, so when it re-executes to regain privilege for the
3499 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3500 test reception and delivery using two separate commands (one to put a message
3501 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3502
3503 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3504 prefix string with which any file named in a &%-C%& command line option
3505 must start. In addition, the file name must not contain the sequence &`/../`&.
3506 However, if the value of the &%-C%& option is identical to the value of
3507 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3508 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3509 unset, any file name can be used with &%-C%&.
3510
3511 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3512 to a directory to which only root has access. This prevents someone who has
3513 broken into the Exim account from running a privileged Exim with an arbitrary
3514 configuration file.
3515
3516 The &%-C%& facility is useful for ensuring that configuration files are
3517 syntactically correct, but cannot be used for test deliveries, unless the
3518 caller is privileged, or unless it is an exotic configuration that does not
3519 require privilege. No check is made on the owner or group of the files
3520 specified by this option.
3521
3522
3523 .vitem &%-D%&<&'macro'&>=<&'value'&>
3524 .oindex "&%-D%&"
3525 .cindex "macro" "setting on command line"
3526 This option can be used to override macro definitions in the configuration file
3527 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3528 unprivileged caller, it causes Exim to give up its root privilege.
3529 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3530 completely disabled, and its use causes an immediate error exit.
3531
3532 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3533 colon-separated list of macros which are considered safe and, if &%-D%& only
3534 supplies macros from this list, and the values are acceptable, then Exim will
3535 not give up root privilege if the caller is root, the Exim run-time user, or
3536 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3537 to be removed in the future.  Acceptable values for the macros satisfy the
3538 regexp: &`^[A-Za-z0-9_/.-]*$`&
3539
3540 The entire option (including equals sign if present) must all be within one
3541 command line item. &%-D%& can be used to set the value of a macro to the empty
3542 string, in which case the equals sign is optional. These two commands are
3543 synonymous:
3544 .code
3545 exim -DABC  ...
3546 exim -DABC= ...
3547 .endd
3548 To include spaces in a macro definition item, quotes must be used. If you use
3549 quotes, spaces are permitted around the macro name and the equals sign. For
3550 example:
3551 .code
3552 exim '-D ABC = something' ...
3553 .endd
3554 &%-D%& may be repeated up to 10 times on a command line.
3555
3556
3557 .vitem &%-d%&<&'debug&~options'&>
3558 .oindex "&%-d%&"
3559 .cindex "debugging" "list of selectors"
3560 .cindex "debugging" "&%-d%& option"
3561 This option causes debugging information to be written to the standard
3562 error stream. It is restricted to admin users because debugging output may show
3563 database queries that contain password information. Also, the details of users'
3564 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3565 writes an error message to the standard error stream and exits with a non-zero
3566 return code.
3567
3568 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3569 standard debugging data is output. This can be reduced, or increased to include
3570 some more rarely needed information, by directly following &%-d%& with a string
3571 made up of names preceded by plus or minus characters. These add or remove sets
3572 of debugging data, respectively. For example, &%-d+filter%& adds filter
3573 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3574 no spaces are allowed in the debug setting. The available debugging categories
3575 are:
3576 .display
3577 &`acl            `& ACL interpretation
3578 &`auth           `& authenticators
3579 &`deliver        `& general delivery logic
3580 &`dns            `& DNS lookups (see also resolver)
3581 &`dnsbl          `& DNS black list (aka RBL) code
3582 &`exec           `& arguments for &[execv()]& calls
3583 &`expand         `& detailed debugging for string expansions
3584 &`filter         `& filter handling
3585 &`hints_lookup   `& hints data lookups
3586 &`host_lookup    `& all types of name-to-IP address handling
3587 &`ident          `& ident lookup
3588 &`interface      `& lists of local interfaces
3589 &`lists          `& matching things in lists
3590 &`load           `& system load checks
3591 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3592                     &<<CHAPlocalscan>>&)
3593 &`lookup         `& general lookup code and all lookups
3594 &`memory         `& memory handling
3595 &`pid            `& add pid to debug output lines
3596 &`process_info   `& setting info for the process log
3597 &`queue_run      `& queue runs
3598 &`receive        `& general message reception logic
3599 &`resolver       `& turn on the DNS resolver's debugging output
3600 &`retry          `& retry handling
3601 &`rewrite        `& address rewriting
3602 &`route          `& address routing
3603 &`timestamp      `& add timestamp to debug output lines
3604 &`tls            `& TLS logic
3605 &`transport      `& transports
3606 &`uid            `& changes of uid/gid and looking up uid/gid
3607 &`verify         `& address verification logic
3608 &`all            `& almost all of the above (see below), and also &%-v%&
3609 .endd
3610 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3611 for &`-all`&. The reason for this is that &`+all`& is something that people
3612 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3613 is included, an awful lot of output that is very rarely of interest is
3614 generated, so it now has to be explicitly requested. However, &`-all`& does
3615 turn everything off.
3616
3617 .cindex "resolver, debugging output"
3618 .cindex "DNS resolver, debugging output"
3619 The &`resolver`& option produces output only if the DNS resolver was compiled
3620 with DEBUG enabled. This is not the case in some operating systems. Also,
3621 unfortunately, debugging output from the DNS resolver is written to stdout
3622 rather than stderr.
3623
3624 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3625 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3626 However, the &`pid`& selector is forced when debugging is turned on for a
3627 daemon, which then passes it on to any re-executed Exims. Exim also
3628 automatically adds the pid to debug lines when several remote deliveries are
3629 run in parallel.
3630
3631 The &`timestamp`& selector causes the current time to be inserted at the start
3632 of all debug output lines. This can be useful when trying to track down delays
3633 in processing.
3634
3635 If the &%debug_print%& option is set in any driver, it produces output whenever
3636 any debugging is selected, or if &%-v%& is used.
3637
3638 .vitem &%-dd%&<&'debug&~options'&>
3639 .oindex "&%-dd%&"
3640 This option behaves exactly like &%-d%& except when used on a command that
3641 starts a daemon process. In that case, debugging is turned off for the
3642 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3643 behaviour of the daemon without creating as much output as full debugging does.
3644
3645 .vitem &%-dropcr%&
3646 .oindex "&%-dropcr%&"
3647 This is an obsolete option that is now a no-op. It used to affect the way Exim
3648 handled CR and LF characters in incoming messages. What happens now is
3649 described in section &<<SECTlineendings>>&.
3650
3651 .vitem &%-E%&
3652 .oindex "&%-E%&"
3653 .cindex "bounce message" "generating"
3654 This option specifies that an incoming message is a locally-generated delivery
3655 failure report. It is used internally by Exim when handling delivery failures
3656 and is not intended for external use. Its only effect is to stop Exim
3657 generating certain messages to the postmaster, as otherwise message cascades
3658 could occur in some situations. As part of the same option, a message id may
3659 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3660 new message contains the id, following &"R="&, as a cross-reference.
3661
3662 .vitem &%-e%&&'x'&
3663 .oindex "&%-e%&&'x'&"
3664 There are a number of Sendmail options starting with &%-oe%& which seem to be
3665 called by various programs without the leading &%o%& in the option. For
3666 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3667 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3668
3669 .vitem &%-F%&&~<&'string'&>
3670 .oindex "&%-F%&"
3671 .cindex "sender" "name"
3672 .cindex "name" "of sender"
3673 This option sets the sender's full name for use when a locally-generated
3674 message is being accepted. In the absence of this option, the user's &'gecos'&
3675 entry from the password data is used. As users are generally permitted to alter
3676 their &'gecos'& entries, no security considerations are involved. White space
3677 between &%-F%& and the <&'string'&> is optional.
3678
3679 .vitem &%-f%&&~<&'address'&>
3680 .oindex "&%-f%&"
3681 .cindex "sender" "address"
3682 .cindex "address" "sender"
3683 .cindex "trusted users"
3684 .cindex "envelope sender"
3685 .cindex "user" "trusted"
3686 This option sets the address of the envelope sender of a locally-generated
3687 message (also known as the return path). The option can normally be used only
3688 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3689 users to use it.
3690
3691 Processes running as root or the Exim user are always trusted. Other
3692 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3693 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3694 of a local message is set to the caller's login name at the default qualify
3695 domain.
3696
3697 There is one exception to the restriction on the use of &%-f%&: an empty sender
3698 can be specified by any user, trusted or not, to create a message that can
3699 never provoke a bounce. An empty sender can be specified either as an empty
3700 string, or as a pair of angle brackets with nothing between them, as in these
3701 examples of shell commands:
3702 .code
3703 exim -f '<>' user@domain
3704 exim -f "" user@domain
3705 .endd
3706 In addition, the use of &%-f%& is not restricted when testing a filter file
3707 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3708 &%-bv%& options.
3709
3710 Allowing untrusted users to change the sender address does not of itself make
3711 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3712 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3713 though this can be overridden by setting &%no_local_from_check%&.
3714
3715 White
3716 .cindex "&""From""& line"
3717 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3718 given as two arguments or one combined argument). The sender of a
3719 locally-generated message can also be set (when permitted) by an initial
3720 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3721 if &%-f%& is also present, it overrides &"From&~"&.
3722
3723 .vitem &%-G%&
3724 .oindex "&%-G%&"
3725 .cindex "submission fixups, suppressing (command-line)"
3726 .new
3727 This option is equivalent to an ACL applying:
3728 .code
3729 control = suppress_local_fixups
3730 .endd
3731 for every message received.  Note that Sendmail will complain about such
3732 bad formatting, where Exim silently just does not fix it up.  This may change
3733 in future.
3734
3735 As this affects audit information, the caller must be a trusted user to use
3736 this option.
3737 .wen
3738
3739 .vitem &%-h%&&~<&'number'&>
3740 .oindex "&%-h%&"
3741 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3742 This option is accepted for compatibility with Sendmail, but has no effect. (In
3743 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3744 headers.)
3745
3746 .vitem &%-i%&
3747 .oindex "&%-i%&"
3748 .cindex "Solaris" "&'mail'& command"
3749 .cindex "dot" "in incoming non-SMTP message"
3750 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3751 line by itself should not terminate an incoming, non-SMTP message. I can find
3752 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3753 command in Solaris 2.4 uses it. See also &%-ti%&.
3754
3755 .new
3756 .vitem &%-L%&&~<&'tag'&>
3757 .oindex "&%-L%&"
3758 .cindex "syslog" "process name; set with flag"
3759 This option is equivalent to setting &%syslog_processname%& in the config
3760 file and setting &%log_file_path%& to &`syslog`&.
3761 Its use is restricted to administrators.  The configuration file has to be
3762 read and parsed, to determine access rights, before this is set and takes
3763 effect, so early configuration file errors will not honour this flag.
3764
3765 The tag should not be longer than 32 characters.
3766 .wen
3767
3768 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3769 .oindex "&%-M%&"
3770 .cindex "forcing delivery"
3771 .cindex "delivery" "forcing attempt"
3772 .cindex "frozen messages" "forcing delivery"
3773 This option requests Exim to run a delivery attempt on each message in turn. If
3774 any of the messages are frozen, they are automatically thawed before the
3775 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3776 and &%hold_domains%& are ignored.
3777
3778 Retry
3779 .cindex "hints database" "overriding retry hints"
3780 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3781 the normal retry time has not yet been reached. This option requires the caller
3782 to be an admin user. However, there is an option called &%prod_requires_admin%&
3783 which can be set false to relax this restriction (and also the same requirement
3784 for the &%-q%&, &%-R%&, and &%-S%& options).
3785
3786 The deliveries happen synchronously, that is, the original Exim process does
3787 not terminate until all the delivery attempts have finished. No output is
3788 produced unless there is a serious error. If you want to see what is happening,
3789 use the &%-v%& option as well, or inspect Exim's main log.
3790
3791 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3792 .oindex "&%-Mar%&"
3793 .cindex "message" "adding recipients"
3794 .cindex "recipient" "adding"
3795 This option requests Exim to add the addresses to the list of recipients of the
3796 message (&"ar"& for &"add recipients"&). The first argument must be a message
3797 id, and the remaining ones must be email addresses. However, if the message is
3798 active (in the middle of a delivery attempt), it is not altered. This option
3799 can be used only by an admin user.
3800
3801 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3802         &~<&'message&~id'&>"
3803 .oindex "&%-MC%&"
3804 .cindex "SMTP" "passed connection"
3805 .cindex "SMTP" "multiple deliveries"
3806 .cindex "multiple SMTP deliveries"
3807 This option is not intended for use by external callers. It is used internally
3808 by Exim to invoke another instance of itself to deliver a waiting message using
3809 an existing SMTP connection, which is passed as the standard input. Details are
3810 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3811 must be root or the Exim user in order to use it.
3812
3813 .vitem &%-MCA%&
3814 .oindex "&%-MCA%&"
3815 This option is not intended for use by external callers. It is used internally
3816 by Exim in conjunction with the &%-MC%& option. It signifies that the
3817 connection to the remote host has been authenticated.
3818
3819 .vitem &%-MCP%&
3820 .oindex "&%-MCP%&"
3821 This option is not intended for use by external callers. It is used internally
3822 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3823 which Exim is connected supports pipelining.
3824
3825 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3826 .oindex "&%-MCQ%&"
3827 This option is not intended for use by external callers. It is used internally
3828 by Exim in conjunction with the &%-MC%& option when the original delivery was
3829 started by a queue runner. It passes on the process id of the queue runner,
3830 together with the file descriptor number of an open pipe. Closure of the pipe
3831 signals the final completion of the sequence of processes that are passing
3832 messages through the same SMTP connection.
3833
3834 .vitem &%-MCS%&
3835 .oindex "&%-MCS%&"
3836 This option is not intended for use by external callers. It is used internally
3837 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3838 SMTP SIZE option should be used on messages delivered down the existing
3839 connection.
3840
3841 .vitem &%-MCT%&
3842 .oindex "&%-MCT%&"
3843 This option is not intended for use by external callers. It is used internally
3844 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3845 host to which Exim is connected supports TLS encryption.
3846
3847 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3848 .oindex "&%-Mc%&"
3849 .cindex "hints database" "not overridden by &%-Mc%&"
3850 .cindex "delivery" "manually started &-- not forced"
3851 This option requests Exim to run a delivery attempt on each message in turn,
3852 but unlike the &%-M%& option, it does check for retry hints, and respects any
3853 that are found. This option is not very useful to external callers. It is
3854 provided mainly for internal use by Exim when it needs to re-invoke itself in
3855 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3856 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3857 respects retry times and other options such as &%hold_domains%& that are
3858 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3859 If you want to run a specific delivery as if in a queue run, you should use
3860 &%-q%& with a message id argument. A distinction between queue run deliveries
3861 and other deliveries is made in one or two places.
3862
3863 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3864 .oindex "&%-Mes%&"
3865 .cindex "message" "changing sender"
3866 .cindex "sender" "changing"
3867 This option requests Exim to change the sender address in the message to the
3868 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3869 &"edit sender"&). There must be exactly two arguments. The first argument must
3870 be a message id, and the second one an email address. However, if the message
3871 is active (in the middle of a delivery attempt), its status is not altered.
3872 This option can be used only by an admin user.
3873
3874 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3875 .oindex "&%-Mf%&"
3876 .cindex "freezing messages"
3877 .cindex "message" "manually freezing"
3878 This option requests Exim to mark each listed message as &"frozen"&. This
3879 prevents any delivery attempts taking place until the message is &"thawed"&,
3880 either manually or as a result of the &%auto_thaw%& configuration option.
3881 However, if any of the messages are active (in the middle of a delivery
3882 attempt), their status is not altered. This option can be used only by an admin
3883 user.
3884
3885 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3886 .oindex "&%-Mg%&"
3887 .cindex "giving up on messages"
3888 .cindex "message" "abandoning delivery attempts"
3889 .cindex "delivery" "abandoning further attempts"
3890 This option requests Exim to give up trying to deliver the listed messages,
3891 including any that are frozen. However, if any of the messages are active,
3892 their status is not altered. For non-bounce messages, a delivery error message
3893 is sent to the sender, containing the text &"cancelled by administrator"&.
3894 Bounce messages are just discarded. This option can be used only by an admin
3895 user.
3896
3897 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3898 .oindex "&%-Mmad%&"
3899 .cindex "delivery" "cancelling all"
3900 This option requests Exim to mark all the recipient addresses in the messages
3901 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3902 message is active (in the middle of a delivery attempt), its status is not
3903 altered. This option can be used only by an admin user.
3904
3905 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3906 .oindex "&%-Mmd%&"
3907 .cindex "delivery" "cancelling by address"
3908 .cindex "recipient" "removing"
3909 .cindex "removing recipients"
3910 This option requests Exim to mark the given addresses as already delivered
3911 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3912 the remaining ones must be email addresses. These are matched to recipient
3913 addresses in the message in a case-sensitive manner. If the message is active
3914 (in the middle of a delivery attempt), its status is not altered. This option
3915 can be used only by an admin user.
3916
3917 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3918 .oindex "&%-Mrm%&"
3919 .cindex "removing messages"
3920 .cindex "abandoning mail"
3921 .cindex "message" "manually discarding"
3922 This option requests Exim to remove the given messages from the queue. No
3923 bounce messages are sent; each message is simply forgotten. However, if any of
3924 the messages are active, their status is not altered. This option can be used
3925 only by an admin user or by the user who originally caused the message to be
3926 placed on the queue.
3927
3928 .vitem &%-Mset%&&~<&'message&~id'&>
3929 .oindex "&%-Mset%&
3930 .cindex "testing" "string expansion"
3931 .cindex "expansion" "testing"
3932 This option is useful only in conjunction with &%-be%& (that is, when testing
3933 string expansions). Exim loads the given message from its spool before doing
3934 the test expansions, thus setting message-specific variables such as
3935 &$message_size$& and the header variables. The &$recipients$& variable is made
3936 available. This feature is provided to make it easier to test expansions that
3937 make use of these variables. However, this option can be used only by an admin
3938 user. See also &%-bem%&.
3939
3940 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3941 .oindex "&%-Mt%&"
3942 .cindex "thawing messages"
3943 .cindex "unfreezing messages"
3944 .cindex "frozen messages" "thawing"
3945 .cindex "message" "thawing frozen"
3946 This option requests Exim to &"thaw"& any of the listed messages that are
3947 &"frozen"&, so that delivery attempts can resume. However, if any of the
3948 messages are active, their status is not altered. This option can be used only
3949 by an admin user.
3950
3951 .vitem &%-Mvb%&&~<&'message&~id'&>
3952 .oindex "&%-Mvb%&"
3953 .cindex "listing" "message body"
3954 .cindex "message" "listing body of"
3955 This option causes the contents of the message body (-D) spool file to be
3956 written to the standard output. This option can be used only by an admin user.
3957
3958 .vitem &%-Mvc%&&~<&'message&~id'&>
3959 .oindex "&%-Mvc%&"
3960 .cindex "message" "listing in RFC 2822 format"
3961 .cindex "listing" "message in RFC 2822 format"
3962 This option causes a copy of the complete message (header lines plus body) to
3963 be written to the standard output in RFC 2822 format. This option can be used
3964 only by an admin user.
3965
3966 .vitem &%-Mvh%&&~<&'message&~id'&>
3967 .oindex "&%-Mvh%&"
3968 .cindex "listing" "message headers"
3969 .cindex "header lines" "listing"
3970 .cindex "message" "listing header lines"
3971 This option causes the contents of the message headers (-H) spool file to be
3972 written to the standard output. This option can be used only by an admin user.
3973
3974 .vitem &%-Mvl%&&~<&'message&~id'&>
3975 .oindex "&%-Mvl%&"
3976 .cindex "listing" "message log"
3977 .cindex "message" "listing message log"
3978 This option causes the contents of the message log spool file to be written to
3979 the standard output. This option can be used only by an admin user.
3980
3981 .vitem &%-m%&
3982 .oindex "&%-m%&"
3983 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3984 treats it that way too.
3985
3986 .vitem &%-N%&
3987 .oindex "&%-N%&"
3988 .cindex "debugging" "&%-N%& option"
3989 .cindex "debugging" "suppressing delivery"
3990 This is a debugging option that inhibits delivery of a message at the transport
3991 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3992 it just doesn't actually transport the message, but instead behaves as if it
3993 had successfully done so. However, it does not make any updates to the retry
3994 database, and the log entries for deliveries are flagged with &"*>"& rather
3995 than &"=>"&.
3996
3997 Because &%-N%& discards any message to which it applies, only root or the Exim
3998 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3999 words, an ordinary user can use it only when supplying an incoming message to
4000 which it will apply. Although transportation never fails when &%-N%& is set, an
4001 address may be deferred because of a configuration problem on a transport, or a
4002 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4003 the message, and applies to any subsequent delivery attempts that may happen
4004 for that message.
4005
4006 .vitem &%-n%&
4007 .oindex "&%-n%&"
4008 This option is interpreted by Sendmail to mean &"no aliasing"&.
4009 For normal modes of operation, it is ignored by Exim.
4010 When combined with &%-bP%& it suppresses the name of an option from being output.
4011
4012 .vitem &%-O%&&~<&'data'&>
4013 .oindex "&%-O%&"
4014 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4015 Exim.
4016
4017 .vitem &%-oA%&&~<&'file&~name'&>
4018 .oindex "&%-oA%&"
4019 .cindex "Sendmail compatibility" "&%-oA%& option"
4020 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4021 alternative alias file name. Exim handles &%-bi%& differently; see the
4022 description above.
4023
4024 .vitem &%-oB%&&~<&'n'&>
4025 .oindex "&%-oB%&"
4026 .cindex "SMTP" "passed connection"
4027 .cindex "SMTP" "multiple deliveries"
4028 .cindex "multiple SMTP deliveries"
4029 This is a debugging option which limits the maximum number of messages that can
4030 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4031 transport. If <&'n'&> is omitted, the limit is set to 1.
4032
4033 .vitem &%-odb%&
4034 .oindex "&%-odb%&"
4035 .cindex "background delivery"
4036 .cindex "delivery" "in the background"
4037 This option applies to all modes in which Exim accepts incoming messages,
4038 including the listening daemon. It requests &"background"& delivery of such
4039 messages, which means that the accepting process automatically starts a
4040 delivery process for each message received, but does not wait for the delivery
4041 processes to finish.
4042
4043 When all the messages have been received, the reception process exits,
4044 leaving the delivery processes to finish in their own time. The standard output
4045 and error streams are closed at the start of each delivery process.
4046 This is the default action if none of the &%-od%& options are present.
4047
4048 If one of the queueing options in the configuration file
4049 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4050 overrides it if &%queue_only_override%& is set true, which is the default
4051 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4052
4053 .vitem &%-odf%&
4054 .oindex "&%-odf%&"
4055 .cindex "foreground delivery"
4056 .cindex "delivery" "in the foreground"
4057 This option requests &"foreground"& (synchronous) delivery when Exim has
4058 accepted a locally-generated message. (For the daemon it is exactly the same as
4059 &%-odb%&.) A delivery process is automatically started to deliver the message,
4060 and Exim waits for it to complete before proceeding.
4061
4062 The original Exim reception process does not finish until the delivery
4063 process for the final message has ended. The standard error stream is left open
4064 during deliveries.
4065
4066 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4067 false and one of the queueing options in the configuration file is in effect.
4068
4069 If there is a temporary delivery error during foreground delivery, the
4070 message is left on the queue for later delivery, and the original reception
4071 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4072 restricted configuration that never queues messages.
4073
4074
4075 .vitem &%-odi%&
4076 .oindex "&%-odi%&"
4077 This option is synonymous with &%-odf%&. It is provided for compatibility with
4078 Sendmail.
4079
4080 .vitem &%-odq%&
4081 .oindex "&%-odq%&"
4082 .cindex "non-immediate delivery"
4083 .cindex "delivery" "suppressing immediate"
4084 .cindex "queueing incoming messages"
4085 This option applies to all modes in which Exim accepts incoming messages,
4086 including the listening daemon. It specifies that the accepting process should
4087 not automatically start a delivery process for each message received. Messages
4088 are placed on the queue, and remain there until a subsequent queue runner
4089 process encounters them. There are several configuration options (such as
4090 &%queue_only%&) that can be used to queue incoming messages under certain
4091 conditions. This option overrides all of them and also &%-odqs%&. It always
4092 forces queueing.
4093
4094 .vitem &%-odqs%&
4095 .oindex "&%-odqs%&"
4096 .cindex "SMTP" "delaying delivery"
4097 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4098 However, like &%-odb%& and &%-odi%&, this option has no effect if
4099 &%queue_only_override%& is false and one of the queueing options in the
4100 configuration file is in effect.
4101
4102 When &%-odqs%& does operate, a delivery process is started for each incoming
4103 message, in the background by default, but in the foreground if &%-odi%& is
4104 also present. The recipient addresses are routed, and local deliveries are done
4105 in the normal way. However, if any SMTP deliveries are required, they are not
4106 done at this time, so the message remains on the queue until a subsequent queue
4107 runner process encounters it. Because routing was done, Exim knows which
4108 messages are waiting for which hosts, and so a number of messages for the same
4109 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4110 configuration option has the same effect for specific domains. See also the
4111 &%-qq%& option.
4112
4113 .vitem &%-oee%&
4114 .oindex "&%-oee%&"
4115 .cindex "error" "reporting"
4116 If an error is detected while a non-SMTP message is being received (for
4117 example, a malformed address), the error is reported to the sender in a mail
4118 message.
4119
4120 .cindex "return code" "for &%-oee%&"
4121 Provided
4122 this error message is successfully sent, the Exim receiving process
4123 exits with a return code of zero. If not, the return code is 2 if the problem
4124 is that the original message has no recipients, or 1 for any other error.
4125 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4126
4127 .vitem &%-oem%&
4128 .oindex "&%-oem%&"
4129 .cindex "error" "reporting"
4130 .cindex "return code" "for &%-oem%&"
4131 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4132 return code, whether or not the error message was successfully sent.
4133 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4134
4135 .vitem &%-oep%&
4136 .oindex "&%-oep%&"
4137 .cindex "error" "reporting"
4138 If an error is detected while a non-SMTP message is being received, the
4139 error is reported by writing a message to the standard error file (stderr).
4140 .cindex "return code" "for &%-oep%&"
4141 The return code is 1 for all errors.
4142
4143 .vitem &%-oeq%&
4144 .oindex "&%-oeq%&"
4145 .cindex "error" "reporting"
4146 This option is supported for compatibility with Sendmail, but has the same
4147 effect as &%-oep%&.
4148
4149 .vitem &%-oew%&
4150 .oindex "&%-oew%&"
4151 .cindex "error" "reporting"
4152 This option is supported for compatibility with Sendmail, but has the same
4153 effect as &%-oem%&.
4154
4155 .vitem &%-oi%&
4156 .oindex "&%-oi%&"
4157 .cindex "dot" "in incoming non-SMTP message"
4158 This option, which has the same effect as &%-i%&, specifies that a dot on a
4159 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4160 single dot does terminate, though Exim does no special processing for other
4161 lines that start with a dot. This option is set by default if Exim is called as
4162 &'rmail'&. See also &%-ti%&.
4163
4164 .vitem &%-oitrue%&
4165 .oindex "&%-oitrue%&"
4166 This option is treated as synonymous with &%-oi%&.
4167
4168 .vitem &%-oMa%&&~<&'host&~address'&>
4169 .oindex "&%-oMa%&"
4170 .cindex "sender" "host address, specifying for local message"
4171 A number of options starting with &%-oM%& can be used to set values associated
4172 with remote hosts on locally-submitted messages (that is, messages not received
4173 over TCP/IP). These options can be used by any caller in conjunction with the
4174 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4175 other circumstances, they are ignored unless the caller is trusted.
4176
4177 The &%-oMa%& option sets the sender host address. This may include a port
4178 number at the end, after a full stop (period). For example:
4179 .code
4180 exim -bs -oMa 10.9.8.7.1234
4181 .endd
4182 An alternative syntax is to enclose the IP address in square brackets,
4183 followed by a colon and the port number:
4184 .code
4185 exim -bs -oMa [10.9.8.7]:1234
4186 .endd
4187 The IP address is placed in the &$sender_host_address$& variable, and the
4188 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4189 are present on the command line, the sender host IP address is taken from
4190 whichever one is last.
4191
4192 .vitem &%-oMaa%&&~<&'name'&>
4193 .oindex "&%-oMaa%&"
4194 .cindex "authentication" "name, specifying for local message"
4195 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4196 option sets the value of &$sender_host_authenticated$& (the authenticator
4197 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4198 This option can be used with &%-bh%& and &%-bs%& to set up an
4199 authenticated SMTP session without actually using the SMTP AUTH command.
4200
4201 .vitem &%-oMai%&&~<&'string'&>
4202 .oindex "&%-oMai%&"
4203 .cindex "authentication" "id, specifying for local message"
4204 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4205 option sets the value of &$authenticated_id$& (the id that was authenticated).
4206 This overrides the default value (the caller's login id, except with &%-bh%&,
4207 where there is no default) for messages from local sources. See chapter
4208 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4209
4210 .vitem &%-oMas%&&~<&'address'&>
4211 .oindex "&%-oMas%&"
4212 .cindex "authentication" "sender, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4214 option sets the authenticated sender value in &$authenticated_sender$&. It
4215 overrides the sender address that is created from the caller's login id for
4216 messages from local sources, except when &%-bh%& is used, when there is no
4217 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4218 specified on a MAIL command overrides this value. See chapter
4219 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4220
4221 .vitem &%-oMi%&&~<&'interface&~address'&>
4222 .oindex "&%-oMi%&"
4223 .cindex "interface" "address, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4225 option sets the IP interface address value. A port number may be included,
4226 using the same syntax as for &%-oMa%&. The interface address is placed in
4227 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4228
4229 .vitem &%-oMr%&&~<&'protocol&~name'&>
4230 .oindex "&%-oMr%&"
4231 .cindex "protocol, specifying for local message"
4232 .vindex "&$received_protocol$&"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4234 option sets the received protocol value that is stored in
4235 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4236 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4237 SMTP protocol names (see the description of &$received_protocol$& in section
4238 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4239 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4240 be set by &%-oMr%&.
4241
4242 .vitem &%-oMs%&&~<&'host&~name'&>
4243 .oindex "&%-oMs%&"
4244 .cindex "sender" "host name, specifying for local message"
4245 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4246 option sets the sender host name in &$sender_host_name$&. When this option is
4247 present, Exim does not attempt to look up a host name from an IP address; it
4248 uses the name it is given.
4249
4250 .vitem &%-oMt%&&~<&'ident&~string'&>
4251 .oindex "&%-oMt%&"
4252 .cindex "sender" "ident string, specifying for local message"
4253 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4254 option sets the sender ident value in &$sender_ident$&. The default setting for
4255 local callers is the login id of the calling process, except when &%-bh%& is
4256 used, when there is no default.
4257
4258 .vitem &%-om%&
4259 .oindex "&%-om%&"
4260 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4261 In Sendmail, this option means &"me too"&, indicating that the sender of a
4262 message should receive a copy of the message if the sender appears in an alias
4263 expansion. Exim always does this, so the option does nothing.
4264
4265 .vitem &%-oo%&
4266 .oindex "&%-oo%&"
4267 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4268 This option is ignored. In Sendmail it specifies &"old style headers"&,
4269 whatever that means.
4270
4271 .vitem &%-oP%&&~<&'path'&>
4272 .oindex "&%-oP%&"
4273 .cindex "pid (process id)" "of daemon"
4274 .cindex "daemon" "process id (pid)"
4275 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4276 value. The option specifies the file to which the process id of the daemon is
4277 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4278 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4279 because in those cases, the normal pid file is not used.
4280
4281 .vitem &%-or%&&~<&'time'&>
4282 .oindex "&%-or%&"
4283 .cindex "timeout" "for non-SMTP input"
4284 This option sets a timeout value for incoming non-SMTP messages. If it is not
4285 set, Exim will wait forever for the standard input. The value can also be set
4286 by the &%receive_timeout%& option. The format used for specifying times is
4287 described in section &<<SECTtimeformat>>&.
4288
4289 .vitem &%-os%&&~<&'time'&>
4290 .oindex "&%-os%&"
4291 .cindex "timeout" "for SMTP input"
4292 .cindex "SMTP" "input timeout"
4293 This option sets a timeout value for incoming SMTP messages. The timeout
4294 applies to each SMTP command and block of data. The value can also be set by
4295 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4296 for specifying times is described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-ov%&
4299 .oindex "&%-ov%&"
4300 This option has exactly the same effect as &%-v%&.
4301
4302 .vitem &%-oX%&&~<&'number&~or&~string'&>
4303 .oindex "&%-oX%&"
4304 .cindex "TCP/IP" "setting listening ports"
4305 .cindex "TCP/IP" "setting listening interfaces"
4306 .cindex "port" "receiving TCP/IP"
4307 This option is relevant only when the &%-bd%& (start listening daemon) option
4308 is also given. It controls which ports and interfaces the daemon uses. Details
4309 of the syntax, and how it interacts with configuration file options, are given
4310 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4311 file is written unless &%-oP%& is also present to specify a pid file name.
4312
4313 .vitem &%-pd%&
4314 .oindex "&%-pd%&"
4315 .cindex "Perl" "starting the interpreter"
4316 This option applies when an embedded Perl interpreter is linked with Exim (see
4317 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4318 option, forcing the starting of the interpreter to be delayed until it is
4319 needed.
4320
4321 .vitem &%-ps%&
4322 .oindex "&%-ps%&"
4323 .cindex "Perl" "starting the interpreter"
4324 This option applies when an embedded Perl interpreter is linked with Exim (see
4325 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4326 option, forcing the starting of the interpreter to occur as soon as Exim is
4327 started.
4328
4329 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4330 .oindex "&%-p%&"
4331 For compatibility with Sendmail, this option is equivalent to
4332 .display
4333 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4334 .endd
4335 It sets the incoming protocol and host name (for trusted callers). The
4336 host name and its colon can be omitted when only the protocol is to be set.
4337 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4338 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4339 or &`s`& using this option (but that does not seem a real limitation).
4340
4341 .vitem &%-q%&
4342 .oindex "&%-q%&"
4343 .cindex "queue runner" "starting manually"
4344 This option is normally restricted to admin users. However, there is a
4345 configuration option called &%prod_requires_admin%& which can be set false to
4346 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4347 and &%-S%& options).
4348
4349 .cindex "queue runner" "description of operation"
4350 The &%-q%& option starts one queue runner process. This scans the queue of
4351 waiting messages, and runs a delivery process for each one in turn. It waits
4352 for each delivery process to finish before starting the next one. A delivery
4353 process may not actually do any deliveries if the retry times for the addresses
4354 have not been reached. Use &%-qf%& (see below) if you want to override this.
4355
4356 If
4357 .cindex "SMTP" "passed connection"
4358 .cindex "SMTP" "multiple deliveries"
4359 .cindex "multiple SMTP deliveries"
4360 the delivery process spawns other processes to deliver other messages down
4361 passed SMTP connections, the queue runner waits for these to finish before
4362 proceeding.
4363
4364 When all the queued messages have been considered, the original queue runner
4365 process terminates. In other words, a single pass is made over the waiting
4366 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4367 this to be repeated periodically.
4368
4369 Exim processes the waiting messages in an unpredictable order. It isn't very
4370 random, but it is likely to be different each time, which is all that matters.
4371 If one particular message screws up a remote MTA, other messages to the same
4372 MTA have a chance of getting through if they get tried first.
4373
4374 It is possible to cause the messages to be processed in lexical message id
4375 order, which is essentially the order in which they arrived, by setting the
4376 &%queue_run_in_order%& option, but this is not recommended for normal use.
4377
4378 .vitem &%-q%&<&'qflags'&>
4379 The &%-q%& option may be followed by one or more flag letters that change its
4380 behaviour. They are all optional, but if more than one is present, they must
4381 appear in the correct order. Each flag is described in a separate item below.
4382
4383 .vitem &%-qq...%&
4384 .oindex "&%-qq%&"
4385 .cindex "queue" "double scanning"
4386 .cindex "queue" "routing"
4387 .cindex "routing" "whole queue before delivery"
4388 An option starting with &%-qq%& requests a two-stage queue run. In the first
4389 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4390 every domain. Addresses are routed, local deliveries happen, but no remote
4391 transports are run.
4392
4393 .cindex "hints database" "remembering routing"
4394 The hints database that remembers which messages are waiting for specific hosts
4395 is updated, as if delivery to those hosts had been deferred. After this is
4396 complete, a second, normal queue scan happens, with routing and delivery taking
4397 place as normal. Messages that are routed to the same host should mostly be
4398 delivered down a single SMTP
4399 .cindex "SMTP" "passed connection"
4400 .cindex "SMTP" "multiple deliveries"
4401 .cindex "multiple SMTP deliveries"
4402 connection because of the hints that were set up during the first queue scan.
4403 This option may be useful for hosts that are connected to the Internet
4404 intermittently.
4405
4406 .vitem &%-q[q]i...%&
4407 .oindex "&%-qi%&"
4408 .cindex "queue" "initial delivery"
4409 If the &'i'& flag is present, the queue runner runs delivery processes only for
4410 those messages that haven't previously been tried. (&'i'& stands for &"initial
4411 delivery"&.) This can be helpful if you are putting messages on the queue using
4412 &%-odq%& and want a queue runner just to process the new messages.
4413
4414 .vitem &%-q[q][i]f...%&
4415 .oindex "&%-qf%&"
4416 .cindex "queue" "forcing delivery"
4417 .cindex "delivery" "forcing in queue run"
4418 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4419 message, whereas without &'f'& only those non-frozen addresses that have passed
4420 their retry times are tried.
4421
4422 .vitem &%-q[q][i]ff...%&
4423 .oindex "&%-qff%&"
4424 .cindex "frozen messages" "forcing delivery"
4425 If &'ff'& is present, a delivery attempt is forced for every message, whether
4426 frozen or not.
4427
4428 .vitem &%-q[q][i][f[f]]l%&
4429 .oindex "&%-ql%&"
4430 .cindex "queue" "local deliveries only"
4431 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4432 be done. If a message requires any remote deliveries, it remains on the queue
4433 for later delivery.
4434
4435 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4436 .cindex "queue" "delivering specific messages"
4437 When scanning the queue, Exim can be made to skip over messages whose ids are
4438 lexically less than a given value by following the &%-q%& option with a
4439 starting message id. For example:
4440 .code
4441 exim -q 0t5C6f-0000c8-00
4442 .endd
4443 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4444 second message id is given, messages whose ids are lexically greater than it
4445 are also skipped. If the same id is given twice, for example,
4446 .code
4447 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4448 .endd
4449 just one delivery process is started, for that message. This differs from
4450 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4451 that it counts as a delivery from a queue run. Note that the selection
4452 mechanism does not affect the order in which the messages are scanned. There
4453 are also other ways of selecting specific sets of messages for delivery in a
4454 queue run &-- see &%-R%& and &%-S%&.
4455
4456 .vitem &%-q%&<&'qflags'&><&'time'&>
4457 .cindex "queue runner" "starting periodically"
4458 .cindex "periodic queue running"
4459 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4460 starting a queue runner process at intervals specified by the given time value
4461 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4462 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4463 single daemon process handles both functions. A common way of starting up a
4464 combined daemon at system boot time is to use a command such as
4465 .code
4466 /usr/exim/bin/exim -bd -q30m
4467 .endd
4468 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4469 process every 30 minutes.
4470
4471 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4472 pid file is written unless one is explicitly requested by the &%-oP%& option.
4473
4474 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4475 .oindex "&%-qR%&"
4476 This option is synonymous with &%-R%&. It is provided for Sendmail
4477 compatibility.
4478
4479 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4480 .oindex "&%-qS%&"
4481 This option is synonymous with &%-S%&.
4482
4483 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-R%&"
4485 .cindex "queue runner" "for specific recipients"
4486 .cindex "delivery" "to given domain"
4487 .cindex "domain" "delivery to"
4488 The <&'rsflags'&> may be empty, in which case the white space before the string
4489 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4490 which are the possible values for <&'rsflags'&>. White space is required if
4491 <&'rsflags'&> is not empty.
4492
4493 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4494 perform a single queue run, except that, when scanning the messages on the
4495 queue, Exim processes only those that have at least one undelivered recipient
4496 address containing the given string, which is checked in a case-independent
4497 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4498 regular expression; otherwise it is a literal string.
4499
4500 If you want to do periodic queue runs for messages with specific recipients,
4501 you can combine &%-R%& with &%-q%& and a time value. For example:
4502 .code
4503 exim -q25m -R @special.domain.example
4504 .endd
4505 This example does a queue run for messages with recipients in the given domain
4506 every 25 minutes. Any additional flags that are specified with &%-q%& are
4507 applied to each queue run.
4508
4509 Once a message is selected for delivery by this mechanism, all its addresses
4510 are processed. For the first selected message, Exim overrides any retry
4511 information and forces a delivery attempt for each undelivered address. This
4512 means that if delivery of any address in the first message is successful, any
4513 existing retry information is deleted, and so delivery attempts for that
4514 address in subsequently selected messages (which are processed without forcing)
4515 will run. However, if delivery of any address does not succeed, the retry
4516 information is updated, and in subsequently selected messages, the failing
4517 address will be skipped.
4518
4519 .cindex "frozen messages" "forcing delivery"
4520 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4521 all selected messages, not just the first; frozen messages are included when
4522 &'ff'& is present.
4523
4524 The &%-R%& option makes it straightforward to initiate delivery of all messages
4525 to a given domain after a host has been down for some time. When the SMTP
4526 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4527 effect is to run Exim with the &%-R%& option, but it can be configured to run
4528 an arbitrary command instead.
4529
4530 .vitem &%-r%&
4531 .oindex "&%-r%&"
4532 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4533
4534 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4535 .oindex "&%-S%&"
4536 .cindex "delivery" "from given sender"
4537 .cindex "queue runner" "for specific senders"
4538 This option acts like &%-R%& except that it checks the string against each
4539 message's sender instead of against the recipients. If &%-R%& is also set, both
4540 conditions must be met for a message to be selected. If either of the options
4541 has &'f'& or &'ff'& in its flags, the associated action is taken.
4542
4543 .vitem &%-Tqt%&&~<&'times'&>
4544 .oindex "&%-Tqt%&"
4545 This is an option that is exclusively for use by the Exim testing suite. It is not
4546 recognized when Exim is run normally. It allows for the setting up of explicit
4547 &"queue times"& so that various warning/retry features can be tested.
4548
4549 .vitem &%-t%&
4550 .oindex "&%-t%&"
4551 .cindex "recipient" "extracting from header lines"
4552 .cindex "&'Bcc:'& header line"
4553 .cindex "&'Cc:'& header line"
4554 .cindex "&'To:'& header line"
4555 When Exim is receiving a locally-generated, non-SMTP message on its standard
4556 input, the &%-t%& option causes the recipients of the message to be obtained
4557 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4558 from the command arguments. The addresses are extracted before any rewriting
4559 takes place and the &'Bcc:'& header line, if present, is then removed.
4560
4561 .cindex "Sendmail compatibility" "&%-t%& option"
4562 If the command has any arguments, they specify addresses to which the message
4563 is &'not'& to be delivered. That is, the argument addresses are removed from
4564 the recipients list obtained from the headers. This is compatible with Smail 3
4565 and in accordance with the documented behaviour of several versions of
4566 Sendmail, as described in man pages on a number of operating systems (e.g.
4567 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4568 argument addresses to those obtained from the headers, and the O'Reilly
4569 Sendmail book documents it that way. Exim can be made to add argument addresses
4570 instead of subtracting them by setting the option
4571 &%extract_addresses_remove_arguments%& false.
4572
4573 .cindex "&%Resent-%& header lines" "with &%-t%&"
4574 If there are any &%Resent-%& header lines in the message, Exim extracts
4575 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4576 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4577 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4578 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4579
4580 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4581 message is resent several times). The RFC also specifies that they should be
4582 added at the front of the message, and separated by &'Received:'& lines. It is
4583 not at all clear how &%-t%& should operate in the present of multiple sets,
4584 nor indeed exactly what constitutes a &"set"&.
4585 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4586 are often added at the end of the header, and if a message is resent more than
4587 once, it is common for the original set of &%Resent-%& headers to be renamed as
4588 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4589
4590 .vitem &%-ti%&
4591 .oindex "&%-ti%&"
4592 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4593 compatibility with Sendmail.
4594
4595 .vitem &%-tls-on-connect%&
4596 .oindex "&%-tls-on-connect%&"
4597 .cindex "TLS" "use without STARTTLS"
4598 .cindex "TLS" "automatic start"
4599 This option is available when Exim is compiled with TLS support. It forces all
4600 incoming SMTP connections to behave as if the incoming port is listed in the
4601 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4602 &<<CHAPTLS>>& for further details.
4603
4604
4605 .vitem &%-U%&
4606 .oindex "&%-U%&"
4607 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4608 Sendmail uses this option for &"initial message submission"&, and its
4609 documentation states that in future releases, it may complain about
4610 syntactically invalid messages rather than fixing them when this flag is not
4611 set. Exim ignores this option.
4612
4613 .vitem &%-v%&
4614 .oindex "&%-v%&"
4615 This option causes Exim to write information to the standard error stream,
4616 describing what it is doing. In particular, it shows the log lines for
4617 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4618 dialogue is shown. Some of the log lines shown may not actually be written to
4619 the log if the setting of &%log_selector%& discards them. Any relevant
4620 selectors are shown with each log line. If none are shown, the logging is
4621 unconditional.
4622
4623 .vitem &%-x%&
4624 .oindex "&%-x%&"
4625 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4626 National Language Support extended characters in the body of the mail item"&).
4627 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4628 this option.
4629
4630 .new
4631 .vitem &%-X%&&~<&'logfile'&>
4632 .oindex "&%-X%&"
4633 This option is interpreted by Sendmail to cause debug information to be sent
4634 to the named file.  It is ignored by Exim.
4635 .wen
4636 .endlist
4637
4638 .ecindex IIDclo1
4639 .ecindex IIDclo2
4640
4641
4642 . ////////////////////////////////////////////////////////////////////////////
4643 . Insert a stylized DocBook comment here, to identify the end of the command
4644 . line options. This is for the benefit of the Perl script that automatically
4645 . creates a man page for the options.
4646 . ////////////////////////////////////////////////////////////////////////////
4647
4648 .literal xml
4649 <!-- === End of command line options === -->
4650 .literal off
4651
4652
4653
4654
4655
4656 . ////////////////////////////////////////////////////////////////////////////
4657 . ////////////////////////////////////////////////////////////////////////////
4658
4659
4660 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4661          "The runtime configuration file"
4662
4663 .cindex "run time configuration"
4664 .cindex "configuration file" "general description"
4665 .cindex "CONFIGURE_FILE"
4666 .cindex "configuration file" "errors in"
4667 .cindex "error" "in configuration file"
4668 .cindex "return code" "for bad configuration"
4669 Exim uses a single run time configuration file that is read whenever an Exim
4670 binary is executed. Note that in normal operation, this happens frequently,
4671 because Exim is designed to operate in a distributed manner, without central
4672 control.
4673
4674 If a syntax error is detected while reading the configuration file, Exim
4675 writes a message on the standard error, and exits with a non-zero return code.
4676 The message is also written to the panic log. &*Note*&: Only simple syntax
4677 errors can be detected at this time. The values of any expanded options are
4678 not checked until the expansion happens, even when the expansion does not
4679 actually alter the string.
4680
4681 The name of the configuration file is compiled into the binary for security
4682 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4683 most configurations, this specifies a single file. However, it is permitted to
4684 give a colon-separated list of file names, in which case Exim uses the first
4685 existing file in the list.
4686
4687 .cindex "EXIM_USER"
4688 .cindex "EXIM_GROUP"
4689 .cindex "CONFIGURE_OWNER"
4690 .cindex "CONFIGURE_GROUP"
4691 .cindex "configuration file" "ownership"
4692 .cindex "ownership" "configuration file"
4693 The run time configuration file must be owned by root or by the user that is
4694 specified at compile time by the CONFIGURE_OWNER option (if set). The
4695 configuration file must not be world-writeable, or group-writeable unless its
4696 group is the root group or the one specified at compile time by the
4697 CONFIGURE_GROUP option.
4698
4699 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4700 to root, anybody who is able to edit the run time configuration file has an
4701 easy way to run commands as root. If you specify a user or group in the
4702 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4703 who are members of that group will trivially be able to obtain root privileges.
4704
4705 Up to Exim version 4.72, the run time configuration file was also permitted to
4706 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4707 since it offered a simple privilege escalation for any attacker who managed to
4708 compromise the Exim user account.
4709
4710 A default configuration file, which will work correctly in simple situations,
4711 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4712 defines just one file name, the installation process copies the default
4713 configuration to a new file of that name if it did not previously exist. If
4714 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4715 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4716 configuration.
4717
4718
4719
4720 .section "Using a different configuration file" "SECID40"
4721 .cindex "configuration file" "alternate"
4722 A one-off alternate configuration can be specified by the &%-C%& command line
4723 option, which may specify a single file or a list of files. However, when
4724 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4725 unless the argument for &%-C%& is identical to the built-in value from
4726 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4727 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4728 is useful mainly for checking the syntax of configuration files before
4729 installing them. No owner or group checks are done on a configuration file
4730 specified by &%-C%&, if root privilege has been dropped.
4731
4732 Even the Exim user is not trusted to specify an arbitrary configuration file
4733 with the &%-C%& option to be used with root privileges, unless that file is
4734 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4735 testing a configuration using &%-C%& right through message reception and
4736 delivery, even if the caller is root. The reception works, but by that time,
4737 Exim is running as the Exim user, so when it re-execs to regain privilege for
4738 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4739 can test reception and delivery using two separate commands (one to put a
4740 message on the queue, using &%-odq%&, and another to do the delivery, using
4741 &%-M%&).
4742
4743 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4744 prefix string with which any file named in a &%-C%& command line option must
4745 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4746 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4747 name can be used with &%-C%&.
4748
4749 One-off changes to a configuration can be specified by the &%-D%& command line
4750 option, which defines and overrides values for macros used inside the
4751 configuration file. However, like &%-C%&, the use of this option by a
4752 non-privileged user causes Exim to discard its root privilege.
4753 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4754 completely disabled, and its use causes an immediate error exit.
4755
4756 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4757 to declare certain macro names trusted, such that root privilege will not
4758 necessarily be discarded.
4759 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4760 considered safe and, if &%-D%& only supplies macros from this list, and the
4761 values are acceptable, then Exim will not give up root privilege if the caller
4762 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4763 transition mechanism and is expected to be removed in the future.  Acceptable
4764 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4765
4766 Some sites may wish to use the same Exim binary on different machines that
4767 share a file system, but to use different configuration files on each machine.
4768 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4769 looks for a file whose name is the configuration file name followed by a dot
4770 and the machine's node name, as obtained from the &[uname()]& function. If this
4771 file does not exist, the standard name is tried. This processing occurs for
4772 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4773
4774 In some esoteric situations different versions of Exim may be run under
4775 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4776 help with this. See the comments in &_src/EDITME_& for details.
4777
4778
4779
4780 .section "Configuration file format" "SECTconffilfor"
4781 .cindex "configuration file" "format of"
4782 .cindex "format" "configuration file"
4783 Exim's configuration file is divided into a number of different parts. General
4784 option settings must always appear at the start of the file. The other parts
4785 are all optional, and may appear in any order. Each part other than the first
4786 is introduced by the word &"begin"& followed by the name of the part. The
4787 optional parts are:
4788
4789 .ilist
4790 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4791 &<<CHAPACL>>&).
4792 .next
4793 .cindex "AUTH" "configuration"
4794 &'authenticators'&: Configuration settings for the authenticator drivers. These
4795 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4796 .next
4797 &'routers'&: Configuration settings for the router drivers. Routers process
4798 addresses and determine how the message is to be delivered (see chapters
4799 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4800 .next
4801 &'transports'&: Configuration settings for the transport drivers. Transports
4802 define mechanisms for copying messages to destinations (see chapters
4803 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4804 .next
4805 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4806 If there is no retry section, or if it is empty (that is, no retry rules are
4807 defined), Exim will not retry deliveries. In this situation, temporary errors
4808 are treated the same as permanent errors. Retry rules are discussed in chapter
4809 &<<CHAPretry>>&.
4810 .next
4811 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4812 when new addresses are generated during delivery. Rewriting is discussed in
4813 chapter &<<CHAPrewrite>>&.
4814 .next
4815 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4816 want to use this feature, you must set
4817 .code
4818 LOCAL_SCAN_HAS_OPTIONS=yes
4819 .endd
4820 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4821 facility are given in chapter &<<CHAPlocalscan>>&.
4822 .endlist
4823
4824 .cindex "configuration file" "leading white space in"
4825 .cindex "configuration file" "trailing white space in"
4826 .cindex "white space" "in configuration file"
4827 Leading and trailing white space in configuration lines is always ignored.
4828
4829 Blank lines in the file, and lines starting with a # character (ignoring
4830 leading white space) are treated as comments and are ignored. &*Note*&: A
4831 # character other than at the beginning of a line is not treated specially,
4832 and does not introduce a comment.
4833
4834 Any non-comment line can be continued by ending it with a backslash. Note that
4835 the general rule for white space means that trailing white space after the
4836 backslash and leading white space at the start of continuation
4837 lines is ignored. Comment lines beginning with # (but not empty lines) may
4838 appear in the middle of a sequence of continuation lines.
4839
4840 A convenient way to create a configuration file is to start from the
4841 default, which is supplied in &_src/configure.default_&, and add, delete, or
4842 change settings as required.
4843
4844 The ACLs, retry rules, and rewriting rules have their own syntax which is
4845 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4846 respectively. The other parts of the configuration file have some syntactic
4847 items in common, and these are described below, from section &<<SECTcos>>&
4848 onwards. Before that, the inclusion, macro, and conditional facilities are
4849 described.
4850
4851
4852
4853 .section "File inclusions in the configuration file" "SECID41"
4854 .cindex "inclusions in configuration file"
4855 .cindex "configuration file" "including other files"
4856 .cindex "&`.include`& in configuration file"
4857 .cindex "&`.include_if_exists`& in configuration file"
4858 You can include other files inside Exim's run time configuration file by
4859 using this syntax:
4860 .display
4861 &`.include`& <&'file name'&>
4862 &`.include_if_exists`& <&'file name'&>
4863 .endd
4864 on a line by itself. Double quotes round the file name are optional. If you use
4865 the first form, a configuration error occurs if the file does not exist; the
4866 second form does nothing for non-existent files. In all cases, an absolute file
4867 name is required.
4868
4869 Includes may be nested to any depth, but remember that Exim reads its
4870 configuration file often, so it is a good idea to keep them to a minimum.
4871 If you change the contents of an included file, you must HUP the daemon,
4872 because an included file is read only when the configuration itself is read.
4873
4874 The processing of inclusions happens early, at a physical line level, so, like
4875 comment lines, an inclusion can be used in the middle of an option setting,
4876 for example:
4877 .code
4878 hosts_lookup = a.b.c \
4879                .include /some/file
4880 .endd
4881 Include processing happens after macro processing (see below). Its effect is to
4882 process the lines of the included file as if they occurred inline where the
4883 inclusion appears.
4884
4885
4886
4887 .section "Macros in the configuration file" "SECTmacrodefs"
4888 .cindex "macro" "description of"
4889 .cindex "configuration file" "macros"
4890 If a line in the main part of the configuration (that is, before the first
4891 &"begin"& line) begins with an upper case letter, it is taken as a macro
4892 definition, and must be of the form
4893 .display
4894 <&'name'&> = <&'rest of line'&>
4895 .endd
4896 The name must consist of letters, digits, and underscores, and need not all be
4897 in upper case, though that is recommended. The rest of the line, including any
4898 continuations, is the replacement text, and has leading and trailing white
4899 space removed. Quotes are not removed. The replacement text can never end with
4900 a backslash character, but this doesn't seem to be a serious limitation.
4901
4902 Macros may also be defined between router, transport, authenticator, or ACL
4903 definitions. They may not, however, be defined within an individual driver or
4904 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4905
4906 .section "Macro substitution" "SECID42"
4907 Once a macro is defined, all subsequent lines in the file (and any included
4908 files) are scanned for the macro name; if there are several macros, the line is
4909 scanned for each in turn, in the order in which the macros are defined. The
4910 replacement text is not re-scanned for the current macro, though it is scanned
4911 for subsequently defined macros. For this reason, a macro name may not contain
4912 the name of a previously defined macro as a substring. You could, for example,
4913 define
4914 .display
4915 &`ABCD_XYZ = `&<&'something'&>
4916 &`ABCD = `&<&'something else'&>
4917 .endd
4918 but putting the definitions in the opposite order would provoke a configuration
4919 error. Macro expansion is applied to individual physical lines from the file,
4920 before checking for line continuation or file inclusion (see above). If a line
4921 consists solely of a macro name, and the expansion of the macro is empty, the
4922 line is ignored. A macro at the start of a line may turn the line into a
4923 comment line or a &`.include`& line.
4924
4925
4926 .section "Redefining macros" "SECID43"
4927 Once defined, the value of a macro can be redefined later in the configuration
4928 (or in an included file). Redefinition is specified by using &'=='& instead of
4929 &'='&. For example:
4930 .code
4931 MAC =  initial value
4932 ...
4933 MAC == updated value
4934 .endd
4935 Redefinition does not alter the order in which the macros are applied to the
4936 subsequent lines of the configuration file. It is still the same order in which
4937 the macros were originally defined. All that changes is the macro's value.
4938 Redefinition makes it possible to accumulate values. For example:
4939 .code
4940 MAC =  initial value
4941 ...
4942 MAC == MAC and something added
4943 .endd
4944 This can be helpful in situations where the configuration file is built
4945 from a number of other files.
4946
4947 .section "Overriding macro values" "SECID44"
4948 The values set for macros in the configuration file can be overridden by the
4949 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4950 used, unless called by root or the Exim user. A definition on the command line
4951 using the &%-D%& option causes all definitions and redefinitions within the
4952 file to be ignored.
4953
4954
4955
4956 .section "Example of macro usage" "SECID45"
4957 As an example of macro usage, consider a configuration where aliases are looked
4958 up in a MySQL database. It helps to keep the file less cluttered if long
4959 strings such as SQL statements are defined separately as macros, for example:
4960 .code
4961 ALIAS_QUERY = select mailbox from user where \
4962               login='${quote_mysql:$local_part}';
4963 .endd
4964 This can then be used in a &(redirect)& router setting like this:
4965 .code
4966 data = ${lookup mysql{ALIAS_QUERY}}
4967 .endd
4968 In earlier versions of Exim macros were sometimes used for domain, host, or
4969 address lists. In Exim 4 these are handled better by named lists &-- see
4970 section &<<SECTnamedlists>>&.
4971
4972
4973 .section "Conditional skips in the configuration file" "SECID46"
4974 .cindex "configuration file" "conditional skips"
4975 .cindex "&`.ifdef`&"
4976 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4977 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4978 portions of the configuration file. The processing happens whenever the file is
4979 read (that is, when an Exim binary starts to run).
4980
4981 The implementation is very simple. Instances of the first four directives must
4982 be followed by text that includes the names of one or macros. The condition
4983 that is tested is whether or not any macro substitution has taken place in the
4984 line. Thus:
4985 .code
4986 .ifdef AAA
4987 message_size_limit = 50M
4988 .else
4989 message_size_limit = 100M
4990 .endif
4991 .endd
4992 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4993 otherwise. If there is more than one macro named on the line, the condition
4994 is true if any of them are defined. That is, it is an &"or"& condition. To
4995 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4996
4997 Although you can use a macro expansion to generate one of these directives,
4998 it is not very useful, because the condition &"there was a macro substitution
4999 in this line"& will always be true.
5000
5001 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5002 to clarify complicated nestings.
5003
5004
5005
5006 .section "Common option syntax" "SECTcos"
5007 .cindex "common option syntax"
5008 .cindex "syntax of common options"
5009 .cindex "configuration file" "common option syntax"
5010 For the main set of options, driver options, and &[local_scan()]& options,
5011 each setting is on a line by itself, and starts with a name consisting of
5012 lower-case letters and underscores. Many options require a data value, and in
5013 these cases the name must be followed by an equals sign (with optional white
5014 space) and then the value. For example:
5015 .code
5016 qualify_domain = mydomain.example.com
5017 .endd
5018 .cindex "hiding configuration option values"
5019 .cindex "configuration options" "hiding value of"
5020 .cindex "options" "hiding value of"
5021 Some option settings may contain sensitive data, for example, passwords for
5022 accessing databases. To stop non-admin users from using the &%-bP%& command
5023 line option to read these values, you can precede the option settings with the
5024 word &"hide"&. For example:
5025 .code
5026 hide mysql_servers = localhost/users/admin/secret-password
5027 .endd
5028 For non-admin users, such options are displayed like this:
5029 .code
5030 mysql_servers = <value not displayable>
5031 .endd
5032 If &"hide"& is used on a driver option, it hides the value of that option on
5033 all instances of the same driver.
5034
5035 The following sections describe the syntax used for the different data types
5036 that are found in option settings.
5037
5038
5039 .section "Boolean options" "SECID47"
5040 .cindex "format" "boolean"
5041 .cindex "boolean configuration values"
5042 .oindex "&%no_%&&'xxx'&"
5043 .oindex "&%not_%&&'xxx'&"
5044 Options whose type is given as boolean are on/off switches. There are two
5045 different ways of specifying such options: with and without a data value. If
5046 the option name is specified on its own without data, the switch is turned on;
5047 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5048 boolean options may be followed by an equals sign and one of the words
5049 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5050 the following two settings have exactly the same effect:
5051 .code
5052 queue_only
5053 queue_only = true
5054 .endd
5055 The following two lines also have the same (opposite) effect:
5056 .code
5057 no_queue_only
5058 queue_only = false
5059 .endd
5060 You can use whichever syntax you prefer.
5061
5062
5063
5064
5065 .section "Integer values" "SECID48"
5066 .cindex "integer configuration values"
5067 .cindex "format" "integer"
5068 If an option's type is given as &"integer"&, the value can be given in decimal,
5069 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5070 number is assumed. Otherwise, it is treated as an octal number unless it starts
5071 with the characters &"0x"&, in which case the remainder is interpreted as a
5072 hexadecimal number.
5073
5074 If an integer value is followed by the letter K, it is multiplied by 1024; if
5075 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5076 of integer option settings are output, values which are an exact multiple of
5077 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5078 and M. The printing style is independent of the actual input format that was
5079 used.
5080
5081
5082 .section "Octal integer values" "SECID49"
5083 .cindex "integer format"
5084 .cindex "format" "octal integer"
5085 If an option's type is given as &"octal integer"&, its value is always
5086 interpreted as an octal number, whether or not it starts with the digit zero.
5087 Such options are always output in octal.
5088
5089
5090 .section "Fixed point numbers" "SECID50"
5091 .cindex "fixed point configuration values"
5092 .cindex "format" "fixed point"
5093 If an option's type is given as &"fixed-point"&, its value must be a decimal
5094 integer, optionally followed by a decimal point and up to three further digits.
5095
5096
5097
5098 .section "Time intervals" "SECTtimeformat"
5099 .cindex "time interval" "specifying in configuration"
5100 .cindex "format" "time interval"
5101 A time interval is specified as a sequence of numbers, each followed by one of
5102 the following letters, with no intervening white space:
5103
5104 .table2 30pt
5105 .irow &%s%& seconds
5106 .irow &%m%& minutes
5107 .irow &%h%& hours
5108 .irow &%d%& days
5109 .irow &%w%& weeks
5110 .endtable
5111
5112 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5113 intervals are output in the same format. Exim does not restrict the values; it
5114 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5115
5116
5117
5118 .section "String values" "SECTstrings"
5119 .cindex "string" "format of configuration values"
5120 .cindex "format" "string"
5121 If an option's type is specified as &"string"&, the value can be specified with
5122 or without double-quotes. If it does not start with a double-quote, the value
5123 consists of the remainder of the line plus any continuation lines, starting at
5124 the first character after any leading white space, with trailing white space
5125 removed, and with no interpretation of the characters in the string. Because
5126 Exim removes comment lines (those beginning with #) at an early stage, they can
5127 appear in the middle of a multi-line string. The following two settings are
5128 therefore equivalent:
5129 .code
5130 trusted_users = uucp:mail
5131 trusted_users = uucp:\
5132                 # This comment line is ignored
5133                 mail
5134 .endd
5135 .cindex "string" "quoted"
5136 .cindex "escape characters in quoted strings"
5137 If a string does start with a double-quote, it must end with a closing
5138 double-quote, and any backslash characters other than those used for line
5139 continuation are interpreted as escape characters, as follows:
5140
5141 .table2 100pt
5142 .irow &`\\`&                     "single backslash"
5143 .irow &`\n`&                     "newline"
5144 .irow &`\r`&                     "carriage return"
5145 .irow &`\t`&                     "tab"
5146 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5147 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5148                                    character"
5149 .endtable
5150
5151 If a backslash is followed by some other character, including a double-quote
5152 character, that character replaces the pair.
5153
5154 Quoting is necessary only if you want to make use of the backslash escapes to
5155 insert special characters, or if you need to specify a value with leading or
5156 trailing spaces. These cases are rare, so quoting is almost never needed in
5157 current versions of Exim. In versions of Exim before 3.14, quoting was required
5158 in order to continue lines, so you may come across older configuration files
5159 and examples that apparently quote unnecessarily.
5160
5161
5162 .section "Expanded strings" "SECID51"
5163 .cindex "expansion" "definition of"
5164 Some strings in the configuration file are subjected to &'string expansion'&,
5165 by which means various parts of the string may be changed according to the
5166 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5167 is as just described; in particular, the handling of backslashes in quoted
5168 strings is done as part of the input process, before expansion takes place.
5169 However, backslash is also an escape character for the expander, so any
5170 backslashes that are required for that reason must be doubled if they are
5171 within a quoted configuration string.
5172
5173
5174 .section "User and group names" "SECID52"
5175 .cindex "user name" "format of"
5176 .cindex "format" "user name"
5177 .cindex "groups" "name format"
5178 .cindex "format" "group name"
5179 User and group names are specified as strings, using the syntax described
5180 above, but the strings are interpreted specially. A user or group name must
5181 either consist entirely of digits, or be a name that can be looked up using the
5182 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5183
5184
5185 .section "List construction" "SECTlistconstruct"
5186 .cindex "list" "syntax of in configuration"
5187 .cindex "format" "list item in configuration"
5188 .cindex "string" "list, definition of"
5189 The data for some configuration options is a list of items, with colon as the
5190 default separator. Many of these options are shown with type &"string list"& in
5191 the descriptions later in this document. Others are listed as &"domain list"&,
5192 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5193 are all the same; however, those other than &"string list"& are subject to
5194 particular kinds of interpretation, as described in chapter
5195 &<<CHAPdomhosaddlists>>&.
5196
5197 In all these cases, the entire list is treated as a single string as far as the
5198 input syntax is concerned. The &%trusted_users%& setting in section
5199 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5200 in a list, it must be entered as two colons. Leading and trailing white space
5201 on each item in a list is ignored. This makes it possible to include items that
5202 start with a colon, and in particular, certain forms of IPv6 address. For
5203 example, the list
5204 .code
5205 local_interfaces = 127.0.0.1 : ::::1
5206 .endd
5207 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5208
5209 &*Note*&: Although leading and trailing white space is ignored in individual
5210 list items, it is not ignored when parsing the list. The space after the first
5211 colon in the example above is necessary. If it were not there, the list would
5212 be interpreted as the two items 127.0.0.1:: and 1.
5213
5214 .section "Changing list separators" "SECID53"
5215 .cindex "list separator" "changing"
5216 .cindex "IPv6" "addresses in lists"
5217 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5218 introduced to allow the separator character to be changed. If a list begins
5219 with a left angle bracket, followed by any punctuation character, that
5220 character is used instead of colon as the list separator. For example, the list
5221 above can be rewritten to use a semicolon separator like this:
5222 .code
5223 local_interfaces = <; 127.0.0.1 ; ::1
5224 .endd
5225 This facility applies to all lists, with the exception of the list in
5226 &%log_file_path%&. It is recommended that the use of non-colon separators be
5227 confined to circumstances where they really are needed.
5228
5229 .cindex "list separator" "newline as"
5230 .cindex "newline" "as list separator"
5231 It is also possible to use newline and other control characters (those with
5232 code values less than 32, plus DEL) as separators in lists. Such separators
5233 must be provided literally at the time the list is processed. For options that
5234 are string-expanded, you can write the separator using a normal escape
5235 sequence. This will be processed by the expander before the string is
5236 interpreted as a list. For example, if a newline-separated list of domains is
5237 generated by a lookup, you can process it directly by a line such as this:
5238 .code
5239 domains = <\n ${lookup mysql{.....}}
5240 .endd
5241 This avoids having to change the list separator in such data. You are unlikely
5242 to want to use a control character as a separator in an option that is not
5243 expanded, because the value is literal text. However, it can be done by giving
5244 the value in quotes. For example:
5245 .code
5246 local_interfaces = "<\n 127.0.0.1 \n ::1"
5247 .endd
5248 Unlike printing character separators, which can be included in list items by
5249 doubling, it is not possible to include a control character as data when it is
5250 set as the separator. Two such characters in succession are interpreted as
5251 enclosing an empty list item.
5252
5253
5254
5255 .section "Empty items in lists" "SECTempitelis"
5256 .cindex "list" "empty item in"
5257 An empty item at the end of a list is always ignored. In other words, trailing
5258 separator characters are ignored. Thus, the list in
5259 .code
5260 senders = user@domain :
5261 .endd
5262 contains only a single item. If you want to include an empty string as one item
5263 in a list, it must not be the last item. For example, this list contains three
5264 items, the second of which is empty:
5265 .code
5266 senders = user1@domain : : user2@domain
5267 .endd
5268 &*Note*&: There must be white space between the two colons, as otherwise they
5269 are interpreted as representing a single colon data character (and the list
5270 would then contain just one item). If you want to specify a list that contains
5271 just one, empty item, you can do it as in this example:
5272 .code
5273 senders = :
5274 .endd
5275 In this case, the first item is empty, and the second is discarded because it
5276 is at the end of the list.
5277
5278
5279
5280
5281 .section "Format of driver configurations" "SECTfordricon"
5282 .cindex "drivers" "configuration format"
5283 There are separate parts in the configuration for defining routers, transports,
5284 and authenticators. In each part, you are defining a number of driver
5285 instances, each with its own set of options. Each driver instance is defined by
5286 a sequence of lines like this:
5287 .display
5288 <&'instance name'&>:
5289   <&'option'&>
5290   ...
5291   <&'option'&>
5292 .endd
5293 In the following example, the instance name is &(localuser)&, and it is
5294 followed by three options settings:
5295 .code
5296 localuser:
5297   driver = accept
5298   check_local_user
5299   transport = local_delivery
5300 .endd
5301 For each driver instance, you specify which Exim code module it uses &-- by the
5302 setting of the &%driver%& option &-- and (optionally) some configuration
5303 settings. For example, in the case of transports, if you want a transport to
5304 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5305 a local file you would use the &(appendfile)& driver. Each of the drivers is
5306 described in detail in its own separate chapter later in this manual.
5307
5308 You can have several routers, transports, or authenticators that are based on
5309 the same underlying driver (each must have a different instance name).
5310
5311 The order in which routers are defined is important, because addresses are
5312 passed to individual routers one by one, in order. The order in which
5313 transports are defined does not matter at all. The order in which
5314 authenticators are defined is used only when Exim, as a client, is searching
5315 them to find one that matches an authentication mechanism offered by the
5316 server.
5317
5318 .cindex "generic options"
5319 .cindex "options" "generic &-- definition of"
5320 Within a driver instance definition, there are two kinds of option: &'generic'&
5321 and &'private'&. The generic options are those that apply to all drivers of the
5322 same type (that is, all routers, all transports or all authenticators). The
5323 &%driver%& option is a generic option that must appear in every definition.
5324 .cindex "private options"
5325 The private options are special for each driver, and none need appear, because
5326 they all have default values.
5327
5328 The options may appear in any order, except that the &%driver%& option must
5329 precede any private options, since these depend on the particular driver. For
5330 this reason, it is recommended that &%driver%& always be the first option.
5331
5332 Driver instance names, which are used for reference in log entries and
5333 elsewhere, can be any sequence of letters, digits, and underscores (starting
5334 with a letter) and must be unique among drivers of the same type. A router and
5335 a transport (for example) can each have the same name, but no two router
5336 instances can have the same name. The name of a driver instance should not be
5337 confused with the name of the underlying driver module. For example, the
5338 configuration lines:
5339 .code
5340 remote_smtp:
5341   driver = smtp
5342 .endd
5343 create an instance of the &(smtp)& transport driver whose name is
5344 &(remote_smtp)&. The same driver code can be used more than once, with
5345 different instance names and different option settings each time. A second
5346 instance of the &(smtp)& transport, with different options, might be defined
5347 thus:
5348 .code
5349 special_smtp:
5350   driver = smtp
5351   port = 1234
5352   command_timeout = 10s
5353 .endd
5354 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5355 these transport instances from routers, and these names would appear in log
5356 lines.
5357
5358 Comment lines may be present in the middle of driver specifications. The full
5359 list of option settings for any particular driver instance, including all the
5360 defaulted values, can be extracted by making use of the &%-bP%& command line
5361 option.
5362
5363
5364
5365
5366
5367
5368 . ////////////////////////////////////////////////////////////////////////////
5369 . ////////////////////////////////////////////////////////////////////////////
5370
5371 .chapter "The default configuration file" "CHAPdefconfil"
5372 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5373 .cindex "default" "configuration file &""walk through""&"
5374 The default configuration file supplied with Exim as &_src/configure.default_&
5375 is sufficient for a host with simple mail requirements. As an introduction to
5376 the way Exim is configured, this chapter &"walks through"& the default
5377 configuration, giving brief explanations of the settings. Detailed descriptions
5378 of the options are given in subsequent chapters. The default configuration file
5379 itself contains extensive comments about ways you might want to modify the
5380 initial settings. However, note that there are many options that are not
5381 mentioned at all in the default configuration.
5382
5383
5384
5385 .section "Main configuration settings" "SECTdefconfmain"
5386 The main (global) configuration option settings must always come first in the
5387 file. The first thing you'll see in the file, after some initial comments, is
5388 the line
5389 .code
5390 # primary_hostname =
5391 .endd
5392 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5393 to know the official, fully qualified name of your host, and this is where you
5394 can specify it. However, in most cases you do not need to set this option. When
5395 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5396
5397 The first three non-comment configuration lines are as follows:
5398 .code
5399 domainlist local_domains    = @
5400 domainlist relay_to_domains =
5401 hostlist   relay_from_hosts = 127.0.0.1
5402 .endd
5403 These are not, in fact, option settings. They are definitions of two named
5404 domain lists and one named host list. Exim allows you to give names to lists of
5405 domains, hosts, and email addresses, in order to make it easier to manage the
5406 configuration file (see section &<<SECTnamedlists>>&).
5407
5408 The first line defines a domain list called &'local_domains'&; this is used
5409 later in the configuration to identify domains that are to be delivered
5410 on the local host.
5411
5412 .cindex "@ in a domain list"
5413 There is just one item in this list, the string &"@"&. This is a special form
5414 of entry which means &"the name of the local host"&. Thus, if the local host is
5415 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5416 be delivered locally. Because the local host's name is referenced indirectly,
5417 the same configuration file can be used on different hosts.
5418
5419 The second line defines a domain list called &'relay_to_domains'&, but the
5420 list itself is empty. Later in the configuration we will come to the part that
5421 controls mail relaying through the local host; it allows relaying to any
5422 domains in this list. By default, therefore, no relaying on the basis of a mail
5423 domain is permitted.
5424
5425 The third line defines a host list called &'relay_from_hosts'&. This list is
5426 used later in the configuration to permit relaying from any host or IP address
5427 that matches the list. The default contains just the IP address of the IPv4
5428 loopback interface, which means that processes on the local host are able to
5429 submit mail for relaying by sending it over TCP/IP to that interface. No other
5430 hosts are permitted to submit messages for relaying.
5431
5432 Just to be sure there's no misunderstanding: at this point in the configuration
5433 we aren't actually setting up any controls. We are just defining some domains
5434 and hosts that will be used in the controls that are specified later.
5435
5436 The next two configuration lines are genuine option settings:
5437 .code
5438 acl_smtp_rcpt = acl_check_rcpt
5439 acl_smtp_data = acl_check_data
5440 .endd
5441 These options specify &'Access Control Lists'& (ACLs) that are to be used
5442 during an incoming SMTP session for every recipient of a message (every RCPT
5443 command), and after the contents of the message have been received,
5444 respectively. The names of the lists are &'acl_check_rcpt'& and
5445 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5446 section of the configuration. The RCPT ACL controls which recipients are
5447 accepted for an incoming message &-- if a configuration does not provide an ACL
5448 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5449 contents of a message to be checked.
5450
5451 Two commented-out option settings are next:
5452 .code
5453 # av_scanner = clamd:/tmp/clamd
5454 # spamd_address = 127.0.0.1 783
5455 .endd
5456 These are example settings that can be used when Exim is compiled with the
5457 content-scanning extension. The first specifies the interface to the virus
5458 scanner, and the second specifies the interface to SpamAssassin. Further
5459 details are given in chapter &<<CHAPexiscan>>&.
5460
5461 Three more commented-out option settings follow:
5462 .code
5463 # tls_advertise_hosts = *
5464 # tls_certificate = /etc/ssl/exim.crt
5465 # tls_privatekey = /etc/ssl/exim.pem
5466 .endd
5467 These are example settings that can be used when Exim is compiled with
5468 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5469 first one specifies the list of clients that are allowed to use TLS when
5470 connecting to this server; in this case the wildcard means all clients. The
5471 other options specify where Exim should find its TLS certificate and private
5472 key, which together prove the server's identity to any clients that connect.
5473 More details are given in chapter &<<CHAPTLS>>&.
5474
5475 Another two commented-out option settings follow:
5476 .code
5477 # daemon_smtp_ports = 25 : 465 : 587
5478 # tls_on_connect_ports = 465
5479 .endd
5480 .cindex "port" "465 and 587"
5481 .cindex "port" "for message submission"
5482 .cindex "message" "submission, ports for"
5483 .cindex "ssmtp protocol"
5484 .cindex "smtps protocol"
5485 .cindex "SMTP" "ssmtp protocol"
5486 .cindex "SMTP" "smtps protocol"
5487 These options provide better support for roaming users who wish to use this
5488 server for message submission. They are not much use unless you have turned on
5489 TLS (as described in the previous paragraph) and authentication (about which
5490 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5491 on end-user networks, so RFC 4409 specifies that message submission should use
5492 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5493 configured to use port 587 correctly, so these settings also enable the
5494 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5495 &<<SECTsupobssmt>>&).
5496
5497 Two more commented-out options settings follow:
5498 .code
5499 # qualify_domain =
5500 # qualify_recipient =
5501 .endd
5502 The first of these specifies a domain that Exim uses when it constructs a
5503 complete email address from a local login name. This is often needed when Exim
5504 receives a message from a local process. If you do not set &%qualify_domain%&,
5505 the value of &%primary_hostname%& is used. If you set both of these options,
5506 you can have different qualification domains for sender and recipient
5507 addresses. If you set only the first one, its value is used in both cases.
5508
5509 .cindex "domain literal" "recognizing format"
5510 The following line must be uncommented if you want Exim to recognize
5511 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5512 (an IP address within square brackets) instead of a named domain.
5513 .code
5514 # allow_domain_literals
5515 .endd
5516 The RFCs still require this form, but many people think that in the modern
5517 Internet it makes little sense to permit mail to be sent to specific hosts by
5518 quoting their IP addresses. This ancient format has been used by people who
5519 try to abuse hosts by using them for unwanted relaying. However, some
5520 people believe there are circumstances (for example, messages addressed to
5521 &'postmaster'&) where domain literals are still useful.
5522
5523 The next configuration line is a kind of trigger guard:
5524 .code
5525 never_users = root
5526 .endd
5527 It specifies that no delivery must ever be run as the root user. The normal
5528 convention is to set up &'root'& as an alias for the system administrator. This
5529 setting is a guard against slips in the configuration.
5530 The list of users specified by &%never_users%& is not, however, the complete
5531 list; the build-time configuration in &_Local/Makefile_& has an option called
5532 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5533 contents of &%never_users%& are added to this list. By default
5534 FIXED_NEVER_USERS also specifies root.
5535
5536 When a remote host connects to Exim in order to send mail, the only information
5537 Exim has about the host's identity is its IP address. The next configuration
5538 line,
5539 .code
5540 host_lookup = *
5541 .endd
5542 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5543 in order to get a host name. This improves the quality of the logging
5544 information, but if you feel it is too expensive, you can remove it entirely,
5545 or restrict the lookup to hosts on &"nearby"& networks.
5546 Note that it is not always possible to find a host name from an IP address,
5547 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5548 unreachable.
5549
5550 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5551 1413 (hence their names):
5552 .code
5553 rfc1413_hosts = *
5554 rfc1413_query_timeout = 5s
5555 .endd
5556 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5557 You can limit the hosts to which these calls are made, or change the timeout
5558 that is used. If you set the timeout to zero, all ident calls are disabled.
5559 Although they are cheap and can provide useful information for tracing problem
5560 messages, some hosts and firewalls have problems with ident calls. This can
5561 result in a timeout instead of an immediate refused connection, leading to
5562 delays on starting up an incoming SMTP session.
5563
5564 When Exim receives messages over SMTP connections, it expects all addresses to
5565 be fully qualified with a domain, as required by the SMTP definition. However,
5566 if you are running a server to which simple clients submit messages, you may
5567 find that they send unqualified addresses. The two commented-out options:
5568 .code
5569 # sender_unqualified_hosts =
5570 # recipient_unqualified_hosts =
5571 .endd
5572 show how you can specify hosts that are permitted to send unqualified sender
5573 and recipient addresses, respectively.
5574
5575 The &%percent_hack_domains%& option is also commented out:
5576 .code
5577 # percent_hack_domains =
5578 .endd
5579 It provides a list of domains for which the &"percent hack"& is to operate.
5580 This is an almost obsolete form of explicit email routing. If you do not know
5581 anything about it, you can safely ignore this topic.
5582
5583 The last two settings in the main part of the default configuration are
5584 concerned with messages that have been &"frozen"& on Exim's queue. When a
5585 message is frozen, Exim no longer continues to try to deliver it. Freezing
5586 occurs when a bounce message encounters a permanent failure because the sender
5587 address of the original message that caused the bounce is invalid, so the
5588 bounce cannot be delivered. This is probably the most common case, but there
5589 are also other conditions that cause freezing, and frozen messages are not
5590 always bounce messages.
5591 .code
5592 ignore_bounce_errors_after = 2d
5593 timeout_frozen_after = 7d
5594 .endd
5595 The first of these options specifies that failing bounce messages are to be
5596 discarded after 2 days on the queue. The second specifies that any frozen
5597 message (whether a bounce message or not) is to be timed out (and discarded)
5598 after a week. In this configuration, the first setting ensures that no failing
5599 bounce message ever lasts a week.
5600
5601
5602
5603 .section "ACL configuration" "SECID54"
5604 .cindex "default" "ACLs"
5605 .cindex "&ACL;" "default configuration"
5606 In the default configuration, the ACL section follows the main configuration.
5607 It starts with the line
5608 .code
5609 begin acl
5610 .endd
5611 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5612 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5613 and &%acl_smtp_data%& above.
5614
5615 .cindex "RCPT" "ACL for"
5616 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5617 RCPT command specifies one of the message's recipients. The ACL statements
5618 are considered in order, until the recipient address is either accepted or
5619 rejected. The RCPT command is then accepted or rejected, according to the
5620 result of the ACL processing.
5621 .code
5622 acl_check_rcpt:
5623 .endd
5624 This line, consisting of a name terminated by a colon, marks the start of the
5625 ACL, and names it.
5626 .code
5627 accept  hosts = :
5628 .endd
5629 This ACL statement accepts the recipient if the sending host matches the list.
5630 But what does that strange list mean? It doesn't actually contain any host
5631 names or IP addresses. The presence of the colon puts an empty item in the
5632 list; Exim matches this only if the incoming message did not come from a remote
5633 host, because in that case, the remote hostname is empty. The colon is
5634 important. Without it, the list itself is empty, and can never match anything.
5635
5636 What this statement is doing is to accept unconditionally all recipients in
5637 messages that are submitted by SMTP from local processes using the standard
5638 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5639 manner.
5640 .code
5641 deny    message       = Restricted characters in address
5642         domains       = +local_domains
5643         local_parts   = ^[.] : ^.*[@%!/|]
5644
5645 deny    message       = Restricted characters in address
5646         domains       = !+local_domains
5647         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5648 .endd
5649 These statements are concerned with local parts that contain any of the
5650 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5651 Although these characters are entirely legal in local parts (in the case of
5652 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5653 in Internet mail addresses.
5654
5655 The first three have in the past been associated with explicitly routed
5656 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5657 option). Addresses containing these characters are regularly tried by spammers
5658 in an attempt to bypass relaying restrictions, and also by open relay testing
5659 programs. Unless you really need them it is safest to reject these characters
5660 at this early stage. This configuration is heavy-handed in rejecting these
5661 characters for all messages it accepts from remote hosts. This is a deliberate
5662 policy of being as safe as possible.
5663
5664 The first rule above is stricter, and is applied to messages that are addressed
5665 to one of the local domains handled by this host. This is implemented by the
5666 first condition, which restricts it to domains that are listed in the
5667 &'local_domains'& domain list. The &"+"& character is used to indicate a
5668 reference to a named list. In this configuration, there is just one domain in
5669 &'local_domains'&, but in general there may be many.
5670
5671 The second condition on the first statement uses two regular expressions to
5672 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5673 or &"|"&. If you have local accounts that include these characters, you will
5674 have to modify this rule.
5675
5676 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5677 allows them because they have been encountered in practice. (Consider the
5678 common convention of local parts constructed as
5679 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5680 the author of Exim, who has no second initial.) However, a local part starting
5681 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5682 file name (for example, for a mailing list). This is also true for local parts
5683 that contain slashes. A pipe symbol can also be troublesome if the local part
5684 is incorporated unthinkingly into a shell command line.
5685
5686 The second rule above applies to all other domains, and is less strict. This
5687 allows your own users to send outgoing messages to sites that use slashes
5688 and vertical bars in their local parts. It blocks local parts that begin
5689 with a dot, slash, or vertical bar, but allows these characters within the
5690 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5691 and &"!"& is blocked, as before. The motivation here is to prevent your users
5692 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5693 .code
5694 accept  local_parts   = postmaster
5695         domains       = +local_domains
5696 .endd
5697 This statement, which has two conditions, accepts an incoming address if the
5698 local part is &'postmaster'& and the domain is one of those listed in the
5699 &'local_domains'& domain list. The &"+"& character is used to indicate a
5700 reference to a named list. In this configuration, there is just one domain in
5701 &'local_domains'&, but in general there may be many.
5702
5703 The presence of this statement means that mail to postmaster is never blocked
5704 by any of the subsequent tests. This can be helpful while sorting out problems
5705 in cases where the subsequent tests are incorrectly denying access.
5706 .code
5707 require verify        = sender
5708 .endd
5709 This statement requires the sender address to be verified before any subsequent
5710 ACL statement can be used. If verification fails, the incoming recipient
5711 address is refused. Verification consists of trying to route the address, to
5712 see if a bounce message could be delivered to it. In the case of remote
5713 addresses, basic verification checks only the domain, but &'callouts'& can be
5714 used for more verification if required. Section &<<SECTaddressverification>>&
5715 discusses the details of address verification.
5716 .code
5717 accept  hosts         = +relay_from_hosts
5718         control       = submission
5719 .endd
5720 This statement accepts the address if the message is coming from one of the
5721 hosts that are defined as being allowed to relay through this host. Recipient
5722 verification is omitted here, because in many cases the clients are dumb MUAs
5723 that do not cope well with SMTP error responses. For the same reason, the
5724 second line specifies &"submission mode"& for messages that are accepted. This
5725 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5726 messages that are deficient in some way, for example, because they lack a
5727 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5728 probably add recipient verification here, and disable submission mode.
5729 .code
5730 accept  authenticated = *
5731         control       = submission
5732 .endd
5733 This statement accepts the address if the client host has authenticated itself.
5734 Submission mode is again specified, on the grounds that such messages are most
5735 likely to come from MUAs. The default configuration does not define any
5736 authenticators, though it does include some nearly complete commented-out
5737 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5738 fact authenticate until you complete the authenticator definitions.
5739 .code
5740 require message = relay not permitted
5741         domains = +local_domains : +relay_to_domains
5742 .endd
5743 This statement rejects the address if its domain is neither a local domain nor
5744 one of the domains for which this host is a relay.
5745 .code
5746 require verify = recipient
5747 .endd
5748 This statement requires the recipient address to be verified; if verification
5749 fails, the address is rejected.
5750 .code
5751 # deny    message     = rejected because $sender_host_address \
5752 #                       is in a black list at $dnslist_domain\n\
5753 #                       $dnslist_text
5754 #         dnslists    = black.list.example
5755 #
5756 # warn    dnslists    = black.list.example
5757 #         add_header  = X-Warning: $sender_host_address is in \
5758 #                       a black list at $dnslist_domain
5759 #         log_message = found in $dnslist_domain
5760 .endd
5761 These commented-out lines are examples of how you could configure Exim to check
5762 sending hosts against a DNS black list. The first statement rejects messages
5763 from blacklisted hosts, whereas the second just inserts a warning header
5764 line.
5765 .code
5766 # require verify = csa
5767 .endd
5768 This commented-out line is an example of how you could turn on client SMTP
5769 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5770 records.
5771 .code
5772 accept
5773 .endd
5774 The final statement in the first ACL unconditionally accepts any recipient
5775 address that has successfully passed all the previous tests.
5776 .code
5777 acl_check_data:
5778 .endd
5779 This line marks the start of the second ACL, and names it. Most of the contents
5780 of this ACL are commented out:
5781 .code
5782 # deny    malware   = *
5783 #         message   = This message contains a virus \
5784 #                     ($malware_name).
5785 .endd
5786 These lines are examples of how to arrange for messages to be scanned for
5787 viruses when Exim has been compiled with the content-scanning extension, and a
5788 suitable virus scanner is installed. If the message is found to contain a
5789 virus, it is rejected with the given custom error message.
5790 .code
5791 # warn    spam      = nobody
5792 #         message   = X-Spam_score: $spam_score\n\
5793 #                     X-Spam_score_int: $spam_score_int\n\
5794 #                     X-Spam_bar: $spam_bar\n\
5795 #                     X-Spam_report: $spam_report
5796 .endd
5797 These lines are an example of how to arrange for messages to be scanned by
5798 SpamAssassin when Exim has been compiled with the content-scanning extension,
5799 and SpamAssassin has been installed. The SpamAssassin check is run with
5800 &`nobody`& as its user parameter, and the results are added to the message as a
5801 series of extra header line. In this case, the message is not rejected,
5802 whatever the spam score.
5803 .code
5804 accept
5805 .endd
5806 This final line in the DATA ACL accepts the message unconditionally.
5807
5808
5809 .section "Router configuration" "SECID55"
5810 .cindex "default" "routers"
5811 .cindex "routers" "default"
5812 The router configuration comes next in the default configuration, introduced
5813 by the line
5814 .code
5815 begin routers
5816 .endd
5817 Routers are the modules in Exim that make decisions about where to send
5818 messages. An address is passed to each router in turn, until it is either
5819 accepted, or failed. This means that the order in which you define the routers
5820 matters. Each router is fully described in its own chapter later in this
5821 manual. Here we give only brief overviews.
5822 .code
5823 # domain_literal:
5824 #   driver = ipliteral
5825 #   domains = !+local_domains
5826 #   transport = remote_smtp
5827 .endd
5828 .cindex "domain literal" "default router"
5829 This router is commented out because the majority of sites do not want to
5830 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5831 you uncomment this router, you also need to uncomment the setting of
5832 &%allow_domain_literals%& in the main part of the configuration.
5833 .code
5834 dnslookup:
5835   driver = dnslookup
5836   domains = ! +local_domains
5837   transport = remote_smtp
5838   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5839   no_more
5840 .endd
5841 The first uncommented router handles addresses that do not involve any local
5842 domains. This is specified by the line
5843 .code
5844 domains = ! +local_domains
5845 .endd
5846 The &%domains%& option lists the domains to which this router applies, but the
5847 exclamation mark is a negation sign, so the router is used only for domains
5848 that are not in the domain list called &'local_domains'& (which was defined at
5849 the start of the configuration). The plus sign before &'local_domains'&
5850 indicates that it is referring to a named list. Addresses in other domains are
5851 passed on to the following routers.
5852
5853 The name of the router driver is &(dnslookup)&,
5854 and is specified by the &%driver%& option. Do not be confused by the fact that
5855 the name of this router instance is the same as the name of the driver. The
5856 instance name is arbitrary, but the name set in the &%driver%& option must be
5857 one of the driver modules that is in the Exim binary.
5858
5859 The &(dnslookup)& router routes addresses by looking up their domains in the
5860 DNS in order to obtain a list of hosts to which the address is routed. If the
5861 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5862 specified by the &%transport%& option. If the router does not find the domain
5863 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5864 the address fails and is bounced.
5865
5866 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5867 be entirely ignored. This option is present because a number of cases have been
5868 encountered where MX records in the DNS point to host names
5869 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5870 Completely ignoring these IP addresses causes Exim to fail to route the
5871 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5872 continue to try to deliver the message periodically until the address timed
5873 out.
5874 .code
5875 system_aliases:
5876   driver = redirect
5877   allow_fail
5878   allow_defer
5879   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5880 # user = exim
5881   file_transport = address_file
5882   pipe_transport = address_pipe
5883 .endd
5884 Control reaches this and subsequent routers only for addresses in the local
5885 domains. This router checks to see whether the local part is defined as an
5886 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5887 data that it looks up from that file. If no data is found for the local part,
5888 the value of the &%data%& option is empty, causing the address to be passed to
5889 the next router.
5890
5891 &_/etc/aliases_& is a conventional name for the system aliases file that is
5892 often used. That is why it is referenced by from the default configuration
5893 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5894 &_Local/Makefile_& before building Exim.
5895 .code
5896 userforward:
5897   driver = redirect
5898   check_local_user
5899 # local_part_suffix = +* : -*
5900 # local_part_suffix_optional
5901   file = $home/.forward
5902 # allow_filter
5903   no_verify
5904   no_expn
5905   check_ancestor
5906   file_transport = address_file
5907   pipe_transport = address_pipe
5908   reply_transport = address_reply
5909 .endd
5910 This is the most complicated router in the default configuration. It is another
5911 redirection router, but this time it is looking for forwarding data set up by
5912 individual users. The &%check_local_user%& setting specifies a check that the
5913 local part of the address is the login name of a local user. If it is not, the
5914 router is skipped. The two commented options that follow &%check_local_user%&,
5915 namely:
5916 .code
5917 # local_part_suffix = +* : -*
5918 # local_part_suffix_optional
5919 .endd
5920 .vindex "&$local_part_suffix$&"
5921 show how you can specify the recognition of local part suffixes. If the first
5922 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5923 by any sequence of characters, is removed from the local part and placed in the
5924 variable &$local_part_suffix$&. The second suffix option specifies that the
5925 presence of a suffix in the local part is optional. When a suffix is present,
5926 the check for a local login uses the local part with the suffix removed.
5927
5928 When a local user account is found, the file called &_.forward_& in the user's
5929 home directory is consulted. If it does not exist, or is empty, the router
5930 declines. Otherwise, the contents of &_.forward_& are interpreted as
5931 redirection data (see chapter &<<CHAPredirect>>& for more details).
5932
5933 .cindex "Sieve filter" "enabling in default router"
5934 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5935 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5936 is commented out by default), the contents of the file are interpreted as a set
5937 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5938 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5939 separate document entitled &'Exim's interfaces to mail filtering'&.
5940
5941 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5942 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5943 There are two reasons for doing this:
5944
5945 .olist
5946 Whether or not a local user has a &_.forward_& file is not really relevant when
5947 checking an address for validity; it makes sense not to waste resources doing
5948 unnecessary work.
5949 .next
5950 More importantly, when Exim is verifying addresses or handling an EXPN
5951 command during an SMTP session, it is running as the Exim user, not as root.
5952 The group is the Exim group, and no additional groups are set up.
5953 It may therefore not be possible for Exim to read users' &_.forward_& files at
5954 this time.
5955 .endlist
5956
5957 The setting of &%check_ancestor%& prevents the router from generating a new
5958 address that is the same as any previous address that was redirected. (This
5959 works round a problem concerning a bad interaction between aliasing and
5960 forwarding &-- see section &<<SECTredlocmai>>&).
5961
5962 The final three option settings specify the transports that are to be used when
5963 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5964 auto-reply, respectively. For example, if a &_.forward_& file contains
5965 .code
5966 a.nother@elsewhere.example, /home/spqr/archive
5967 .endd
5968 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5969 transport.
5970 .code
5971 localuser:
5972   driver = accept
5973   check_local_user
5974 # local_part_suffix = +* : -*
5975 # local_part_suffix_optional
5976   transport = local_delivery
5977 .endd
5978 The final router sets up delivery into local mailboxes, provided that the local
5979 part is the name of a local login, by accepting the address and assigning it to
5980 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5981 routers, so the address is bounced. The commented suffix settings fulfil the
5982 same purpose as they do for the &(userforward)& router.
5983
5984
5985 .section "Transport configuration" "SECID56"
5986 .cindex "default" "transports"
5987 .cindex "transports" "default"
5988 Transports define mechanisms for actually delivering messages. They operate
5989 only when referenced from routers, so the order in which they are defined does
5990 not matter. The transports section of the configuration starts with
5991 .code
5992 begin transports
5993 .endd
5994 One remote transport and four local transports are defined.
5995 .code
5996 remote_smtp:
5997   driver = smtp
5998 .endd
5999 This transport is used for delivering messages over SMTP connections. All its
6000 options are defaulted. The list of remote hosts comes from the router.
6001 .code
6002 local_delivery:
6003   driver = appendfile
6004   file = /var/mail/$local_part
6005   delivery_date_add
6006   envelope_to_add
6007   return_path_add
6008 # group = mail
6009 # mode = 0660
6010 .endd
6011 This &(appendfile)& transport is used for local delivery to user mailboxes in
6012 traditional BSD mailbox format. By default it runs under the uid and gid of the
6013 local user, which requires the sticky bit to be set on the &_/var/mail_&
6014 directory. Some systems use the alternative approach of running mail deliveries
6015 under a particular group instead of using the sticky bit. The commented options
6016 show how this can be done.
6017
6018 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6019 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6020 similarly-named options above.
6021 .code
6022 address_pipe:
6023   driver = pipe
6024   return_output
6025 .endd
6026 This transport is used for handling deliveries to pipes that are generated by
6027 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6028 option specifies that any output generated by the pipe is to be returned to the
6029 sender.
6030 .code
6031 address_file:
6032   driver = appendfile
6033   delivery_date_add
6034   envelope_to_add
6035   return_path_add
6036 .endd
6037 This transport is used for handling deliveries to files that are generated by
6038 redirection. The name of the file is not specified in this instance of
6039 &(appendfile)&, because it comes from the &(redirect)& router.
6040 .code
6041 address_reply:
6042   driver = autoreply
6043 .endd
6044 This transport is used for handling automatic replies generated by users'
6045 filter files.
6046
6047
6048
6049 .section "Default retry rule" "SECID57"
6050 .cindex "retry" "default rule"
6051 .cindex "default" "retry rule"
6052 The retry section of the configuration file contains rules which affect the way
6053 Exim retries deliveries that cannot be completed at the first attempt. It is
6054 introduced by the line
6055 .code
6056 begin retry
6057 .endd
6058 In the default configuration, there is just one rule, which applies to all
6059 errors:
6060 .code
6061 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6062 .endd
6063 This causes any temporarily failing address to be retried every 15 minutes for
6064 2 hours, then at intervals starting at one hour and increasing by a factor of
6065 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6066 is not delivered after 4 days of temporary failure, it is bounced.
6067
6068 If the retry section is removed from the configuration, or is empty (that is,
6069 if no retry rules are defined), Exim will not retry deliveries. This turns
6070 temporary errors into permanent errors.
6071
6072
6073 .section "Rewriting configuration" "SECID58"
6074 The rewriting section of the configuration, introduced by
6075 .code
6076 begin rewrite
6077 .endd
6078 contains rules for rewriting addresses in messages as they arrive. There are no
6079 rewriting rules in the default configuration file.
6080
6081
6082
6083 .section "Authenticators configuration" "SECTdefconfauth"
6084 .cindex "AUTH" "configuration"
6085 The authenticators section of the configuration, introduced by
6086 .code
6087 begin authenticators
6088 .endd
6089 defines mechanisms for the use of the SMTP AUTH command. The default
6090 configuration file contains two commented-out example authenticators
6091 which support plaintext username/password authentication using the
6092 standard PLAIN mechanism and the traditional but non-standard LOGIN
6093 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6094 to support most MUA software.
6095
6096 The example PLAIN authenticator looks like this:
6097 .code
6098 #PLAIN:
6099 #  driver                  = plaintext
6100 #  server_set_id           = $auth2
6101 #  server_prompts          = :
6102 #  server_condition        = Authentication is not yet configured
6103 #  server_advertise_condition = ${if def:tls_in_cipher }
6104 .endd
6105 And the example LOGIN authenticator looks like this:
6106 .code
6107 #LOGIN:
6108 #  driver                  = plaintext
6109 #  server_set_id           = $auth1
6110 #  server_prompts          = <| Username: | Password:
6111 #  server_condition        = Authentication is not yet configured
6112 #  server_advertise_condition = ${if def:tls_in_cipher }
6113 .endd
6114
6115 The &%server_set_id%& option makes Exim remember the authenticated username
6116 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6117 &%server_prompts%& option configures the &(plaintext)& authenticator so
6118 that it implements the details of the specific authentication mechanism,
6119 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6120 when Exim offers authentication to clients; in the examples, this is only
6121 when TLS or SSL has been started, so to enable the authenticators you also
6122 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6123
6124 The &%server_condition%& setting defines how to verify that the username and
6125 password are correct. In the examples it just produces an error message.
6126 To make the authenticators work, you can use a string expansion
6127 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6128
6129 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6130 usercode and password are in different positions.
6131 Chapter &<<CHAPplaintext>>& covers both.
6132
6133 .ecindex IIDconfiwal
6134
6135
6136
6137 . ////////////////////////////////////////////////////////////////////////////
6138 . ////////////////////////////////////////////////////////////////////////////
6139
6140 .chapter "Regular expressions" "CHAPregexp"
6141
6142 .cindex "regular expressions" "library"
6143 .cindex "PCRE"
6144 Exim supports the use of regular expressions in many of its options. It
6145 uses the PCRE regular expression library; this provides regular expression
6146 matching that is compatible with Perl 5. The syntax and semantics of
6147 regular expressions is discussed in many Perl reference books, and also in
6148 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6149 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6150
6151 The documentation for the syntax and semantics of the regular expressions that
6152 are supported by PCRE is included in the PCRE distribution, and no further
6153 description is included here. The PCRE functions are called from Exim using
6154 the default option settings (that is, with no PCRE options set), except that
6155 the PCRE_CASELESS option is set when the matching is required to be
6156 case-insensitive.
6157
6158 In most cases, when a regular expression is required in an Exim configuration,
6159 it has to start with a circumflex, in order to distinguish it from plain text
6160 or an &"ends with"& wildcard. In this example of a configuration setting, the
6161 second item in the colon-separated list is a regular expression.
6162 .code
6163 domains = a.b.c : ^\\d{3} : *.y.z : ...
6164 .endd
6165 The doubling of the backslash is required because of string expansion that
6166 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6167 of this issue, and a way of avoiding the need for doubling backslashes. The
6168 regular expression that is eventually used in this example contains just one
6169 backslash. The circumflex is included in the regular expression, and has the
6170 normal effect of &"anchoring"& it to the start of the string that is being
6171 matched.
6172
6173 There are, however, two cases where a circumflex is not required for the
6174 recognition of a regular expression: these are the &%match%& condition in a
6175 string expansion, and the &%matches%& condition in an Exim filter file. In
6176 these cases, the relevant string is always treated as a regular expression; if
6177 it does not start with a circumflex, the expression is not anchored, and can
6178 match anywhere in the subject string.
6179
6180 In all cases, if you want a regular expression to match at the end of a string,
6181 you must code the $ metacharacter to indicate this. For example:
6182 .code
6183 domains = ^\\d{3}\\.example
6184 .endd
6185 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6186 You need to use:
6187 .code
6188 domains = ^\\d{3}\\.example\$
6189 .endd
6190 if you want &'example'& to be the top-level domain. The backslash before the
6191 $ is needed because string expansion also interprets dollar characters.
6192
6193
6194
6195 . ////////////////////////////////////////////////////////////////////////////
6196 . ////////////////////////////////////////////////////////////////////////////
6197
6198 .chapter "File and database lookups" "CHAPfdlookup"
6199 .scindex IIDfidalo1 "file" "lookups"
6200 .scindex IIDfidalo2 "database" "lookups"
6201 .cindex "lookup" "description of"
6202 Exim can be configured to look up data in files or databases as it processes
6203 messages. Two different kinds of syntax are used:
6204
6205 .olist
6206 A string that is to be expanded may contain explicit lookup requests. These
6207 cause parts of the string to be replaced by data that is obtained from the
6208 lookup. Lookups of this type are conditional expansion items. Different results
6209 can be defined for the cases of lookup success and failure. See chapter
6210 &<<CHAPexpand>>&, where string expansions are described in detail.
6211 .next
6212 Lists of domains, hosts, and email addresses can contain lookup requests as a
6213 way of avoiding excessively long linear lists. In this case, the data that is
6214 returned by the lookup is often (but not always) discarded; whether the lookup
6215 succeeds or fails is what really counts. These kinds of list are described in
6216 chapter &<<CHAPdomhosaddlists>>&.
6217 .endlist
6218
6219 String expansions, lists, and lookups interact with each other in such a way
6220 that there is no order in which to describe any one of them that does not
6221 involve references to the others. Each of these three chapters makes more sense
6222 if you have read the other two first. If you are reading this for the first
6223 time, be aware that some of it will make a lot more sense after you have read
6224 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6225
6226 .section "Examples of different lookup syntax" "SECID60"
6227 It is easy to confuse the two different kinds of lookup, especially as the
6228 lists that may contain the second kind are always expanded before being
6229 processed as lists. Therefore, they may also contain lookups of the first kind.
6230 Be careful to distinguish between the following two examples:
6231 .code
6232 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6233 domains = lsearch;/some/file
6234 .endd
6235 The first uses a string expansion, the result of which must be a domain list.
6236 No strings have been specified for a successful or a failing lookup; the
6237 defaults in this case are the looked-up data and an empty string, respectively.
6238 The expansion takes place before the string is processed as a list, and the
6239 file that is searched could contain lines like this:
6240 .code
6241 192.168.3.4: domain1:domain2:...
6242 192.168.1.9: domain3:domain4:...
6243 .endd
6244 When the lookup succeeds, the result of the expansion is a list of domains (and
6245 possibly other types of item that are allowed in domain lists).
6246
6247 In the second example, the lookup is a single item in a domain list. It causes
6248 Exim to use a lookup to see if the domain that is being processed can be found
6249 in the file. The file could contains lines like this:
6250 .code
6251 domain1:
6252 domain2:
6253 .endd
6254 Any data that follows the keys is not relevant when checking that the domain
6255 matches the list item.
6256
6257 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6258 Consider a file containing lines like this:
6259 .code
6260 192.168.5.6: lsearch;/another/file
6261 .endd
6262 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6263 first &%domains%& setting above generates the second setting, which therefore
6264 causes a second lookup to occur.
6265
6266 The rest of this chapter describes the different lookup types that are
6267 available. Any of them can be used in any part of the configuration where a
6268 lookup is permitted.
6269
6270
6271 .section "Lookup types" "SECID61"
6272 .cindex "lookup" "types of"
6273 .cindex "single-key lookup" "definition of"
6274 Two different types of data lookup are implemented:
6275
6276 .ilist
6277 The &'single-key'& type requires the specification of a file in which to look,
6278 and a single key to search for. The key must be a non-empty string for the
6279 lookup to succeed. The lookup type determines how the file is searched.
6280 .next
6281 .cindex "query-style lookup" "definition of"
6282 The &'query-style'& type accepts a generalized database query. No particular
6283 key value is assumed by Exim for query-style lookups. You can use whichever
6284 Exim variables you need to construct the database query.
6285 .endlist
6286
6287 The code for each lookup type is in a separate source file that is included in
6288 the binary of Exim only if the corresponding compile-time option is set. The
6289 default settings in &_src/EDITME_& are:
6290 .code
6291 LOOKUP_DBM=yes
6292 LOOKUP_LSEARCH=yes
6293 .endd
6294 which means that only linear searching and DBM lookups are included by default.
6295 For some types of lookup (e.g. SQL databases), you need to install appropriate
6296 libraries and header files before building Exim.
6297
6298
6299
6300
6301 .section "Single-key lookup types" "SECTsinglekeylookups"
6302 .cindex "lookup" "single-key types"
6303 .cindex "single-key lookup" "list of types"
6304 The following single-key lookup types are implemented:
6305
6306 .ilist
6307 .cindex "cdb" "description of"
6308 .cindex "lookup" "cdb"
6309 .cindex "binary zero" "in lookup key"
6310 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6311 string without a terminating binary zero. The cdb format is designed for
6312 indexed files that are read frequently and never updated, except by total
6313 re-creation. As such, it is particularly suitable for large files containing
6314 aliases or other indexed data referenced by an MTA. Information about cdb can
6315 be found in several places:
6316 .display
6317 &url(http://www.pobox.com/~djb/cdb.html)
6318 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6319 &url(http://packages.debian.org/stable/utils/freecdb.html)
6320 .endd
6321 A cdb distribution is not needed in order to build Exim with cdb support,
6322 because the code for reading cdb files is included directly in Exim itself.
6323 However, no means of building or testing cdb files is provided with Exim, so
6324 you need to obtain a cdb distribution in order to do this.
6325 .next
6326 .cindex "DBM" "lookup type"
6327 .cindex "lookup" "dbm"
6328 .cindex "binary zero" "in lookup key"
6329 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6330 DBM file by looking up the record with the given key. A terminating binary
6331 zero is included in the key that is passed to the DBM library. See section
6332 &<<SECTdb>>& for a discussion of DBM libraries.
6333
6334 .cindex "Berkeley DB library" "file format"
6335 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6336 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6337 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6338 the DB_UNKNOWN option. This enables it to handle any of the types of database
6339 that the library supports, and can be useful for accessing DBM files created by
6340 other applications. (For earlier DB versions, DB_HASH is always used.)
6341 .next
6342 .cindex "lookup" "dbmjz"
6343 .cindex "lookup" "dbm &-- embedded NULs"
6344 .cindex "sasldb2"
6345 .cindex "dbmjz lookup type"
6346 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6347 interpreted as an Exim list; the elements of the list are joined together with
6348 ASCII NUL characters to form the lookup key.  An example usage would be to
6349 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6350 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6351 &(cram_md5)& authenticator.
6352 .next
6353 .cindex "lookup" "dbmnz"
6354 .cindex "lookup" "dbm &-- terminating zero"
6355 .cindex "binary zero" "in lookup key"
6356 .cindex "Courier"
6357 .cindex "&_/etc/userdbshadow.dat_&"
6358 .cindex "dbmnz lookup type"
6359 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6360 is not included in the key that is passed to the DBM library. You may need this
6361 if you want to look up data in files that are created by or shared with some
6362 other application that does not use terminating zeros. For example, you need to
6363 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6364 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6365 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6366 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6367 .next
6368 .cindex "lookup" "dsearch"
6369 .cindex "dsearch lookup type"
6370 &(dsearch)&: The given file must be a directory; this is searched for an entry
6371 whose name is the key by calling the &[lstat()]& function. The key may not
6372 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6373 the lookup is the name of the entry, which may be a file, directory,
6374 symbolic link, or any other kind of directory entry. An example of how this
6375 lookup can be used to support virtual domains is given in section
6376 &<<SECTvirtualdomains>>&.
6377 .next
6378 .cindex "lookup" "iplsearch"
6379 .cindex "iplsearch lookup type"
6380 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6381 terminated by a colon or white space or the end of the line. The keys in the
6382 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6383 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6384 being interpreted as a key terminator. For example:
6385 .code
6386 1.2.3.4:           data for 1.2.3.4
6387 192.168.0.0/16:    data for 192.168.0.0/16
6388 "abcd::cdab":      data for abcd::cdab
6389 "abcd:abcd::/32"   data for abcd:abcd::/32
6390 .endd
6391 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6392 file is searched linearly, using the CIDR masks where present, until a matching
6393 key is found. The first key that matches is used; there is no attempt to find a
6394 &"best"& match. Apart from the way the keys are matched, the processing for
6395 &(iplsearch)& is the same as for &(lsearch)&.
6396
6397 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6398 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6399 lookup types support only literal keys.
6400
6401 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6402 the implicit key is the host's IP address rather than its name (see section
6403 &<<SECThoslispatsikey>>&).
6404 .next
6405 .cindex "linear search"
6406 .cindex "lookup" "lsearch"
6407 .cindex "lsearch lookup type"
6408 .cindex "case sensitivity" "in lsearch lookup"
6409 &(lsearch)&: The given file is a text file that is searched linearly for a
6410 line beginning with the search key, terminated by a colon or white space or the
6411 end of the line. The search is case-insensitive; that is, upper and lower case
6412 letters are treated as the same. The first occurrence of the key that is found
6413 in the file is used.
6414
6415 White space between the key and the colon is permitted. The remainder of the
6416 line, with leading and trailing white space removed, is the data. This can be
6417 continued onto subsequent lines by starting them with any amount of white
6418 space, but only a single space character is included in the data at such a
6419 junction. If the data begins with a colon, the key must be terminated by a
6420 colon, for example:
6421 .code
6422 baduser:  :fail:
6423 .endd
6424 Empty lines and lines beginning with # are ignored, even if they occur in the
6425 middle of an item. This is the traditional textual format of alias files. Note
6426 that the keys in an &(lsearch)& file are literal strings. There is no
6427 wildcarding of any kind.
6428
6429 .cindex "lookup" "lsearch &-- colons in keys"
6430 .cindex "white space" "in lsearch key"
6431 In most &(lsearch)& files, keys are not required to contain colons or #
6432 characters, or white space. However, if you need this feature, it is available.
6433 If a key begins with a doublequote character, it is terminated only by a
6434 matching quote (or end of line), and the normal escaping rules apply to its
6435 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6436 quoted keys (exactly as for unquoted keys). There is no special handling of
6437 quotes for the data part of an &(lsearch)& line.
6438
6439 .next
6440 .cindex "NIS lookup type"
6441 .cindex "lookup" "NIS"
6442 .cindex "binary zero" "in lookup key"
6443 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6444 the given key, without a terminating binary zero. There is a variant called
6445 &(nis0)& which does include the terminating binary zero in the key. This is
6446 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6447 aliases; the full map names must be used.
6448
6449 .next
6450 .cindex "wildlsearch lookup type"
6451 .cindex "lookup" "wildlsearch"
6452 .cindex "nwildlsearch lookup type"
6453 .cindex "lookup" "nwildlsearch"
6454 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6455 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6456 the file may be wildcarded. The difference between these two lookup types is
6457 that for &(wildlsearch)&, each key in the file is string-expanded before being
6458 used, whereas for &(nwildlsearch)&, no expansion takes place.
6459
6460 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6461 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6462 file that are regular expressions can be made case-sensitive by the use of
6463 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6464
6465 . ==== As this is a nested list, any displays it contains must be indented
6466 . ==== as otherwise they are too far to the left.
6467
6468 .olist
6469 The string may begin with an asterisk to mean &"ends with"&. For example:
6470 .code
6471     *.a.b.c       data for anything.a.b.c
6472     *fish         data for anythingfish
6473 .endd
6474 .next
6475 The string may begin with a circumflex to indicate a regular expression. For
6476 example, for &(wildlsearch)&:
6477 .code
6478     ^\N\d+\.a\.b\N    data for <digits>.a.b
6479 .endd
6480 Note the use of &`\N`& to disable expansion of the contents of the regular
6481 expression. If you are using &(nwildlsearch)&, where the keys are not
6482 string-expanded, the equivalent entry is:
6483 .code
6484     ^\d+\.a\.b        data for <digits>.a.b
6485 .endd
6486 The case-insensitive flag is set at the start of compiling the regular
6487 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6488 For example, to make the entire pattern case-sensitive:
6489 .code
6490     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6491 .endd
6492
6493 If the regular expression contains white space or colon characters, you must
6494 either quote it (see &(lsearch)& above), or represent these characters in other
6495 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6496 colon. This may be easier than quoting, because if you quote, you have to
6497 escape all the backslashes inside the quotes.
6498
6499 &*Note*&: It is not possible to capture substrings in a regular expression
6500 match for later use, because the results of all lookups are cached. If a lookup
6501 is repeated, the result is taken from the cache, and no actual pattern matching
6502 takes place. The values of all the numeric variables are unset after a
6503 &((n)wildlsearch)& match.
6504
6505 .next
6506 Although I cannot see it being of much use, the general matching function that
6507 is used to implement &((n)wildlsearch)& means that the string may begin with a
6508 lookup name terminated by a semicolon, and followed by lookup data. For
6509 example:
6510 .code
6511     cdb;/some/file  data for keys that match the file
6512 .endd
6513 The data that is obtained from the nested lookup is discarded.
6514 .endlist olist
6515
6516 Keys that do not match any of these patterns are interpreted literally. The
6517 continuation rules for the data are the same as for &(lsearch)&, and keys may
6518 be followed by optional colons.
6519
6520 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6521 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6522 lookup types support only literal keys.
6523 .endlist ilist
6524
6525
6526 .section "Query-style lookup types" "SECID62"
6527 .cindex "lookup" "query-style types"
6528 .cindex "query-style lookup" "list of types"
6529 The supported query-style lookup types are listed below. Further details about
6530 many of them are given in later sections.
6531
6532 .ilist
6533 .cindex "DNS" "as a lookup type"
6534 .cindex "lookup" "DNS"
6535 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6536 are given in the supplied query. The resulting data is the contents of the
6537 records. See section &<<SECTdnsdb>>&.
6538 .next
6539 .cindex "InterBase lookup type"
6540 .cindex "lookup" "InterBase"
6541 &(ibase)&: This does a lookup in an InterBase database.
6542 .next
6543 .cindex "LDAP" "lookup type"
6544 .cindex "lookup" "LDAP"
6545 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6546 returns attributes from a single entry. There is a variant called &(ldapm)&
6547 that permits values from multiple entries to be returned. A third variant
6548 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6549 any attribute values. See section &<<SECTldap>>&.
6550 .next
6551 .cindex "MySQL" "lookup type"
6552 .cindex "lookup" "MySQL"
6553 &(mysql)&: The format of the query is an SQL statement that is passed to a
6554 MySQL database. See section &<<SECTsql>>&.
6555 .next
6556 .cindex "NIS+ lookup type"
6557 .cindex "lookup" "NIS+"
6558 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6559 the field to be returned. See section &<<SECTnisplus>>&.
6560 .next
6561 .cindex "Oracle" "lookup type"
6562 .cindex "lookup" "Oracle"
6563 &(oracle)&: The format of the query is an SQL statement that is passed to an
6564 Oracle database. See section &<<SECTsql>>&.
6565 .next
6566 .cindex "lookup" "passwd"
6567 .cindex "passwd lookup type"
6568 .cindex "&_/etc/passwd_&"
6569 &(passwd)& is a query-style lookup with queries that are just user names. The
6570 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6571 success, the result string is the same as you would get from an &(lsearch)&
6572 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6573 password value. For example:
6574 .code
6575 *:42:42:King Rat:/home/kr:/bin/bash
6576 .endd
6577 .next
6578 .cindex "PostgreSQL lookup type"
6579 .cindex "lookup" "PostgreSQL"
6580 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6581 PostgreSQL database. See section &<<SECTsql>>&.
6582
6583 .next
6584 .cindex "sqlite lookup type"
6585 .cindex "lookup" "sqlite"
6586 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6587 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6588
6589 .next
6590 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6591 not likely to be useful in normal operation.
6592 .next
6593 .cindex "whoson lookup type"
6594 .cindex "lookup" "whoson"
6595 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6596 allows a server to check whether a particular (dynamically allocated) IP
6597 address is currently allocated to a known (trusted) user and, optionally, to
6598 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6599 at one time for &"POP before SMTP"& authentication, but that approach has been
6600 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6601 &"POP before SMTP"& checking using ACL statements such as
6602 .code
6603 require condition = \
6604   ${lookup whoson {$sender_host_address}{yes}{no}}
6605 .endd
6606 The query consists of a single IP address. The value returned is the name of
6607 the authenticated user, which is stored in the variable &$value$&. However, in
6608 this example, the data in &$value$& is not used; the result of the lookup is
6609 one of the fixed strings &"yes"& or &"no"&.
6610 .endlist
6611
6612
6613
6614 .section "Temporary errors in lookups" "SECID63"
6615 .cindex "lookup" "temporary error in"
6616 Lookup functions can return temporary error codes if the lookup cannot be
6617 completed. For example, an SQL or LDAP database might be unavailable. For this
6618 reason, it is not advisable to use a lookup that might do this for critical
6619 options such as a list of local domains.
6620
6621 When a lookup cannot be completed in a router or transport, delivery
6622 of the message (to the relevant address) is deferred, as for any other
6623 temporary error. In other circumstances Exim may assume the lookup has failed,
6624 or may give up altogether.
6625
6626
6627
6628 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6629 .cindex "wildcard lookups"
6630 .cindex "lookup" "default values"
6631 .cindex "lookup" "wildcard"
6632 .cindex "lookup" "* added to type"
6633 .cindex "default" "in single-key lookups"
6634 In this context, a &"default value"& is a value specified by the administrator
6635 that is to be used if a lookup fails.
6636
6637 &*Note:*& This section applies only to single-key lookups. For query-style
6638 lookups, the facilities of the query language must be used. An attempt to
6639 specify a default for a query-style lookup provokes an error.
6640
6641 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6642 and the initial lookup fails, the key &"*"& is looked up in the file to
6643 provide a default value. See also the section on partial matching below.
6644
6645 .cindex "*@ with single-key lookup"
6646 .cindex "lookup" "*@ added to type"
6647 .cindex "alias file" "per-domain default"
6648 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6649 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6650 character, a second lookup is done with everything before the last @ replaced
6651 by *. This makes it possible to provide per-domain defaults in alias files
6652 that include the domains in the keys. If the second lookup fails (or doesn't
6653 take place because there is no @ in the key), &"*"& is looked up.
6654 For example, a &(redirect)& router might contain:
6655 .code
6656 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6657 .endd
6658 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6659 looks up these keys, in this order:
6660 .code
6661 jane@eyre.example
6662 *@eyre.example
6663 *
6664 .endd
6665 The data is taken from whichever key it finds first. &*Note*&: In an
6666 &(lsearch)& file, this does not mean the first of these keys in the file. A
6667 complete scan is done for each key, and only if it is not found at all does
6668 Exim move on to try the next key.
6669
6670
6671
6672 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6673 .cindex "partial matching"
6674 .cindex "wildcard lookups"
6675 .cindex "lookup" "partial matching"
6676 .cindex "lookup" "wildcard"
6677 .cindex "asterisk" "in search type"
6678 The normal operation of a single-key lookup is to search the file for an exact
6679 match with the given key. However, in a number of situations where domains are
6680 being looked up, it is useful to be able to do partial matching. In this case,
6681 information in the file that has a key starting with &"*."& is matched by any
6682 domain that ends with the components that follow the full stop. For example, if
6683 a key in a DBM file is
6684 .code
6685 *.dates.fict.example
6686 .endd
6687 then when partial matching is enabled this is matched by (amongst others)
6688 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6689 by &'dates.fict.example'&, if that does not appear as a separate key in the
6690 file.
6691
6692 &*Note*&: Partial matching is not available for query-style lookups. It is
6693 also not available for any lookup items in address lists (see section
6694 &<<SECTaddresslist>>&).
6695
6696 Partial matching is implemented by doing a series of separate lookups using
6697 keys constructed by modifying the original subject key. This means that it can
6698 be used with any of the single-key lookup types, provided that
6699 partial matching keys
6700 beginning with a special prefix (default &"*."&) are included in the data file.
6701 Keys in the file that do not begin with the prefix are matched only by
6702 unmodified subject keys when partial matching is in use.
6703
6704 Partial matching is requested by adding the string &"partial-"& to the front of
6705 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6706 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6707 is added at the start of the subject key, and it is looked up again. If that
6708 fails, further lookups are tried with dot-separated components removed from the
6709 start of the subject key, one-by-one, and &"*."& added on the front of what
6710 remains.
6711
6712 A minimum number of two non-* components are required. This can be adjusted
6713 by including a number before the hyphen in the search type. For example,
6714 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6715 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6716 subject key is &'2250.dates.fict.example'& then the following keys are looked
6717 up when the minimum number of non-* components is two:
6718 .code
6719 2250.dates.fict.example
6720 *.2250.dates.fict.example
6721 *.dates.fict.example
6722 *.fict.example
6723 .endd
6724 As soon as one key in the sequence is successfully looked up, the lookup
6725 finishes.
6726
6727 .cindex "lookup" "partial matching &-- changing prefix"
6728 .cindex "prefix" "for partial matching"
6729 The use of &"*."& as the partial matching prefix is a default that can be
6730 changed. The motivation for this feature is to allow Exim to operate with file
6731 formats that are used by other MTAs. A different prefix can be supplied in
6732 parentheses instead of the hyphen after &"partial"&. For example:
6733 .code
6734 domains = partial(.)lsearch;/some/file
6735 .endd
6736 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6737 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6738 components is unchanged). The prefix may consist of any punctuation characters
6739 other than a closing parenthesis. It may be empty, for example:
6740 .code
6741 domains = partial1()cdb;/some/file
6742 .endd
6743 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6744 &`a.b.c`&, &`b.c`&, and &`c`&.
6745
6746 If &"partial0"& is specified, what happens at the end (when the lookup with
6747 just one non-wild component has failed, and the original key is shortened right
6748 down to the null string) depends on the prefix:
6749
6750 .ilist
6751 If the prefix has zero length, the whole lookup fails.
6752 .next
6753 If the prefix has length 1, a lookup for just the prefix is done. For
6754 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6755 .next
6756 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6757 remainder is looked up. With the default prefix, therefore, the final lookup is
6758 for &"*"& on its own.
6759 .next
6760 Otherwise, the whole prefix is looked up.
6761 .endlist
6762
6763
6764 If the search type ends in &"*"& or &"*@"& (see section
6765 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6766 this implies happens after all partial lookups have failed. If &"partial0"& is
6767 specified, adding &"*"& to the search type has no effect with the default
6768 prefix, because the &"*"& key is already included in the sequence of partial
6769 lookups. However, there might be a use for lookup types such as
6770 &"partial0(.)lsearch*"&.
6771
6772 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6773 in domain lists and the like. Partial matching works only in terms of
6774 dot-separated components; a key such as &`*fict.example`&
6775 in a database file is useless, because the asterisk in a partial matching
6776 subject key is always followed by a dot.
6777
6778
6779
6780
6781 .section "Lookup caching" "SECID64"
6782 .cindex "lookup" "caching"
6783 .cindex "caching" "lookup data"
6784 Exim caches all lookup results in order to avoid needless repetition of
6785 lookups. However, because (apart from the daemon) Exim operates as a collection
6786 of independent, short-lived processes, this caching applies only within a
6787 single Exim process. There is no inter-process lookup caching facility.
6788
6789 For single-key lookups, Exim keeps the relevant files open in case there is
6790 another lookup that needs them. In some types of configuration this can lead to
6791 many files being kept open for messages with many recipients. To avoid hitting
6792 the operating system limit on the number of simultaneously open files, Exim
6793 closes the least recently used file when it needs to open more files than its
6794 own internal limit, which can be changed via the &%lookup_open_max%& option.
6795
6796 The single-key lookup files are closed and the lookup caches are flushed at
6797 strategic points during delivery &-- for example, after all routing is
6798 complete.
6799
6800
6801
6802
6803 .section "Quoting lookup data" "SECID65"
6804 .cindex "lookup" "quoting"
6805 .cindex "quoting" "in lookups"
6806 When data from an incoming message is included in a query-style lookup, there
6807 is the possibility of special characters in the data messing up the syntax of
6808 the query. For example, a NIS+ query that contains
6809 .code
6810 [name=$local_part]
6811 .endd
6812 will be broken if the local part happens to contain a closing square bracket.
6813 For NIS+, data can be enclosed in double quotes like this:
6814 .code
6815 [name="$local_part"]
6816 .endd
6817 but this still leaves the problem of a double quote in the data. The rule for
6818 NIS+ is that double quotes must be doubled. Other lookup types have different
6819 rules, and to cope with the differing requirements, an expansion operator
6820 of the following form is provided:
6821 .code
6822 ${quote_<lookup-type>:<string>}
6823 .endd
6824 For example, the safest way to write the NIS+ query is
6825 .code
6826 [name="${quote_nisplus:$local_part}"]
6827 .endd
6828 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6829 operator can be used for all lookup types, but has no effect for single-key
6830 lookups, since no quoting is ever needed in their key strings.
6831
6832
6833
6834
6835 .section "More about dnsdb" "SECTdnsdb"
6836 .cindex "dnsdb lookup"
6837 .cindex "lookup" "dnsdb"
6838 .cindex "DNS" "as a lookup type"
6839 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6840 of a record type and a domain name, separated by an equals sign. For example,
6841 an expansion string could contain:
6842 .code
6843 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6844 .endd
6845 If the lookup succeeds, the result is placed in &$value$&, which in this case
6846 is used on its own as the result. If the lookup does not succeed, the
6847 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6848 &<<SECTforexpfai>>& for an explanation of what this means.
6849
6850 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6851 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6852 configured). If no type is given, TXT is assumed. When the type is PTR,
6853 the data can be an IP address, written as normal; inversion and the addition of
6854 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6855 .code
6856 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6857 .endd
6858 If the data for a PTR record is not a syntactically valid IP address, it is not
6859 altered and nothing is added.
6860
6861 .cindex "MX record" "in &(dnsdb)& lookup"
6862 .cindex "SRV record" "in &(dnsdb)& lookup"
6863 For an MX lookup, both the preference value and the host name are returned for
6864 each record, separated by a space. For an SRV lookup, the priority, weight,
6865 port, and host name are returned for each record, separated by spaces.
6866
6867 For any record type, if multiple records are found (or, for A6 lookups, if a
6868 single record leads to multiple addresses), the data is returned as a
6869 concatenation, with newline as the default separator. The order, of course,
6870 depends on the DNS resolver. You can specify a different separator character
6871 between multiple records by putting a right angle-bracket followed immediately
6872 by the new separator at the start of the query. For example:
6873 .code
6874 ${lookup dnsdb{>: a=host1.example}}
6875 .endd
6876 It is permitted to specify a space as the separator character. Further
6877 white space is ignored.
6878
6879 .cindex "TXT record" "in &(dnsdb)& lookup"
6880 .cindex "SPF record" "in &(dnsdb)& lookup"
6881 For TXT records with multiple items of data, only the first item is returned,
6882 unless a separator for them is specified using a comma after the separator
6883 character followed immediately by the TXT record item separator. To concatenate
6884 items without a separator, use a semicolon instead. For SPF records the
6885 default behaviour is to concatenate multiple items without using a separator.
6886 .code
6887 ${lookup dnsdb{>\n,: txt=a.b.example}}
6888 ${lookup dnsdb{>\n; txt=a.b.example}}
6889 ${lookup dnsdb{spf=example.org}}
6890 .endd
6891 It is permitted to specify a space as the separator character. Further
6892 white space is ignored.
6893
6894 .section "Pseudo dnsdb record types" "SECID66"
6895 .cindex "MX record" "in &(dnsdb)& lookup"
6896 By default, both the preference value and the host name are returned for
6897 each MX record, separated by a space. If you want only host names, you can use
6898 the pseudo-type MXH:
6899 .code
6900 ${lookup dnsdb{mxh=a.b.example}}
6901 .endd
6902 In this case, the preference values are omitted, and just the host names are
6903 returned.
6904
6905 .cindex "name server for enclosing domain"
6906 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6907 records on the given domain, but if none are found, it removes the first
6908 component of the domain name, and tries again. This process continues until NS
6909 records are found or there are no more components left (or there is a DNS
6910 error). In other words, it may return the name servers for a top-level domain,
6911 but it never returns the root name servers. If there are no NS records for the
6912 top-level domain, the lookup fails. Consider these examples:
6913 .code
6914 ${lookup dnsdb{zns=xxx.quercite.com}}
6915 ${lookup dnsdb{zns=xxx.edu}}
6916 .endd
6917 Assuming that in each case there are no NS records for the full domain name,
6918 the first returns the name servers for &%quercite.com%&, and the second returns
6919 the name servers for &%edu%&.
6920
6921 You should be careful about how you use this lookup because, unless the
6922 top-level domain does not exist, the lookup always returns some host names. The
6923 sort of use to which this might be put is for seeing if the name servers for a
6924 given domain are on a blacklist. You can probably assume that the name servers
6925 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6926 such a list.
6927
6928 .cindex "CSA" "in &(dnsdb)& lookup"
6929 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6930 records according to the CSA rules, which are described in section
6931 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6932 not sufficient because of the extra parent domain search behaviour of CSA. The
6933 result of a successful lookup such as:
6934 .code
6935 ${lookup dnsdb {csa=$sender_helo_name}}
6936 .endd
6937 has two space-separated fields: an authorization code and a target host name.
6938 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6939 authorization required but absent, or &"?"& for unknown.
6940
6941 .cindex "A+" "in &(dnsdb)& lookup"
6942 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6943 and then an A lookup.  All results are returned; defer processing
6944 (see below) is handled separately for each lookup.  Example:
6945 .code
6946 ${lookup dnsdb {>; a+=$sender_helo_name}}
6947 .endd
6948
6949
6950 .section "Multiple dnsdb lookups" "SECID67"
6951 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6952 However, you can specify a list of domains or IP addresses in a single
6953 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6954 the default separator, but with the ability to change this. For example:
6955 .code
6956 ${lookup dnsdb{one.domain.com:two.domain.com}}
6957 ${lookup dnsdb{a=one.host.com:two.host.com}}
6958 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6959 .endd
6960 In order to retain backwards compatibility, there is one special case: if
6961 the lookup type is PTR and no change of separator is specified, Exim looks
6962 to see if the rest of the string is precisely one IPv6 address. In this
6963 case, it does not treat it as a list.
6964
6965 The data from each lookup is concatenated, with newline separators by default,
6966 in the same way that multiple DNS records for a single item are handled. A
6967 different separator can be specified, as described above.
6968
6969 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6970 temporary DNS error for any of them, the behaviour is controlled by
6971 an optional keyword followed by a comma that may appear before the record
6972 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6973 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6974 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6975 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6976 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6977 error causes the whole lookup to defer only if none of the other lookups
6978 succeed. The default is &"lax"&, so the following lookups are equivalent:
6979 .code
6980 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6981 ${lookup dnsdb{a=one.host.com:two.host.com}}
6982 .endd
6983 Thus, in the default case, as long as at least one of the DNS lookups
6984 yields some data, the lookup succeeds.
6985
6986
6987
6988
6989 .section "More about LDAP" "SECTldap"
6990 .cindex "LDAP" "lookup, more about"
6991 .cindex "lookup" "LDAP"
6992 .cindex "Solaris" "LDAP"
6993 The original LDAP implementation came from the University of Michigan; this has
6994 become &"Open LDAP"&, and there are now two different releases. Another
6995 implementation comes from Netscape, and Solaris 7 and subsequent releases
6996 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6997 the lookup function level, their error handling is different. For this reason
6998 it is necessary to set a compile-time variable when building Exim with LDAP, to
6999 indicate which LDAP library is in use. One of the following should appear in
7000 your &_Local/Makefile_&:
7001 .code
7002 LDAP_LIB_TYPE=UMICHIGAN
7003 LDAP_LIB_TYPE=OPENLDAP1
7004 LDAP_LIB_TYPE=OPENLDAP2
7005 LDAP_LIB_TYPE=NETSCAPE
7006 LDAP_LIB_TYPE=SOLARIS
7007 .endd
7008 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7009 same interface as the University of Michigan version.
7010
7011 There are three LDAP lookup types in Exim. These behave slightly differently in
7012 the way they handle the results of a query:
7013
7014 .ilist
7015 &(ldap)& requires the result to contain just one entry; if there are more, it
7016 gives an error.
7017 .next
7018 &(ldapdn)& also requires the result to contain just one entry, but it is the
7019 Distinguished Name that is returned rather than any attribute values.
7020 .next
7021 &(ldapm)& permits the result to contain more than one entry; the attributes
7022 from all of them are returned.
7023 .endlist
7024
7025
7026 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7027 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7028 the data returned by a successful lookup is described in the next section.
7029 First we explain how LDAP queries are coded.
7030
7031
7032 .section "Format of LDAP queries" "SECTforldaque"
7033 .cindex "LDAP" "query format"
7034 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7035 the configuration of a &(redirect)& router one might have this setting:
7036 .code
7037 data = ${lookup ldap \
7038   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7039   c=UK?mailbox?base?}}
7040 .endd
7041 .cindex "LDAP" "with TLS"
7042 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7043 secure (encrypted) LDAP connections. The second of these ensures that an
7044 encrypted TLS connection is used.
7045
7046 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7047 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7048 See the &%ldap_start_tls%& option.
7049
7050
7051 .section "LDAP quoting" "SECID68"
7052 .cindex "LDAP" "quoting"
7053 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7054 and the second because the LDAP query is represented as a URL. Furthermore,
7055 within an LDAP query, two different kinds of quoting are required. For this
7056 reason, there are two different LDAP-specific quoting operators.
7057
7058 The &%quote_ldap%& operator is designed for use on strings that are part of
7059 filter specifications. Conceptually, it first does the following conversions on
7060 the string:
7061 .code
7062 *   =>   \2A
7063 (   =>   \28
7064 )   =>   \29
7065 \   =>   \5C
7066 .endd
7067 in accordance with RFC 2254. The resulting string is then quoted according
7068 to the rules for URLs, that is, all non-alphanumeric characters except
7069 .code
7070 ! $ ' - . _ ( ) * +
7071 .endd
7072 are converted to their hex values, preceded by a percent sign. For example:
7073 .code
7074 ${quote_ldap: a(bc)*, a<yz>; }
7075 .endd
7076 yields
7077 .code
7078 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7079 .endd
7080 Removing the URL quoting, this is (with a leading and a trailing space):
7081 .code
7082 a\28bc\29\2A, a<yz>;
7083 .endd
7084 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7085 base DN specifications in queries. Conceptually, it first converts the string
7086 by inserting a backslash in front of any of the following characters:
7087 .code
7088 , + " \ < > ;
7089 .endd
7090 It also inserts a backslash before any leading spaces or # characters, and
7091 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7092 is then quoted according to the rules for URLs. For example:
7093 .code
7094 ${quote_ldap_dn: a(bc)*, a<yz>; }
7095 .endd
7096 yields
7097 .code
7098 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7099 .endd
7100 Removing the URL quoting, this is (with a trailing space):
7101 .code
7102 \ a(bc)*\, a\<yz\>\;\
7103 .endd
7104 There are some further comments about quoting in the section on LDAP
7105 authentication below.
7106
7107
7108 .section "LDAP connections" "SECID69"
7109 .cindex "LDAP" "connections"
7110 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7111 is in use, via a Unix domain socket. The example given above does not specify
7112 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7113 by starting it with
7114 .code
7115 ldap://<hostname>:<port>/...
7116 .endd
7117 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7118 used. When no server is specified in a query, a list of default servers is
7119 taken from the &%ldap_default_servers%& configuration option. This supplies a
7120 colon-separated list of servers which are tried in turn until one successfully
7121 handles a query, or there is a serious error. Successful handling either
7122 returns the requested data, or indicates that it does not exist. Serious errors
7123 are syntactical, or multiple values when only a single value is expected.
7124 Errors which cause the next server to be tried are connection failures, bind
7125 failures, and timeouts.
7126
7127 For each server name in the list, a port number can be given. The standard way
7128 of specifying a host and port is to use a colon separator (RFC 1738). Because
7129 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7130 doubled. For example
7131 .code
7132 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7133 .endd
7134 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7135 to the LDAP library with no server name, and the library's default (normally
7136 the local host) is used.
7137
7138 If you are using the OpenLDAP library, you can connect to an LDAP server using
7139 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7140 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7141 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7142 not available.
7143
7144 For this type of connection, instead of a host name for the server, a pathname
7145 for the socket is required, and the port number is not relevant. The pathname
7146 can be specified either as an item in &%ldap_default_servers%&, or inline in
7147 the query. In the former case, you can have settings such as
7148 .code
7149 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7150 .endd
7151 When the pathname is given in the query, you have to escape the slashes as
7152 &`%2F`& to fit in with the LDAP URL syntax. For example:
7153 .code
7154 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7155 .endd
7156 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7157 a pathname, it uses the Unix domain socket code, even if the query actually
7158 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7159 socket connection. This behaviour means that you can use a setting of
7160 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7161 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7162 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7163 backup host.
7164
7165 If an explicit &`ldapi`& type is given in a query when a host name is
7166 specified, an error is diagnosed. However, if there are more items in
7167 &%ldap_default_servers%&, they are tried. In other words:
7168
7169 .ilist
7170 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7171 interface.
7172 .next
7173 Using &`ldapi`& with a host name causes an error.
7174 .endlist
7175
7176
7177 Using &`ldapi`& with no host or path in the query, and no setting of
7178 &%ldap_default_servers%&, does whatever the library does by default.
7179
7180
7181
7182 .section "LDAP authentication and control information" "SECID70"
7183 .cindex "LDAP" "authentication"
7184 The LDAP URL syntax provides no way of passing authentication and other control
7185 information to the server. To make this possible, the URL in an LDAP query may
7186 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7187 spaces. If a value contains spaces it must be enclosed in double quotes, and
7188 when double quotes are used, backslash is interpreted in the usual way inside
7189 them. The following names are recognized:
7190 .display
7191 &`DEREFERENCE`&  set the dereferencing parameter
7192 &`NETTIME    `&  set a timeout for a network operation
7193 &`USER       `&  set the DN, for authenticating the LDAP bind
7194 &`PASS       `&  set the password, likewise
7195 &`REFERRALS  `&  set the referrals parameter
7196 &`SIZE       `&  set the limit for the number of entries returned
7197 &`TIME       `&  set the maximum waiting time for a query
7198 .endd
7199 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7200 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7201 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7202 library from trying to follow referrals issued by the LDAP server.
7203
7204 The name CONNECT is an obsolete name for NETTIME, retained for
7205 backwards compatibility. This timeout (specified as a number of seconds) is
7206 enforced from the client end for operations that can be carried out over a
7207 network. Specifically, it applies to network connections and calls to the
7208 &'ldap_result()'& function. If the value is greater than zero, it is used if
7209 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7210 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7211 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7212 Netscape SDK; for OpenLDAP no action is taken.
7213
7214 The TIME parameter (also a number of seconds) is passed to the server to
7215 set a server-side limit on the time taken to complete a search.
7216
7217
7218 Here is an example of an LDAP query in an Exim lookup that uses some of these
7219 values. This is a single line, folded to fit on the page:
7220 .code
7221 ${lookup ldap
7222   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7223   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7224   {$value}fail}
7225 .endd
7226 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7227 any of the auxiliary data. Exim configuration settings that include lookups
7228 which contain password information should be preceded by &"hide"& to prevent
7229 non-admin users from using the &%-bP%& option to see their values.
7230
7231 The auxiliary data items may be given in any order. The default is no
7232 connection timeout (the system timeout is used), no user or password, no limit
7233 on the number of entries returned, and no time limit on queries.
7234
7235 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7236 removes any URL quoting that it may contain before passing it LDAP. Apparently
7237 some libraries do this for themselves, but some do not. Removing the URL
7238 quoting has two advantages:
7239
7240 .ilist
7241 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7242 DNs as with DNs inside actual queries.
7243 .next
7244 It permits spaces inside USER= DNs.
7245 .endlist
7246
7247 For example, a setting such as
7248 .code
7249 USER=cn=${quote_ldap_dn:$1}
7250 .endd
7251 should work even if &$1$& contains spaces.
7252
7253 Expanded data for the PASS= value should be quoted using the &%quote%&
7254 expansion operator, rather than the LDAP quote operators. The only reason this
7255 field needs quoting is to ensure that it conforms to the Exim syntax, which
7256 does not allow unquoted spaces. For example:
7257 .code
7258 PASS=${quote:$3}
7259 .endd
7260 The LDAP authentication mechanism can be used to check passwords as part of
7261 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7262 &<<CHAPexpand>>&.
7263
7264
7265
7266 .section "Format of data returned by LDAP" "SECID71"
7267 .cindex "LDAP" "returned data formats"
7268 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7269 as a sequence of values, for example
7270 .code
7271 cn=manager, o=University of Cambridge, c=UK
7272 .endd
7273 The &(ldap)& lookup type generates an error if more than one entry matches the
7274 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7275 the result between the data from different entries. It is possible for multiple
7276 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7277 you know that whatever values are returned all came from a single entry in the
7278 directory.
7279
7280 In the common case where you specify a single attribute in your LDAP query, the
7281 result is not quoted, and does not contain the attribute name. If the attribute
7282 has multiple values, they are separated by commas.
7283
7284 If you specify multiple attributes, the result contains space-separated, quoted
7285 strings, each preceded by the attribute name and an equals sign. Within the
7286 quotes, the quote character, backslash, and newline are escaped with
7287 backslashes, and commas are used to separate multiple values for the attribute.
7288 Apart from the escaping, the string within quotes takes the same form as the
7289 output when a single attribute is requested. Specifying no attributes is the
7290 same as specifying all of an entry's attributes.
7291
7292 Here are some examples of the output format. The first line of each pair is an
7293 LDAP query, and the second is the data that is returned. The attribute called
7294 &%attr1%& has two values, whereas &%attr2%& has only one value:
7295 .code
7296 ldap:///o=base?attr1?sub?(uid=fred)
7297 value1.1, value1.2
7298
7299 ldap:///o=base?attr2?sub?(uid=fred)
7300 value two
7301
7302 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7303 attr1="value1.1, value1.2" attr2="value two"
7304
7305 ldap:///o=base??sub?(uid=fred)
7306 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7307 .endd
7308 The &%extract%& operator in string expansions can be used to pick out
7309 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7310 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7311 results of LDAP lookups.
7312
7313
7314
7315
7316 .section "More about NIS+" "SECTnisplus"
7317 .cindex "NIS+ lookup type"
7318 .cindex "lookup" "NIS+"
7319 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7320 and field name. If this is given, the result of a successful query is the
7321 contents of the named field; otherwise the result consists of a concatenation
7322 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7323 values containing spaces are quoted. For example, the query
7324 .code
7325 [name=mg1456],passwd.org_dir
7326 .endd
7327 might return the string
7328 .code
7329 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7330 home=/home/mg1456 shell=/bin/bash shadow=""
7331 .endd
7332 (split over two lines here to fit on the page), whereas
7333 .code
7334 [name=mg1456],passwd.org_dir:gcos
7335 .endd
7336 would just return
7337 .code
7338 Martin Guerre
7339 .endd
7340 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7341 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7342 operator is to double any quote characters within the text.
7343
7344
7345
7346 .section "SQL lookups" "SECTsql"
7347 .cindex "SQL lookup types"
7348 .cindex "MySQL" "lookup type"
7349 .cindex "PostgreSQL lookup type"
7350 .cindex "lookup" "MySQL"
7351 .cindex "lookup" "PostgreSQL"
7352 .cindex "Oracle" "lookup type"
7353 .cindex "lookup" "Oracle"
7354 .cindex "InterBase lookup type"
7355 .cindex "lookup" "InterBase"
7356 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7357 databases. Queries for these databases contain SQL statements, so an example
7358 might be
7359 .code
7360 ${lookup mysql{select mailbox from users where id='userx'}\
7361   {$value}fail}
7362 .endd
7363 If the result of the query contains more than one field, the data for each
7364 field in the row is returned, preceded by its name, so the result of
7365 .code
7366 ${lookup pgsql{select home,name from users where id='userx'}\
7367   {$value}}
7368 .endd
7369 might be
7370 .code
7371 home=/home/userx name="Mister X"
7372 .endd
7373 Empty values and values containing spaces are double quoted, with embedded
7374 quotes escaped by a backslash. If the result of the query contains just one
7375 field, the value is passed back verbatim, without a field name, for example:
7376 .code
7377 Mister X
7378 .endd
7379 If the result of the query yields more than one row, it is all concatenated,
7380 with a newline between the data for each row.
7381
7382
7383 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7384 .cindex "MySQL" "lookup type"
7385 .cindex "PostgreSQL lookup type"
7386 .cindex "lookup" "MySQL"
7387 .cindex "lookup" "PostgreSQL"
7388 .cindex "Oracle" "lookup type"
7389 .cindex "lookup" "Oracle"
7390 .cindex "InterBase lookup type"
7391 .cindex "lookup" "InterBase"
7392 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7393 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7394 option (as appropriate) must be set to a colon-separated list of server
7395 information.
7396 (For MySQL and PostgreSQL only, the global option need not be set if all
7397 queries contain their own server information &-- see section
7398 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7399 items: host name, database name, user name, and password. In the case of
7400 Oracle, the host name field is used for the &"service name"&, and the database
7401 name field is not used and should be empty. For example:
7402 .code
7403 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7404 .endd
7405 Because password data is sensitive, you should always precede the setting with
7406 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7407 option. Here is an example where two MySQL servers are listed:
7408 .code
7409 hide mysql_servers = localhost/users/root/secret:\
7410                      otherhost/users/root/othersecret
7411 .endd
7412 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7413 because this is a colon-separated list, the colon has to be doubled. For each
7414 query, these parameter groups are tried in order until a connection is made and
7415 a query is successfully processed. The result of a query may be that no data is
7416 found, but that is still a successful query. In other words, the list of
7417 servers provides a backup facility, not a list of different places to look.
7418
7419 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7420 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7421 respectively, and the characters single-quote, double-quote, and backslash
7422 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7423 addition, escapes the percent and underscore characters. This cannot be done
7424 for MySQL because these escapes are not recognized in contexts where these
7425 characters are not special.
7426
7427 .section "Specifying the server in the query" "SECTspeserque"
7428 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7429 it is possible to specify a list of servers with an individual query. This is
7430 done by starting the query with
7431 .display
7432 &`servers=`&&'server1:server2:server3:...'&&`;`&
7433 .endd
7434 Each item in the list may take one of two forms:
7435 .olist
7436 If it contains no slashes it is assumed to be just a host name. The appropriate
7437 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7438 of the same name, and the remaining parameters (database, user, password) are
7439 taken from there.
7440 .next
7441 If it contains any slashes, it is taken as a complete parameter set.
7442 .endlist
7443 The list of servers is used in exactly the same way as the global list.
7444 Once a connection to a server has happened and a query has been
7445 successfully executed, processing of the lookup ceases.
7446
7447 This feature is intended for use in master/slave situations where updates
7448 are occurring and you want to update the master rather than a slave. If the
7449 master is in the list as a backup for reading, you might have a global setting
7450 like this:
7451 .code
7452 mysql_servers = slave1/db/name/pw:\
7453                 slave2/db/name/pw:\
7454                 master/db/name/pw
7455 .endd
7456 In an updating lookup, you could then write:
7457 .code
7458 ${lookup mysql{servers=master; UPDATE ...} }
7459 .endd
7460 That query would then be sent only to the master server. If, on the other hand,
7461 the master is not to be used for reading, and so is not present in the global
7462 option, you can still update it by a query of this form:
7463 .code
7464 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7465 .endd
7466
7467
7468 .section "Special MySQL features" "SECID73"
7469 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7470 causes a connection to the server on the local host by means of a Unix domain
7471 socket. An alternate socket can be specified in parentheses. The full syntax of
7472 each item in &%mysql_servers%& is:
7473 .display
7474 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7475   <&'user'&>/<&'password'&>
7476 .endd
7477 Any of the three sub-parts of the first field can be omitted. For normal use on
7478 the local host it can be left blank or set to just &"localhost"&.
7479
7480 No database need be supplied &-- but if it is absent here, it must be given in
7481 the queries.
7482
7483 If a MySQL query is issued that does not request any data (an insert, update,
7484 or delete command), the result of the lookup is the number of rows affected.
7485
7486 &*Warning*&: This can be misleading. If an update does not actually change
7487 anything (for example, setting a field to the value it already has), the result
7488 is zero because no rows are affected.
7489
7490
7491 .section "Special PostgreSQL features" "SECID74"
7492 PostgreSQL lookups can also use Unix domain socket connections to the database.
7493 This is usually faster and costs less CPU time than a TCP/IP connection.
7494 However it can be used only if the mail server runs on the same machine as the
7495 database server. A configuration line for PostgreSQL via Unix domain sockets
7496 looks like this:
7497 .code
7498 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7499 .endd
7500 In other words, instead of supplying a host name, a path to the socket is
7501 given. The path name is enclosed in parentheses so that its slashes aren't
7502 visually confused with the delimiters for the other server parameters.
7503
7504 If a PostgreSQL query is issued that does not request any data (an insert,
7505 update, or delete command), the result of the lookup is the number of rows
7506 affected.
7507
7508 .section "More about SQLite" "SECTsqlite"
7509 .cindex "lookup" "SQLite"
7510 .cindex "sqlite lookup type"
7511 SQLite is different to the other SQL lookups because a file name is required in
7512 addition to the SQL query. An SQLite database is a single file, and there is no
7513 daemon as in the other SQL databases. The interface to Exim requires the name
7514 of the file, as an absolute path, to be given at the start of the query. It is
7515 separated from the query by white space. This means that the path name cannot
7516 contain white space. Here is a lookup expansion example:
7517 .code
7518 ${lookup sqlite {/some/thing/sqlitedb \
7519   select name from aliases where id='userx';}}
7520 .endd
7521 In a list, the syntax is similar. For example:
7522 .code
7523 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7524    select * from relays where ip='$sender_host_address';
7525 .endd
7526 The only character affected by the &%quote_sqlite%& operator is a single
7527 quote, which it doubles.
7528
7529 The SQLite library handles multiple simultaneous accesses to the database
7530 internally. Multiple readers are permitted, but only one process can
7531 update at once. Attempts to access the database while it is being updated
7532 are rejected after a timeout period, during which the SQLite library
7533 waits for the lock to be released. In Exim, the default timeout is set
7534 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7535 option.
7536 .ecindex IIDfidalo1
7537 .ecindex IIDfidalo2
7538
7539
7540 . ////////////////////////////////////////////////////////////////////////////
7541 . ////////////////////////////////////////////////////////////////////////////
7542
7543 .chapter "Domain, host, address, and local part lists" &&&
7544          "CHAPdomhosaddlists" &&&
7545          "Domain, host, and address lists"
7546 .scindex IIDdohoadli "lists of domains; hosts; etc."
7547 A number of Exim configuration options contain lists of domains, hosts,
7548 email addresses, or local parts. For example, the &%hold_domains%& option
7549 contains a list of domains whose delivery is currently suspended. These lists
7550 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7551 arguments to expansion conditions such as &%match_domain%&.
7552
7553 Each item in one of these lists is a pattern to be matched against a domain,
7554 host, email address, or local part, respectively. In the sections below, the
7555 different types of pattern for each case are described, but first we cover some
7556 general facilities that apply to all four kinds of list.
7557
7558
7559
7560 .section "Expansion of lists" "SECID75"
7561 .cindex "expansion" "of lists"
7562 Each list is expanded as a single string before it is used. The result of
7563 expansion must be a list, possibly containing empty items, which is split up
7564 into separate items for matching. By default, colon is the separator character,
7565 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7566 &<<SECTempitelis>>& for details of the list syntax; the second of these
7567 discusses the way to specify empty list items.
7568
7569
7570 If the string expansion is forced to fail, Exim behaves as if the item it is
7571 testing (domain, host, address, or local part) is not in the list. Other
7572 expansion failures cause temporary errors.
7573
7574 If an item in a list is a regular expression, backslashes, dollars and possibly
7575 other special characters in the expression must be protected against
7576 misinterpretation by the string expander. The easiest way to do this is to use
7577 the &`\N`& expansion feature to indicate that the contents of the regular
7578 expression should not be expanded. For example, in an ACL you might have:
7579 .code
7580 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7581                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7582 .endd
7583 The first item is a regular expression that is protected from expansion by
7584 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7585 senders based on the receiving domain.
7586
7587
7588
7589
7590 .section "Negated items in lists" "SECID76"
7591 .cindex "list" "negation"
7592 .cindex "negation" "in lists"
7593 Items in a list may be positive or negative. Negative items are indicated by a
7594 leading exclamation mark, which may be followed by optional white space. A list
7595 defines a set of items (domains, etc). When Exim processes one of these lists,
7596 it is trying to find out whether a domain, host, address, or local part
7597 (respectively) is in the set that is defined by the list. It works like this:
7598
7599 The list is scanned from left to right. If a positive item is matched, the
7600 subject that is being checked is in the set; if a negative item is matched, the
7601 subject is not in the set. If the end of the list is reached without the
7602 subject having matched any of the patterns, it is in the set if the last item
7603 was a negative one, but not if it was a positive one. For example, the list in
7604 .code
7605 domainlist relay_to_domains = !a.b.c : *.b.c
7606 .endd
7607 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7608 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7609 list is positive. However, if the setting were
7610 .code
7611 domainlist relay_to_domains = !a.b.c
7612 .endd
7613 then all domains other than &'a.b.c'& would match because the last item in the
7614 list is negative. In other words, a list that ends with a negative item behaves
7615 as if it had an extra item &`:*`& on the end.
7616
7617 Another way of thinking about positive and negative items in lists is to read
7618 the connector as &"or"& after a positive item and as &"and"& after a negative
7619 item.
7620
7621
7622
7623 .section "File names in lists" "SECTfilnamlis"
7624 .cindex "list" "file name in"
7625 If an item in a domain, host, address, or local part list is an absolute file
7626 name (beginning with a slash character), each line of the file is read and
7627 processed as if it were an independent item in the list, except that further
7628 file names are not allowed,
7629 and no expansion of the data from the file takes place.
7630 Empty lines in the file are ignored, and the file may also contain comment
7631 lines:
7632
7633 .ilist
7634 For domain and host lists, if a # character appears anywhere in a line of the
7635 file, it and all following characters are ignored.
7636 .next
7637 Because local parts may legitimately contain # characters, a comment in an
7638 address list or local part list file is recognized only if # is preceded by
7639 white space or the start of the line. For example:
7640 .code
7641 not#comment@x.y.z   # but this is a comment
7642 .endd
7643 .endlist
7644
7645 Putting a file name in a list has the same effect as inserting each line of the
7646 file as an item in the list (blank lines and comments excepted). However, there
7647 is one important difference: the file is read each time the list is processed,
7648 so if its contents vary over time, Exim's behaviour changes.
7649
7650 If a file name is preceded by an exclamation mark, the sense of any match
7651 within the file is inverted. For example, if
7652 .code
7653 hold_domains = !/etc/nohold-domains
7654 .endd
7655 and the file contains the lines
7656 .code
7657 !a.b.c
7658 *.b.c
7659 .endd
7660 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7661 any domain matching &`*.b.c`& is not.
7662
7663
7664
7665 .section "An lsearch file is not an out-of-line list" "SECID77"
7666 As will be described in the sections that follow, lookups can be used in lists
7667 to provide indexed methods of checking list membership. There has been some
7668 confusion about the way &(lsearch)& lookups work in lists. Because
7669 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7670 sometimes thought that it is allowed to contain wild cards and other kinds of
7671 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7672 always fixed strings, just as for any other single-key lookup type.
7673
7674 If you want to use a file to contain wild-card patterns that form part of a
7675 list, just give the file name on its own, without a search type, as described
7676 in the previous section. You could also use the &(wildlsearch)& or
7677 &(nwildlsearch)&, but there is no advantage in doing this.
7678
7679
7680
7681
7682 .section "Named lists" "SECTnamedlists"
7683 .cindex "named lists"
7684 .cindex "list" "named"
7685 A list of domains, hosts, email addresses, or local parts can be given a name
7686 which is then used to refer to the list elsewhere in the configuration. This is
7687 particularly convenient if the same list is required in several different
7688 places. It also allows lists to be given meaningful names, which can improve
7689 the readability of the configuration. For example, it is conventional to define
7690 a domain list called &'local_domains'& for all the domains that are handled
7691 locally on a host, using a configuration line such as
7692 .code
7693 domainlist local_domains = localhost:my.dom.example
7694 .endd
7695 Named lists are referenced by giving their name preceded by a plus sign, so,
7696 for example, a router that is intended to handle local domains would be
7697 configured with the line
7698 .code
7699 domains = +local_domains
7700 .endd
7701 The first router in a configuration is often one that handles all domains
7702 except the local ones, using a configuration with a negated item like this:
7703 .code
7704 dnslookup:
7705   driver = dnslookup
7706   domains = ! +local_domains
7707   transport = remote_smtp
7708   no_more
7709 .endd
7710 The four kinds of named list are created by configuration lines starting with
7711 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7712 respectively. Then there follows the name that you are defining, followed by an
7713 equals sign and the list itself. For example:
7714 .code
7715 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7716 addresslist bad_senders = cdb;/etc/badsenders
7717 .endd
7718 A named list may refer to other named lists:
7719 .code
7720 domainlist  dom1 = first.example : second.example
7721 domainlist  dom2 = +dom1 : third.example
7722 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7723 .endd
7724 &*Warning*&: If the last item in a referenced list is a negative one, the
7725 effect may not be what you intended, because the negation does not propagate
7726 out to the higher level. For example, consider:
7727 .code
7728 domainlist  dom1 = !a.b
7729 domainlist  dom2 = +dom1 : *.b
7730 .endd
7731 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7732 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7733 means it matches the second list as well. The effect is not the same as
7734 .code
7735 domainlist  dom2 = !a.b : *.b
7736 .endd
7737 where &'x.y'& does not match. It's best to avoid negation altogether in
7738 referenced lists if you can.
7739
7740 Named lists may have a performance advantage. When Exim is routing an
7741 address or checking an incoming message, it caches the result of tests on named
7742 lists. So, if you have a setting such as
7743 .code
7744 domains = +local_domains
7745 .endd
7746 on several of your routers
7747 or in several ACL statements,
7748 the actual test is done only for the first one. However, the caching works only
7749 if there are no expansions within the list itself or any sublists that it
7750 references. In other words, caching happens only for lists that are known to be
7751 the same each time they are referenced.
7752
7753 By default, there may be up to 16 named lists of each type. This limit can be
7754 extended by changing a compile-time variable. The use of domain and host lists
7755 is recommended for concepts such as local domains, relay domains, and relay
7756 hosts. The default configuration is set up like this.
7757
7758
7759
7760 .section "Named lists compared with macros" "SECID78"
7761 .cindex "list" "named compared with macro"
7762 .cindex "macro" "compared with named list"
7763 At first sight, named lists might seem to be no different from macros in the
7764 configuration file. However, macros are just textual substitutions. If you
7765 write
7766 .code
7767 ALIST = host1 : host2
7768 auth_advertise_hosts = !ALIST
7769 .endd
7770 it probably won't do what you want, because that is exactly the same as
7771 .code
7772 auth_advertise_hosts = !host1 : host2
7773 .endd
7774 Notice that the second host name is not negated. However, if you use a host
7775 list, and write
7776 .code
7777 hostlist alist = host1 : host2
7778 auth_advertise_hosts = ! +alist
7779 .endd
7780 the negation applies to the whole list, and so that is equivalent to
7781 .code
7782 auth_advertise_hosts = !host1 : !host2
7783 .endd
7784
7785
7786 .section "Named list caching" "SECID79"
7787 .cindex "list" "caching of named"
7788 .cindex "caching" "named lists"
7789 While processing a message, Exim caches the result of checking a named list if
7790 it is sure that the list is the same each time. In practice, this means that
7791 the cache operates only if the list contains no $ characters, which guarantees
7792 that it will not change when it is expanded. Sometimes, however, you may have
7793 an expanded list that you know will be the same each time within a given
7794 message. For example:
7795 .code
7796 domainlist special_domains = \
7797            ${lookup{$sender_host_address}cdb{/some/file}}
7798 .endd
7799 This provides a list of domains that depends only on the sending host's IP
7800 address. If this domain list is referenced a number of times (for example,
7801 in several ACL lines, or in several routers) the result of the check is not
7802 cached by default, because Exim does not know that it is going to be the
7803 same list each time.
7804
7805 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7806 cache the result anyway. For example:
7807 .code
7808 domainlist_cache special_domains = ${lookup{...
7809 .endd
7810 If you do this, you should be absolutely sure that caching is going to do
7811 the right thing in all cases. When in doubt, leave it out.
7812
7813
7814
7815 .section "Domain lists" "SECTdomainlist"
7816 .cindex "domain list" "patterns for"
7817 .cindex "list" "domain list"
7818 Domain lists contain patterns that are to be matched against a mail domain.
7819 The following types of item may appear in domain lists:
7820
7821 .ilist
7822 .cindex "primary host name"
7823 .cindex "host name" "matched in domain list"
7824 .oindex "&%primary_hostname%&"
7825 .cindex "domain list" "matching primary host name"
7826 .cindex "@ in a domain list"
7827 If a pattern consists of a single @ character, it matches the local host name,
7828 as set by the &%primary_hostname%& option (or defaulted). This makes it
7829 possible to use the same configuration file on several different hosts that
7830 differ only in their names.
7831 .next
7832 .cindex "@[] in a domain list"
7833 .cindex "domain list" "matching local IP interfaces"
7834 .cindex "domain literal"
7835 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7836 in square brackets (as in an email address that contains a domain literal), but
7837 only if that IP address is recognized as local for email routing purposes. The
7838 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7839 control which of a host's several IP addresses are treated as local.
7840 In today's Internet, the use of domain literals is controversial.
7841 .next
7842 .cindex "@mx_any"
7843 .cindex "@mx_primary"
7844 .cindex "@mx_secondary"
7845 .cindex "domain list" "matching MX pointers to local host"
7846 If a pattern consists of the string &`@mx_any`& it matches any domain that
7847 has an MX record pointing to the local host or to any host that is listed in
7848 .oindex "&%hosts_treat_as_local%&"
7849 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7850 are similar, except that the first matches only when a primary MX target is the
7851 local host, and the second only when no primary MX target is the local host,
7852 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7853 preference value &-- there may of course be more than one of them.
7854
7855 The MX lookup that takes place when matching a pattern of this type is
7856 performed with the resolver options for widening names turned off. Thus, for
7857 example, a single-component domain will &'not'& be expanded by adding the
7858 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7859 options of the &(dnslookup)& router for a discussion of domain widening.
7860
7861 Sometimes you may want to ignore certain IP addresses when using one of these
7862 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7863 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7864 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7865 on a router). For example:
7866 .code
7867 domains = @mx_any/ignore=127.0.0.1
7868 .endd
7869 This example matches any domain that has an MX record pointing to one of
7870 the local host's IP addresses other than 127.0.0.1.
7871
7872 The list of IP addresses is in fact processed by the same code that processes
7873 host lists, so it may contain CIDR-coded network specifications and it may also
7874 contain negative items.
7875
7876 Because the list of IP addresses is a sublist within a domain list, you have to
7877 be careful about delimiters if there is more than one address. Like any other
7878 list, the default delimiter can be changed. Thus, you might have:
7879 .code
7880 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7881           an.other.domain : ...
7882 .endd
7883 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7884 involved, it is easiest to change the delimiter for the main list as well:
7885 .code
7886 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7887           an.other.domain ? ...
7888 .endd
7889 .next
7890 .cindex "asterisk" "in domain list"
7891 .cindex "domain list" "asterisk in"
7892 .cindex "domain list" "matching &""ends with""&"
7893 If a pattern starts with an asterisk, the remaining characters of the pattern
7894 are compared with the terminating characters of the domain. The use of &"*"& in
7895 domain lists differs from its use in partial matching lookups. In a domain
7896 list, the character following the asterisk need not be a dot, whereas partial
7897 matching works only in terms of dot-separated components. For example, a domain
7898 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7899 &'cipher.key.ex'&.
7900
7901 .next
7902 .cindex "regular expressions" "in domain list"
7903 .cindex "domain list" "matching regular expression"
7904 If a pattern starts with a circumflex character, it is treated as a regular
7905 expression, and matched against the domain using a regular expression matching
7906 function. The circumflex is treated as part of the regular expression.
7907 Email domains are case-independent, so this regular expression match is by
7908 default case-independent, but you can make it case-dependent by starting it
7909 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7910 are given in chapter &<<CHAPregexp>>&.
7911
7912 &*Warning*&: Because domain lists are expanded before being processed, you
7913 must escape any backslash and dollar characters in the regular expression, or
7914 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7915 it is not to be expanded (unless you really do want to build a regular
7916 expression by expansion, of course).
7917 .next
7918 .cindex "lookup" "in domain list"
7919 .cindex "domain list" "matching by lookup"
7920 If a pattern starts with the name of a single-key lookup type followed by a
7921 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7922 must be a file name in a suitable format for the lookup type. For example, for
7923 &"cdb;"& it must be an absolute path:
7924 .code
7925 domains = cdb;/etc/mail/local_domains.cdb
7926 .endd
7927 The appropriate type of lookup is done on the file using the domain name as the
7928 key. In most cases, the data that is looked up is not used; Exim is interested
7929 only in whether or not the key is present in the file. However, when a lookup
7930 is used for the &%domains%& option on a router
7931 or a &%domains%& condition in an ACL statement, the data is preserved in the
7932 &$domain_data$& variable and can be referred to in other router options or
7933 other statements in the same ACL.
7934
7935 .next
7936 Any of the single-key lookup type names may be preceded by
7937 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7938 .code
7939 domains = partial-dbm;/partial/domains
7940 .endd
7941 This causes partial matching logic to be invoked; a description of how this
7942 works is given in section &<<SECTpartiallookup>>&.
7943
7944 .next
7945 .cindex "asterisk" "in lookup type"
7946 Any of the single-key lookup types may be followed by an asterisk. This causes
7947 a default lookup for a key consisting of a single asterisk to be done if the
7948 original lookup fails. This is not a useful feature when using a domain list to
7949 select particular domains (because any domain would match), but it might have
7950 value if the result of the lookup is being used via the &$domain_data$&
7951 expansion variable.
7952 .next
7953 If the pattern starts with the name of a query-style lookup type followed by a
7954 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7955 pattern must be an appropriate query for the lookup type, as described in
7956 chapter &<<CHAPfdlookup>>&. For example:
7957 .code
7958 hold_domains = mysql;select domain from holdlist \
7959   where domain = '${quote_mysql:$domain}';
7960 .endd
7961 In most cases, the data that is looked up is not used (so for an SQL query, for
7962 example, it doesn't matter what field you select). Exim is interested only in
7963 whether or not the query succeeds. However, when a lookup is used for the
7964 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7965 variable and can be referred to in other options.
7966 .next
7967 .cindex "domain list" "matching literal domain name"
7968 If none of the above cases apply, a caseless textual comparison is made
7969 between the pattern and the domain.
7970 .endlist
7971
7972 Here is an example that uses several different kinds of pattern:
7973 .code
7974 domainlist funny_domains = \
7975   @ : \
7976   lib.unseen.edu : \
7977   *.foundation.fict.example : \
7978   \N^[1-2]\d{3}\.fict\.example$\N : \
7979   partial-dbm;/opt/data/penguin/book : \
7980   nis;domains.byname : \
7981   nisplus;[name=$domain,status=local],domains.org_dir
7982 .endd
7983 There are obvious processing trade-offs among the various matching modes. Using
7984 an asterisk is faster than a regular expression, and listing a few names
7985 explicitly probably is too. The use of a file or database lookup is expensive,
7986 but may be the only option if hundreds of names are required. Because the
7987 patterns are tested in order, it makes sense to put the most commonly matched
7988 patterns earlier.
7989
7990
7991
7992 .section "Host lists" "SECThostlist"
7993 .cindex "host list" "patterns in"
7994 .cindex "list" "host list"
7995 Host lists are used to control what remote hosts are allowed to do. For
7996 example, some hosts may be allowed to use the local host as a relay, and some
7997 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7998 two different ways, by name or by IP address. In a host list, some types of
7999 pattern are matched to a host name, and some are matched to an IP address.
8000 You need to be particularly careful with this when single-key lookups are
8001 involved, to ensure that the right value is being used as the key.
8002
8003
8004 .section "Special host list patterns" "SECID80"
8005 .cindex "empty item in hosts list"
8006 .cindex "host list" "empty string in"
8007 If a host list item is the empty string, it matches only when no remote host is
8008 involved. This is the case when a message is being received from a local
8009 process using SMTP on the standard input, that is, when a TCP/IP connection is
8010 not used.
8011
8012 .cindex "asterisk" "in host list"
8013 The special pattern &"*"& in a host list matches any host or no host. Neither
8014 the IP address nor the name is actually inspected.
8015
8016
8017
8018 .section "Host list patterns that match by IP address" "SECThoslispatip"
8019 .cindex "host list" "matching IP addresses"
8020 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8021 the incoming address actually appears in the IPv6 host as
8022 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8023 list, it is converted into a traditional IPv4 address first. (Not all operating
8024 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8025 concerns.)
8026
8027 The following types of pattern in a host list check the remote host by
8028 inspecting its IP address:
8029
8030 .ilist
8031 If the pattern is a plain domain name (not a regular expression, not starting
8032 with *, not a lookup of any kind), Exim calls the operating system function
8033 to find the associated IP address(es). Exim uses the newer
8034 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8035 This typically causes a forward DNS lookup of the name. The result is compared
8036 with the IP address of the subject host.
8037
8038 If there is a temporary problem (such as a DNS timeout) with the host name
8039 lookup, a temporary error occurs. For example, if the list is being used in an
8040 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8041 temporary SMTP error code. If no IP address can be found for the host name,
8042 what happens is described in section &<<SECTbehipnot>>& below.
8043
8044 .next
8045 .cindex "@ in a host list"
8046 If the pattern is &"@"&, the primary host name is substituted and used as a
8047 domain name, as just described.
8048
8049 .next
8050 If the pattern is an IP address, it is matched against the IP address of the
8051 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8052 IPv6 addresses can be given in colon-separated format, but the colons have to
8053 be doubled so as not to be taken as item separators when the default list
8054 separator is used. IPv6 addresses are recognized even when Exim is compiled
8055 without IPv6 support. This means that if they appear in a host list on an
8056 IPv4-only host, Exim will not treat them as host names. They are just addresses
8057 that can never match a client host.
8058
8059 .next
8060 .cindex "@[] in a host list"
8061 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8062 the local host. For example, if the local host is an IPv4 host with one
8063 interface address 10.45.23.56, these two ACL statements have the same effect:
8064 .code
8065 accept hosts = 127.0.0.1 : 10.45.23.56
8066 accept hosts = @[]
8067 .endd
8068 .next
8069 .cindex "CIDR notation"
8070 If the pattern is an IP address followed by a slash and a mask length (for
8071 example 10.11.42.0/24), it is matched against the IP address of the subject
8072 host under the given mask. This allows, an entire network of hosts to be
8073 included (or excluded) by a single item. The mask uses CIDR notation; it
8074 specifies the number of address bits that must match, starting from the most
8075 significant end of the address.
8076
8077 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8078 of a range of addresses. It is the number of bits in the network portion of the
8079 address. The above example specifies a 24-bit netmask, so it matches all 256
8080 addresses in the 10.11.42.0 network. An item such as
8081 .code
8082 192.168.23.236/31
8083 .endd
8084 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8085 32 for an IPv4 address is the same as no mask at all; just a single address
8086 matches.
8087
8088 Here is another example which shows an IPv4 and an IPv6 network:
8089 .code
8090 recipient_unqualified_hosts = 192.168.0.0/16: \
8091                               3ffe::ffff::836f::::/48
8092 .endd
8093 The doubling of list separator characters applies only when these items
8094 appear inline in a host list. It is not required when indirecting via a file.
8095 For example:
8096 .code
8097 recipient_unqualified_hosts = /opt/exim/unqualnets
8098 .endd
8099 could make use of a file containing
8100 .code
8101 172.16.0.0/12
8102 3ffe:ffff:836f::/48
8103 .endd
8104 to have exactly the same effect as the previous example. When listing IPv6
8105 addresses inline, it is usually more convenient to use the facility for
8106 changing separator characters. This list contains the same two networks:
8107 .code
8108 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8109                                  3ffe:ffff:836f::/48
8110 .endd
8111 The separator is changed to semicolon by the leading &"<;"& at the start of the
8112 list.
8113 .endlist
8114
8115
8116
8117 .section "Host list patterns for single-key lookups by host address" &&&
8118          "SECThoslispatsikey"
8119 .cindex "host list" "lookup of IP address"
8120 When a host is to be identified by a single-key lookup of its complete IP
8121 address, the pattern takes this form:
8122 .display
8123 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8124 .endd
8125 For example:
8126 .code
8127 hosts_lookup = net-cdb;/hosts-by-ip.db
8128 .endd
8129 The text form of the IP address of the subject host is used as the lookup key.
8130 IPv6 addresses are converted to an unabbreviated form, using lower case
8131 letters, with dots as separators because colon is the key terminator in
8132 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8133 quoting the keys, but this is a facility that was added later.] The data
8134 returned by the lookup is not used.
8135
8136 .cindex "IP address" "masking"
8137 .cindex "host list" "masked IP address"
8138 Single-key lookups can also be performed using masked IP addresses, using
8139 patterns of this form:
8140 .display
8141 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8142 .endd
8143 For example:
8144 .code
8145 net24-dbm;/networks.db
8146 .endd
8147 The IP address of the subject host is masked using <&'number'&> as the mask
8148 length. A textual string is constructed from the masked value, followed by the
8149 mask, and this is used as the lookup key. For example, if the host's IP address
8150 is 192.168.34.6, the key that is looked up for the above example is
8151 &"192.168.34.0/24"&.
8152
8153 When an IPv6 address is converted to a string, dots are normally used instead
8154 of colons, so that keys in &(lsearch)& files need not contain colons (which
8155 terminate &(lsearch)& keys). This was implemented some time before the ability
8156 to quote keys was made available in &(lsearch)& files. However, the more
8157 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8158 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8159 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8160 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8161 addresses are always used.
8162
8163 Ideally, it would be nice to tidy up this anomalous situation by changing to
8164 colons in all cases, given that quoting is now available for &(lsearch)&.
8165 However, this would be an incompatible change that might break some existing
8166 configurations.
8167
8168 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8169 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8170 the former case the key strings include the mask value, whereas in the latter
8171 case the IP address is used on its own.
8172
8173
8174
8175 .section "Host list patterns that match by host name" "SECThoslispatnam"
8176 .cindex "host" "lookup failures"
8177 .cindex "unknown host name"
8178 .cindex "host list" "matching host name"
8179 There are several types of pattern that require Exim to know the name of the
8180 remote host. These are either wildcard patterns or lookups by name. (If a
8181 complete hostname is given without any wildcarding, it is used to find an IP
8182 address to match against, as described in section &<<SECThoslispatip>>&
8183 above.)
8184
8185 If the remote host name is not already known when Exim encounters one of these
8186 patterns, it has to be found from the IP address.
8187 Although many sites on the Internet are conscientious about maintaining reverse
8188 DNS data for their hosts, there are also many that do not do this.
8189 Consequently, a name cannot always be found, and this may lead to unwanted
8190 effects. Take care when configuring host lists with wildcarded name patterns.
8191 Consider what will happen if a name cannot be found.
8192
8193 Because of the problems of determining host names from IP addresses, matching
8194 against host names is not as common as matching against IP addresses.
8195
8196 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8197 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8198 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8199 are done can be changed by setting the &%host_lookup_order%& option. For
8200 security, once Exim has found one or more names, it looks up the IP addresses
8201 for these names and compares them with the IP address that it started with.
8202 Only those names whose IP addresses match are accepted. Any other names are
8203 discarded. If no names are left, Exim behaves as if the host name cannot be
8204 found. In the most common case there is only one name and one IP address.
8205
8206 There are some options that control what happens if a host name cannot be
8207 found. These are described in section &<<SECTbehipnot>>& below.
8208
8209 .cindex "host" "alias for"
8210 .cindex "alias for host"
8211 As a result of aliasing, hosts may have more than one name. When processing any
8212 of the following types of pattern, all the host's names are checked:
8213
8214 .ilist
8215 .cindex "asterisk" "in host list"
8216 If a pattern starts with &"*"& the remainder of the item must match the end of
8217 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8218 &'.b.c'&. This special simple form is provided because this is a very common
8219 requirement. Other kinds of wildcarding require the use of a regular
8220 expression.
8221 .next
8222 .cindex "regular expressions" "in host list"
8223 .cindex "host list" "regular expression in"
8224 If the item starts with &"^"& it is taken to be a regular expression which is
8225 matched against the host name. Host names are case-independent, so this regular
8226 expression match is by default case-independent, but you can make it
8227 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8228 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8229 example,
8230 .code
8231 ^(a|b)\.c\.d$
8232 .endd
8233 is a regular expression that matches either of the two hosts &'a.c.d'& or
8234 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8235 that backslash and dollar characters are not misinterpreted as part of the
8236 string expansion. The simplest way to do this is to use &`\N`& to mark that
8237 part of the string as non-expandable. For example:
8238 .code
8239 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8240 .endd
8241 &*Warning*&: If you want to match a complete host name, you must include the
8242 &`$`& terminating metacharacter in the regular expression, as in the above
8243 example. Without it, a match at the start of the host name is all that is
8244 required.
8245 .endlist
8246
8247
8248
8249
8250 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8251 .cindex "host" "lookup failures, permanent"
8252 While processing a host list, Exim may need to look up an IP address from a
8253 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8254 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8255 behaviour when it fails to find the information it is seeking is the same.
8256
8257 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8258 apply to temporary DNS errors, whose handling is described in the next section.
8259
8260 .cindex "&`+include_unknown`&"
8261 .cindex "&`+ignore_unknown`&"
8262 By default, Exim behaves as if the host does not match the list. This may not
8263 always be what you want to happen. To change Exim's behaviour, the special
8264 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8265 top level &-- they are not recognized in an indirected file).
8266
8267 .ilist
8268 If any item that follows &`+include_unknown`& requires information that
8269 cannot found, Exim behaves as if the host does match the list. For example,
8270 .code
8271 host_reject_connection = +include_unknown:*.enemy.ex
8272 .endd
8273 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8274 any hosts whose name it cannot find.
8275
8276 .next
8277 If any item that follows &`+ignore_unknown`& requires information that cannot
8278 be found, Exim ignores that item and proceeds to the rest of the list. For
8279 example:
8280 .code
8281 accept hosts = +ignore_unknown : friend.example : \
8282                192.168.4.5
8283 .endd
8284 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8285 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8286 name can be found for 192.168.4.5, it is rejected.
8287 .endlist
8288
8289 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8290 list. The effect of each one lasts until the next, or until the end of the
8291 list.
8292
8293
8294 .section "Temporary DNS errors when looking up host information" &&&
8295          "SECTtemdnserr"
8296 .cindex "host" "lookup failures, temporary"
8297 .cindex "&`+include_defer`&"
8298 .cindex "&`+ignore_defer`&"
8299 A temporary DNS lookup failure normally causes a defer action (except when
8300 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8301 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8302 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8303 section. These options should be used with care, probably only in non-critical
8304 host lists such as whitelists.
8305
8306
8307
8308 .section "Host list patterns for single-key lookups by host name" &&&
8309          "SECThoslispatnamsk"
8310 .cindex "unknown host name"
8311 .cindex "host list" "matching host name"
8312 If a pattern is of the form
8313 .display
8314 <&'single-key-search-type'&>;<&'search-data'&>
8315 .endd
8316 for example
8317 .code
8318 dbm;/host/accept/list
8319 .endd
8320 a single-key lookup is performed, using the host name as its key. If the
8321 lookup succeeds, the host matches the item. The actual data that is looked up
8322 is not used.
8323
8324 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8325 keys in the file, not IP addresses. If you want to do lookups based on IP
8326 addresses, you must precede the search type with &"net-"& (see section
8327 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8328 two items in the same list, one doing an address lookup and one doing a name
8329 lookup, both using the same file.
8330
8331
8332
8333 .section "Host list patterns for query-style lookups" "SECID81"
8334 If a pattern is of the form
8335 .display
8336 <&'query-style-search-type'&>;<&'query'&>
8337 .endd
8338 the query is obeyed, and if it succeeds, the host matches the item. The actual
8339 data that is looked up is not used. The variables &$sender_host_address$& and
8340 &$sender_host_name$& can be used in the query. For example:
8341 .code
8342 hosts_lookup = pgsql;\
8343   select ip from hostlist where ip='$sender_host_address'
8344 .endd
8345 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8346 can use the &%sg%& expansion item to change this if you need to. If you want to
8347 use masked IP addresses in database queries, you can use the &%mask%& expansion
8348 operator.
8349
8350 If the query contains a reference to &$sender_host_name$&, Exim automatically
8351 looks up the host name if it has not already done so. (See section
8352 &<<SECThoslispatnam>>& for comments on finding host names.)
8353
8354 Historical note: prior to release 4.30, Exim would always attempt to find a
8355 host name before running the query, unless the search type was preceded by
8356 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8357 still recognized for query-style lookups, but its presence or absence has no
8358 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8359 See section &<<SECThoslispatsikey>>&.)
8360
8361
8362
8363 .section "Mixing wildcarded host names and addresses in host lists" &&&
8364          "SECTmixwilhos"
8365 .cindex "host list" "mixing names and addresses in"
8366 If you have name lookups or wildcarded host names and IP addresses in the same
8367 host list, you should normally put the IP addresses first. For example, in an
8368 ACL you could have:
8369 .code
8370 accept hosts = 10.9.8.7 : *.friend.example
8371 .endd
8372 The reason for this lies in the left-to-right way that Exim processes lists.
8373 It can test IP addresses without doing any DNS lookups, but when it reaches an
8374 item that requires a host name, it fails if it cannot find a host name to
8375 compare with the pattern. If the above list is given in the opposite order, the
8376 &%accept%& statement fails for a host whose name cannot be found, even if its
8377 IP address is 10.9.8.7.
8378
8379 If you really do want to do the name check first, and still recognize the IP
8380 address, you can rewrite the ACL like this:
8381 .code
8382 accept hosts = *.friend.example
8383 accept hosts = 10.9.8.7
8384 .endd
8385 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8386 &<<CHAPACL>>& for details of ACLs.
8387
8388
8389
8390
8391
8392 .section "Address lists" "SECTaddresslist"
8393 .cindex "list" "address list"
8394 .cindex "address list" "empty item"
8395 .cindex "address list" "patterns"
8396 Address lists contain patterns that are matched against mail addresses. There
8397 is one special case to be considered: the sender address of a bounce message is
8398 always empty. You can test for this by providing an empty item in an address
8399 list. For example, you can set up a router to process bounce messages by
8400 using this option setting:
8401 .code
8402 senders = :
8403 .endd
8404 The presence of the colon creates an empty item. If you do not provide any
8405 data, the list is empty and matches nothing. The empty sender can also be
8406 detected by a regular expression that matches an empty string,
8407 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8408
8409 Non-empty items in an address list can be straightforward email addresses. For
8410 example:
8411 .code
8412 senders = jbc@askone.example : hs@anacreon.example
8413 .endd
8414 A certain amount of wildcarding is permitted. If a pattern contains an @
8415 character, but is not a regular expression and does not begin with a
8416 semicolon-terminated lookup type (described below), the local part of the
8417 subject address is compared with the local part of the pattern, which may start
8418 with an asterisk. If the local parts match, the domain is checked in exactly
8419 the same way as for a pattern in a domain list. For example, the domain can be
8420 wildcarded, refer to a named list, or be a lookup:
8421 .code
8422 deny senders = *@*.spamming.site:\
8423                *@+hostile_domains:\
8424                bozo@partial-lsearch;/list/of/dodgy/sites:\
8425                *@dbm;/bad/domains.db
8426 .endd
8427 .cindex "local part" "starting with !"
8428 .cindex "address list" "local part starting with !"
8429 If a local part that begins with an exclamation mark is required, it has to be
8430 specified using a regular expression, because otherwise the exclamation mark is
8431 treated as a sign of negation, as is standard in lists.
8432
8433 If a non-empty pattern that is not a regular expression or a lookup does not
8434 contain an @ character, it is matched against the domain part of the subject
8435 address. The only two formats that are recognized this way are a literal
8436 domain, or a domain pattern that starts with *. In both these cases, the effect
8437 is the same as if &`*@`& preceded the pattern. For example:
8438 .code
8439 deny senders = enemy.domain : *.enemy.domain
8440 .endd
8441
8442 The following kinds of more complicated address list pattern can match any
8443 address, including the empty address that is characteristic of bounce message
8444 senders:
8445
8446 .ilist
8447 .cindex "regular expressions" "in address list"
8448 .cindex "address list" "regular expression in"
8449 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8450 done against the complete address, with the pattern as the regular expression.
8451 You must take care that backslash and dollar characters are not misinterpreted
8452 as part of the string expansion. The simplest way to do this is to use &`\N`&
8453 to mark that part of the string as non-expandable. For example:
8454 .code
8455 deny senders = \N^.*this.*@example\.com$\N : \
8456                \N^\d{8}.+@spamhaus.example$\N : ...
8457 .endd
8458 The &`\N`& sequences are removed by the expansion, so these items do indeed
8459 start with &"^"& by the time they are being interpreted as address patterns.
8460
8461 .next
8462 .cindex "address list" "lookup for complete address"
8463 Complete addresses can be looked up by using a pattern that starts with a
8464 lookup type terminated by a semicolon, followed by the data for the lookup. For
8465 example:
8466 .code
8467 deny senders = cdb;/etc/blocked.senders : \
8468   mysql;select address from blocked where \
8469   address='${quote_mysql:$sender_address}'
8470 .endd
8471 Both query-style and single-key lookup types can be used. For a single-key
8472 lookup type, Exim uses the complete address as the key. However, empty keys are
8473 not supported for single-key lookups, so a match against the empty address
8474 always fails. This restriction does not apply to query-style lookups.
8475
8476 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8477 cannot be used, and is ignored if specified, with an entry being written to the
8478 panic log.
8479 .cindex "*@ with single-key lookup"
8480 However, you can configure lookup defaults, as described in section
8481 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8482 default. For example, with this lookup:
8483 .code
8484 accept senders = lsearch*@;/some/file
8485 .endd
8486 the file could contains lines like this:
8487 .code
8488 user1@domain1.example
8489 *@domain2.example
8490 .endd
8491 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8492 that are tried is:
8493 .code
8494 nimrod@jaeger.example
8495 *@jaeger.example
8496 *
8497 .endd
8498 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8499 would mean that every address matches, thus rendering the test useless.
8500
8501 &*Warning 2*&: Do not confuse these two kinds of item:
8502 .code
8503 deny recipients = dbm*@;/some/file
8504 deny recipients = *@dbm;/some/file
8505 .endd
8506 The first does a whole address lookup, with defaulting, as just described,
8507 because it starts with a lookup type. The second matches the local part and
8508 domain independently, as described in a bullet point below.
8509 .endlist
8510
8511
8512 The following kinds of address list pattern can match only non-empty addresses.
8513 If the subject address is empty, a match against any of these pattern types
8514 always fails.
8515
8516
8517 .ilist
8518 .cindex "@@ with single-key lookup"
8519 .cindex "address list" "@@ lookup type"
8520 .cindex "address list" "split local part and domain"
8521 If a pattern starts with &"@@"& followed by a single-key lookup item
8522 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8523 split into a local part and a domain. The domain is looked up in the file. If
8524 it is not found, there is no match. If it is found, the data that is looked up
8525 from the file is treated as a colon-separated list of local part patterns, each
8526 of which is matched against the subject local part in turn.
8527
8528 .cindex "asterisk" "in address list"
8529 The lookup may be a partial one, and/or one involving a search for a default
8530 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8531 patterns that are looked up can be regular expressions or begin with &"*"&, or
8532 even be further lookups. They may also be independently negated. For example,
8533 with
8534 .code
8535 deny senders = @@dbm;/etc/reject-by-domain
8536 .endd
8537 the data from which the DBM file is built could contain lines like
8538 .code
8539 baddomain.com:  !postmaster : *
8540 .endd
8541 to reject all senders except &%postmaster%& from that domain.
8542
8543 .cindex "local part" "starting with !"
8544 If a local part that actually begins with an exclamation mark is required, it
8545 has to be specified using a regular expression. In &(lsearch)& files, an entry
8546 may be split over several lines by indenting the second and subsequent lines,
8547 but the separating colon must still be included at line breaks. White space
8548 surrounding the colons is ignored. For example:
8549 .code
8550 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8551   spammer3 : spammer4
8552 .endd
8553 As in all colon-separated lists in Exim, a colon can be included in an item by
8554 doubling.
8555
8556 If the last item in the list starts with a right angle-bracket, the remainder
8557 of the item is taken as a new key to look up in order to obtain a continuation
8558 list of local parts. The new key can be any sequence of characters. Thus one
8559 might have entries like
8560 .code
8561 aol.com: spammer1 : spammer 2 : >*
8562 xyz.com: spammer3 : >*
8563 *:       ^\d{8}$
8564 .endd
8565 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8566 local parts for all domains, in addition to the specific local parts listed for
8567 each domain. Of course, using this feature costs another lookup each time a
8568 chain is followed, but the effort needed to maintain the data is reduced.
8569
8570 .cindex "loop" "in lookups"
8571 It is possible to construct loops using this facility, and in order to catch
8572 them, the chains may be no more than fifty items long.
8573
8574 .next
8575 The @@<&'lookup'&> style of item can also be used with a query-style
8576 lookup, but in this case, the chaining facility is not available. The lookup
8577 can only return a single list of local parts.
8578 .endlist
8579
8580 &*Warning*&: There is an important difference between the address list items
8581 in these two examples:
8582 .code
8583 senders = +my_list
8584 senders = *@+my_list
8585 .endd
8586 In the first one, &`my_list`& is a named address list, whereas in the second
8587 example it is a named domain list.
8588
8589
8590
8591
8592 .section "Case of letters in address lists" "SECTcasletadd"
8593 .cindex "case of local parts"
8594 .cindex "address list" "case forcing"
8595 .cindex "case forcing in address lists"
8596 Domains in email addresses are always handled caselessly, but for local parts
8597 case may be significant on some systems (see &%caseful_local_part%& for how
8598 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8599 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8600 blocking lists should be done in a case-independent manner. Since most address
8601 lists in Exim are used for this kind of control, Exim attempts to do this by
8602 default.
8603
8604 The domain portion of an address is always lowercased before matching it to an
8605 address list. The local part is lowercased by default, and any string
8606 comparisons that take place are done caselessly. This means that the data in
8607 the address list itself, in files included as plain file names, and in any file
8608 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8609 keys in files that are looked up by a search type other than &(lsearch)& (which
8610 works caselessly) must be in lower case, because these lookups are not
8611 case-independent.
8612
8613 .cindex "&`+caseful`&"
8614 To allow for the possibility of caseful address list matching, if an item in
8615 an address list is the string &"+caseful"&, the original case of the local
8616 part is restored for any comparisons that follow, and string comparisons are no
8617 longer case-independent. This does not affect the domain, which remains in
8618 lower case. However, although independent matches on the domain alone are still
8619 performed caselessly, regular expressions that match against an entire address
8620 become case-sensitive after &"+caseful"& has been seen.
8621
8622
8623
8624 .section "Local part lists" "SECTlocparlis"
8625 .cindex "list" "local part list"
8626 .cindex "local part" "list"
8627 Case-sensitivity in local part lists is handled in the same way as for address
8628 lists, as just described. The &"+caseful"& item can be used if required. In a
8629 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8630 set false, the subject is lowercased and the matching is initially
8631 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8632 matching in the local part list, but not elsewhere in the router. If
8633 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8634 option is case-sensitive from the start.
8635
8636 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8637 comments are handled in the same way as address lists &-- they are recognized
8638 only if the # is preceded by white space or the start of the line.
8639 Otherwise, local part lists are matched in the same way as domain lists, except
8640 that the special items that refer to the local host (&`@`&, &`@[]`&,
8641 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8642 Refer to section &<<SECTdomainlist>>& for details of the other available item
8643 types.
8644 .ecindex IIDdohoadli
8645
8646
8647
8648
8649 . ////////////////////////////////////////////////////////////////////////////
8650 . ////////////////////////////////////////////////////////////////////////////
8651
8652 .chapter "String expansions" "CHAPexpand"
8653 .scindex IIDstrexp "expansion" "of strings"
8654 Many strings in Exim's run time configuration are expanded before use. Some of
8655 them are expanded every time they are used; others are expanded only once.
8656
8657 When a string is being expanded it is copied verbatim from left to right except
8658 when a dollar or backslash character is encountered. A dollar specifies the
8659 start of a portion of the string that is interpreted and replaced as described
8660 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8661 escape character, as described in the following section.
8662
8663 Whether a string is expanded depends upon the context.  Usually this is solely
8664 dependent upon the option for which a value is sought; in this documentation,
8665 options for which string expansion is performed are marked with &dagger; after
8666 the data type.  ACL rules always expand strings.  A couple of expansion
8667 conditions do not expand some of the brace-delimited branches, for security
8668 reasons.
8669
8670
8671
8672 .section "Literal text in expanded strings" "SECTlittext"
8673 .cindex "expansion" "including literal text"
8674 An uninterpreted dollar can be included in an expanded string by putting a
8675 backslash in front of it. A backslash can be used to prevent any special
8676 character being treated specially in an expansion, including backslash itself.
8677 If the string appears in quotes in the configuration file, two backslashes are
8678 required because the quotes themselves cause interpretation of backslashes when
8679 the string is read in (see section &<<SECTstrings>>&).
8680
8681 .cindex "expansion" "non-expandable substrings"
8682 A portion of the string can specified as non-expandable by placing it between
8683 two occurrences of &`\N`&. This is particularly useful for protecting regular
8684 expressions, which often contain backslashes and dollar signs. For example:
8685 .code
8686 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8687 .endd
8688 On encountering the first &`\N`&, the expander copies subsequent characters
8689 without interpretation until it reaches the next &`\N`& or the end of the
8690 string.
8691
8692
8693
8694 .section "Character escape sequences in expanded strings" "SECID82"
8695 .cindex "expansion" "escape sequences"
8696 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8697 expanded string is recognized as an escape sequence for the character newline,
8698 carriage return, or tab, respectively. A backslash followed by up to three
8699 octal digits is recognized as an octal encoding for a single character, and a
8700 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8701 encoding.
8702
8703 These escape sequences are also recognized in quoted strings when they are read
8704 in. Their interpretation in expansions as well is useful for unquoted strings,
8705 and for other cases such as looked-up strings that are then expanded.
8706
8707
8708 .section "Testing string expansions" "SECID83"
8709 .cindex "expansion" "testing"
8710 .cindex "testing" "string expansion"
8711 .oindex "&%-be%&"
8712 Many expansions can be tested by calling Exim with the &%-be%& option. This
8713 takes the command arguments, or lines from the standard input if there are no
8714 arguments, runs them through the string expansion code, and writes the results
8715 to the standard output. Variables based on configuration values are set up, but
8716 since no message is being processed, variables such as &$local_part$& have no
8717 value. Nevertheless the &%-be%& option can be useful for checking out file and
8718 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8719 and &%nhash%&.
8720
8721 Exim gives up its root privilege when it is called with the &%-be%& option, and
8722 instead runs under the uid and gid it was called with, to prevent users from
8723 using &%-be%& for reading files to which they do not have access.
8724
8725 .oindex "&%-bem%&"
8726 If you want to test expansions that include variables whose values are taken
8727 from a message, there are two other options that can be used. The &%-bem%&
8728 option is like &%-be%& except that it is followed by a file name. The file is
8729 read as a message before doing the test expansions. For example:
8730 .code
8731 exim -bem /tmp/test.message '$h_subject:'
8732 .endd
8733 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8734 Exim message identifier. For example:
8735 .code
8736 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8737 .endd
8738 This loads the message from Exim's spool before doing the test expansions, and
8739 is therefore restricted to admin users.
8740
8741
8742 .section "Forced expansion failure" "SECTforexpfai"
8743 .cindex "expansion" "forced failure"
8744 A number of expansions that are described in the following section have
8745 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8746 (which are sometimes called &"curly brackets"&). Which of the two strings is
8747 used depends on some condition that is evaluated as part of the expansion. If,
8748 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8749 the entire string expansion fails in a way that can be detected by the code
8750 that requested the expansion. This is called &"forced expansion failure"&, and
8751 its consequences depend on the circumstances. In some cases it is no different
8752 from any other expansion failure, but in others a different action may be
8753 taken. Such variations are mentioned in the documentation of the option that is
8754 being expanded.
8755
8756
8757
8758
8759 .section "Expansion items" "SECTexpansionitems"
8760 The following items are recognized in expanded strings. White space may be used
8761 between sub-items that are keywords or substrings enclosed in braces inside an
8762 outer set of braces, to improve readability. &*Warning*&: Within braces,
8763 white space is significant.
8764
8765 .vlist
8766 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8767 .cindex "expansion" "variables"
8768 Substitute the contents of the named variable, for example:
8769 .code
8770 $local_part
8771 ${domain}
8772 .endd
8773 The second form can be used to separate the name from subsequent alphanumeric
8774 characters. This form (using braces) is available only for variables; it does
8775 &'not'& apply to message headers. The names of the variables are given in
8776 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8777 given, the expansion fails.
8778
8779 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8780 .cindex "expansion" "operators"
8781 The string is first itself expanded, and then the operation specified by
8782 <&'op'&> is applied to it. For example:
8783 .code
8784 ${lc:$local_part}
8785 .endd
8786 The string starts with the first character after the colon, which may be
8787 leading white space. A list of operators is given in section &<<SECTexpop>>&
8788 below. The operator notation is used for simple expansion items that have just
8789 one argument, because it reduces the number of braces and therefore makes the
8790 string easier to understand.
8791
8792 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8793 This item inserts &"basic"& header lines. It is described with the &%header%&
8794 expansion item below.
8795
8796
8797 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8798 .cindex "expansion" "calling an acl"
8799 .cindex "&%acl%&" "call from expansion"
8800 The name and zero to nine argument strings are first expanded separately.  The expanded
8801 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8802 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8803 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8804 and may use the variables; if another acl expansion is used the values
8805 are restored after it returns.  If the ACL sets
8806 a value using a "message =" modifier and returns accept or deny, the value becomes
8807 the result of the expansion.
8808 If no message is set and the ACL returns accept or deny
8809 the expansion result is an empty string.
8810 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8811
8812
8813 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8814        {*&<&'arg'&>&*}...}*&"
8815 .cindex &%dlfunc%&
8816 This expansion dynamically loads and then calls a locally-written C function.
8817 This functionality is available only if Exim is compiled with
8818 .code
8819 EXPAND_DLFUNC=yes
8820 .endd
8821 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8822 object so that it doesn't reload the same object file in the same Exim process
8823 (but of course Exim does start new processes frequently).
8824
8825 There may be from zero to eight arguments to the function. When compiling
8826 a local function that is to be called in this way, &_local_scan.h_& should be
8827 included. The Exim variables and functions that are defined by that API
8828 are also available for dynamically loaded functions. The function itself
8829 must have the following type:
8830 .code
8831 int dlfunction(uschar **yield, int argc, uschar *argv[])
8832 .endd
8833 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8834 function should return one of the following values:
8835
8836 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8837 into the expanded string that is being built.
8838
8839 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8840 from &'yield'&, if it is set.
8841
8842 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8843 taken from &'yield'& if it is set.
8844
8845 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8846
8847 When compiling a function that is to be used in this way with gcc,
8848 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8849 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8850
8851 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8852        {*&<&'string3'&>&*}}*&"
8853 .cindex "expansion" "extracting substrings by key"
8854 .cindex "&%extract%&" "substrings by key"
8855 The key and <&'string1'&> are first expanded separately. Leading and trailing
8856 white space is removed from the key (but not from any of the strings). The key
8857 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8858 form:
8859 .display
8860 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8861 .endd
8862 .vindex "&$value$&"
8863 where the equals signs and spaces (but not both) are optional. If any of the
8864 values contain white space, they must be enclosed in double quotes, and any
8865 values that are enclosed in double quotes are subject to escape processing as
8866 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8867 for the value that corresponds to the key. The search is case-insensitive. If
8868 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8869 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8870 variable &$value$& contains the value that has been extracted. Afterwards, it
8871 is restored to any previous value it might have had.
8872
8873 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8874 key is not found. If {<&'string2'&>} is also omitted, the value that was
8875 extracted is used. Thus, for example, these two expansions are identical, and
8876 yield &"2001"&:
8877 .code
8878 ${extract{gid}{uid=1984 gid=2001}}
8879 ${extract{gid}{uid=1984 gid=2001}{$value}}
8880 .endd
8881 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8882 appear, for example:
8883 .code
8884 ${extract{Z}{A=... B=...}{$value} fail }
8885 .endd
8886 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8887 {<&'string2'&>} must be present for &"fail"& to be recognized.
8888
8889
8890 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8891         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8892 .cindex "expansion" "extracting substrings by number"
8893 .cindex "&%extract%&" "substrings by number"
8894 The <&'number'&> argument must consist entirely of decimal digits,
8895 apart from leading and trailing white space, which is ignored.
8896 This is what distinguishes this form of &%extract%& from the previous kind. It
8897 behaves in the same way, except that, instead of extracting a named field, it
8898 extracts from <&'string1'&> the field whose number is given as the first
8899 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8900 <&'string3'&> as before.
8901
8902 The fields in the string are separated by any one of the characters in the
8903 separator string. These may include space or tab characters.
8904 The first field is numbered one. If the number is negative, the fields are
8905 counted from the end of the string, with the rightmost one numbered -1. If the
8906 number given is zero, the entire string is returned. If the modulus of the
8907 number is greater than the number of fields in the string, the result is the
8908 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8909 provided. For example:
8910 .code
8911 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8912 .endd
8913 yields &"42"&, and
8914 .code
8915 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8916 .endd
8917 yields &"99"&. Two successive separators mean that the field between them is
8918 empty (for example, the fifth field above).
8919
8920
8921 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8922 .cindex "list" "selecting by condition"
8923 .cindex "expansion" "selecting from list by condition"
8924 .vindex "&$item$&"
8925 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8926 default, but the separator can be changed in the usual way. For each item
8927 in this list, its value is place in &$item$&, and then the condition is
8928 evaluated. If the condition is true, &$item$& is added to the output as an
8929 item in a new list; if the condition is false, the item is discarded. The
8930 separator used for the output list is the same as the one used for the
8931 input, but a separator setting is not included in the output. For example:
8932 .code
8933 ${filter{a:b:c}{!eq{$item}{b}}
8934 .endd
8935 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8936 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8937
8938
8939 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8940 .cindex "hash function" "textual"
8941 .cindex "expansion" "textual hash"
8942 This is a textual hashing function, and was the first to be implemented in
8943 early versions of Exim. In current releases, there are other hashing functions
8944 (numeric, MD5, and SHA-1), which are described below.
8945
8946 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8947 <&'n'&>. If you are using fixed values for these numbers, that is, if
8948 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8949 use the simpler operator notation that avoids some of the braces:
8950 .code
8951 ${hash_<n>_<m>:<string>}
8952 .endd
8953 The second number is optional (in both notations). If <&'n'&> is greater than
8954 or equal to the length of the string, the expansion item returns the string.
8955 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8956 function to the string. The new string consists of characters taken from the
8957 first <&'m'&> characters of the string
8958 .code
8959 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8960 .endd
8961 If <&'m'&> is not present the value 26 is used, so that only lower case
8962 letters appear. For example:
8963 .display
8964 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8965 &`$hash{5}{monty}}           `&   yields  &`monty`&
8966 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8967 .endd
8968
8969 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8970         &*$h_*&<&'header&~name'&>&*:*&" &&&
8971        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8972         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8973        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8974         &*$rh_*&<&'header&~name'&>&*:*&"
8975 .cindex "expansion" "header insertion"
8976 .vindex "&$header_$&"
8977 .vindex "&$bheader_$&"
8978 .vindex "&$rheader_$&"
8979 .cindex "header lines" "in expansion strings"
8980 .cindex "header lines" "character sets"
8981 .cindex "header lines" "decoding"
8982 Substitute the contents of the named message header line, for example
8983 .code
8984 $header_reply-to:
8985 .endd
8986 The newline that terminates a header line is not included in the expansion, but
8987 internal newlines (caused by splitting the header line over several physical
8988 lines) may be present.
8989
8990 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8991 the data in the header line is interpreted.
8992
8993 .ilist
8994 .cindex "white space" "in header lines"
8995 &%rheader%& gives the original &"raw"& content of the header line, with no
8996 processing at all, and without the removal of leading and trailing white space.
8997
8998 .next
8999 .cindex "base64 encoding" "in header lines"
9000 &%bheader%& removes leading and trailing white space, and then decodes base64
9001 or quoted-printable MIME &"words"& within the header text, but does no
9002 character set translation. If decoding of what looks superficially like a MIME
9003 &"word"& fails, the raw string is returned. If decoding
9004 .cindex "binary zero" "in header line"
9005 produces a binary zero character, it is replaced by a question mark &-- this is
9006 what Exim does for binary zeros that are actually received in header lines.
9007
9008 .next
9009 &%header%& tries to translate the string as decoded by &%bheader%& to a
9010 standard character set. This is an attempt to produce the same string as would
9011 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9012 returned. Translation is attempted only on operating systems that support the
9013 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9014 a system Makefile or in &_Local/Makefile_&.
9015 .endlist ilist
9016
9017 In a filter file, the target character set for &%header%& can be specified by a
9018 command of the following form:
9019 .code
9020 headers charset "UTF-8"
9021 .endd
9022 This command affects all references to &$h_$& (or &$header_$&) expansions in
9023 subsequently obeyed filter commands. In the absence of this command, the target
9024 character set in a filter is taken from the setting of the &%headers_charset%&
9025 option in the runtime configuration. The value of this option defaults to the
9026 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9027 ISO-8859-1.
9028
9029 Header names follow the syntax of RFC 2822, which states that they may contain
9030 any printing characters except space and colon. Consequently, curly brackets
9031 &'do not'& terminate header names, and should not be used to enclose them as
9032 if they were variables. Attempting to do so causes a syntax error.
9033
9034 Only header lines that are common to all copies of a message are visible to
9035 this mechanism. These are the original header lines that are received with the
9036 message, and any that are added by an ACL statement or by a system
9037 filter. Header lines that are added to a particular copy of a message by a
9038 router or transport are not accessible.
9039
9040 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9041 before the DATA ACL, because the header structure is not set up until the
9042 message is received. Header lines that are added in a RCPT ACL (for example)
9043 are saved until the message's incoming header lines are available, at which
9044 point they are added. When a DATA ACL is running, however, header lines added
9045 by earlier ACLs are visible.
9046
9047 Upper case and lower case letters are synonymous in header names. If the
9048 following character is white space, the terminating colon may be omitted, but
9049 this is not recommended, because you may then forget it when it is needed. When
9050 white space terminates the header name, it is included in the expanded string.
9051 If the message does not contain the given header, the expansion item is
9052 replaced by an empty string. (See the &%def%& condition in section
9053 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9054
9055 If there is more than one header with the same name, they are all concatenated
9056 to form the substitution string, up to a maximum length of 64K. Unless
9057 &%rheader%& is being used, leading and trailing white space is removed from
9058 each header before concatenation, and a completely empty header is ignored. A
9059 newline character is then inserted between non-empty headers, but there is no
9060 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9061 those headers that contain lists of addresses, a comma is also inserted at the
9062 junctions between headers. This does not happen for the &%rheader%& expansion.
9063
9064
9065 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9066 .cindex "expansion" "hmac hashing"
9067 .cindex &%hmac%&
9068 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9069 shared secret and some text into a message authentication code, as specified in
9070 RFC 2104. This differs from &`${md5:secret_text...}`& or
9071 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9072 cryptographic hash, allowing for authentication that is not possible with MD5
9073 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9074 present. For example:
9075 .code
9076 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9077 .endd
9078 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9079 produces:
9080 .code
9081 dd97e3ba5d1a61b5006108f8c8252953
9082 .endd
9083 As an example of how this might be used, you might put in the main part of
9084 an Exim configuration:
9085 .code
9086 SPAMSCAN_SECRET=cohgheeLei2thahw
9087 .endd
9088 In a router or a transport you could then have:
9089 .code
9090 headers_add = \
9091   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9092   ${hmac{md5}{SPAMSCAN_SECRET}\
9093   {${primary_hostname},${message_exim_id},$h_message-id:}}
9094 .endd
9095 Then given a message, you can check where it was scanned by looking at the
9096 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9097 this header line is authentic by recomputing the authentication code from the
9098 host name, message ID and the &'Message-id:'& header line. This can be done
9099 using Exim's &%-be%& option, or by other means, for example by using the
9100 &'hmac_md5_hex()'& function in Perl.
9101
9102
9103 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9104 .cindex "expansion" "conditional"
9105 .cindex "&%if%&, expansion item"
9106 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9107 item; otherwise <&'string2'&> is used. The available conditions are described
9108 in section &<<SECTexpcond>>& below. For example:
9109 .code
9110 ${if eq {$local_part}{postmaster} {yes}{no} }
9111 .endd
9112 The second string need not be present; if it is not and the condition is not
9113 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9114 be present instead of the second string (without any curly brackets). In this
9115 case, the expansion is forced to fail if the condition is not true (see section
9116 &<<SECTforexpfai>>&).
9117
9118 If both strings are omitted, the result is the string &`true`& if the condition
9119 is true, and the empty string if the condition is false. This makes it less
9120 cumbersome to write custom ACL and router conditions. For example, instead of
9121 .code
9122 condition = ${if >{$acl_m4}{3}{true}{false}}
9123 .endd
9124 you can use
9125 .code
9126 condition = ${if >{$acl_m4}{3}}
9127 .endd
9128
9129 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9130 .cindex "expansion" "string truncation"
9131 .cindex "&%length%& expansion item"
9132 The &%length%& item is used to extract the initial portion of a string. Both
9133 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9134 you are using a fixed value for the number, that is, if <&'string1'&> does not
9135 change when expanded, you can use the simpler operator notation that avoids
9136 some of the braces:
9137 .code
9138 ${length_<n>:<string>}
9139 .endd
9140 The result of this item is either the first <&'n'&> characters or the whole
9141 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9142 &%strlen%&, which gives the length of a string.
9143
9144
9145 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9146         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9147 This is the first of one of two different types of lookup item, which are both
9148 described in the next item.
9149
9150 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9151         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9152 .cindex "expansion" "lookup in"
9153 .cindex "file" "lookups"
9154 .cindex "lookup" "in expanded string"
9155 The two forms of lookup item specify data lookups in files and databases, as
9156 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9157 lookups, and the second is used for query-style lookups. The <&'key'&>,
9158 <&'file'&>, and <&'query'&> strings are expanded before use.
9159
9160 If there is any white space in a lookup item which is part of a filter command,
9161 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9162 other place where white space is significant, the lookup item must be enclosed
9163 in double quotes. The use of data lookups in users' filter files may be locked
9164 out by the system administrator.
9165
9166 .vindex "&$value$&"
9167 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9168 During its expansion, the variable &$value$& contains the data returned by the
9169 lookup. Afterwards it reverts to the value it had previously (at the outer
9170 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9171 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9172 string on failure. If <&'string2'&> is provided, it can itself be a nested
9173 lookup, thus providing a mechanism for looking up a default value when the
9174 original lookup fails.
9175
9176 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9177 data for the outer lookup while the parameters of the second lookup are
9178 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9179 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9180 appear, and in this case, if the lookup fails, the entire expansion is forced
9181 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9182 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9183 successful lookup, and nothing in the case of failure.
9184
9185 For single-key lookups, the string &"partial"& is permitted to precede the
9186 search type in order to do partial matching, and * or *@ may follow a search
9187 type to request default lookups if the key does not match (see sections
9188 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9189
9190 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9191 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9192 and non-wild parts of the key during the expansion of the replacement text.
9193 They return to their previous values at the end of the lookup item.
9194
9195 This example looks up the postmaster alias in the conventional alias file:
9196 .code
9197 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9198 .endd
9199 This example uses NIS+ to look up the full name of the user corresponding to
9200 the local part of an address, forcing the expansion to fail if it is not found:
9201 .code
9202 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9203   {$value}fail}
9204 .endd
9205
9206
9207 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9208 .cindex "expansion" "list creation"
9209 .vindex "&$item$&"
9210 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9211 default, but the separator can be changed in the usual way. For each item
9212 in this list, its value is place in &$item$&, and then <&'string2'&> is
9213 expanded and added to the output as an item in a new list. The separator used
9214 for the output list is the same as the one used for the input, but a separator
9215 setting is not included in the output. For example:
9216 .code
9217 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9218 .endd
9219 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9220 value of &$item$& is restored to what it was before. See also the &*filter*&
9221 and &*reduce*& expansion items.
9222
9223 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9224 .cindex "expansion" "numeric hash"
9225 .cindex "hash function" "numeric"
9226 The three strings are expanded; the first two must yield numbers. Call them
9227 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9228 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9229 can use the simpler operator notation that avoids some of the braces:
9230 .code
9231 ${nhash_<n>_<m>:<string>}
9232 .endd
9233 The second number is optional (in both notations). If there is only one number,
9234 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9235 processed by a div/mod hash function that returns two numbers, separated by a
9236 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9237 example,
9238 .code
9239 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9240 .endd
9241 returns the string &"6/33"&.
9242
9243
9244
9245 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9246 .cindex "Perl" "use in expanded string"
9247 .cindex "expansion" "calling Perl from"
9248 This item is available only if Exim has been built to include an embedded Perl
9249 interpreter. The subroutine name and the arguments are first separately
9250 expanded, and then the Perl subroutine is called with those arguments. No
9251 additional arguments need be given; the maximum number permitted, including the
9252 name of the subroutine, is nine.
9253
9254 The return value of the subroutine is inserted into the expanded string, unless
9255 the return value is &%undef%&. In that case, the expansion fails in the same
9256 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9257 Whatever you return is evaluated in a scalar context. For example, if you
9258 return the name of a Perl vector, the return value is the size of the vector,
9259 not its contents.
9260
9261 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9262 with the error message that was passed to &%die%&. More details of the embedded
9263 Perl facility are given in chapter &<<CHAPperl>>&.
9264
9265 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9266 out the use of this expansion item in filter files.
9267
9268
9269 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9270 .cindex "&%prvs%& expansion item"
9271 The first argument is a complete email address and the second is secret
9272 keystring. The third argument, specifying a key number, is optional. If absent,
9273 it defaults to 0. The result of the expansion is a prvs-signed email address,
9274 to be typically used with the &%return_path%& option on an &(smtp)& transport
9275 as part of a bounce address tag validation (BATV) scheme. For more discussion
9276 and an example, see section &<<SECTverifyPRVS>>&.
9277
9278 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9279         {*&<&'string'&>&*}}*&"
9280 .cindex "&%prvscheck%& expansion item"
9281 This expansion item is the complement of the &%prvs%& item. It is used for
9282 checking prvs-signed addresses. If the expansion of the first argument does not
9283 yield a syntactically valid prvs-signed address, the whole item expands to the
9284 empty string. When the first argument does expand to a syntactically valid
9285 prvs-signed address, the second argument is expanded, with the prvs-decoded
9286 version of the address and the key number extracted from the address in the
9287 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9288
9289 These two variables can be used in the expansion of the second argument to
9290 retrieve the secret. The validity of the prvs-signed address is then checked
9291 against the secret. The result is stored in the variable &$prvscheck_result$&,
9292 which is empty for failure or &"1"& for success.
9293
9294 The third argument is optional; if it is missing, it defaults to an empty
9295 string. This argument is now expanded. If the result is an empty string, the
9296 result of the expansion is the decoded version of the address. This is the case
9297 whether or not the signature was valid. Otherwise, the result of the expansion
9298 is the expansion of the third argument.
9299
9300 All three variables can be used in the expansion of the third argument.
9301 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9302 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9303
9304 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9305 .cindex "expansion" "inserting an entire file"
9306 .cindex "file" "inserting into expansion"
9307 .cindex "&%readfile%& expansion item"
9308 The file name and end-of-line string are first expanded separately. The file is
9309 then read, and its contents replace the entire item. All newline characters in
9310 the file are replaced by the end-of-line string if it is present. Otherwise,
9311 newlines are left in the string.
9312 String expansion is not applied to the contents of the file. If you want this,
9313 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9314 the string expansion fails.
9315
9316 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9317 locks out the use of this expansion item in filter files.
9318
9319
9320
9321 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9322         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9323 .cindex "expansion" "inserting from a socket"
9324 .cindex "socket, use of in expansion"
9325 .cindex "&%readsocket%& expansion item"
9326 This item inserts data from a Unix domain or Internet socket into the expanded
9327 string. The minimal way of using it uses just two arguments, as in these
9328 examples:
9329 .code
9330 ${readsocket{/socket/name}{request string}}
9331 ${readsocket{inet:some.host:1234}{request string}}
9332 .endd
9333 For a Unix domain socket, the first substring must be the path to the socket.
9334 For an Internet socket, the first substring must contain &`inet:`& followed by
9335 a host name or IP address, followed by a colon and a port, which can be a
9336 number or the name of a TCP port in &_/etc/services_&. An IP address may
9337 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9338 example:
9339 .code
9340 ${readsocket{inet:[::1]:1234}{request string}}
9341 .endd
9342 Only a single host name may be given, but if looking it up yields more than
9343 one IP address, they are each tried in turn until a connection is made. For
9344 both kinds of socket, Exim makes a connection, writes the request string
9345 (unless it is an empty string) and reads from the socket until an end-of-file
9346 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9347 extend what can be done. Firstly, you can vary the timeout. For example:
9348 .code
9349 ${readsocket{/socket/name}{request string}{3s}}
9350 .endd
9351 A fourth argument allows you to change any newlines that are in the data
9352 that is read, in the same way as for &%readfile%& (see above). This example
9353 turns them into spaces:
9354 .code
9355 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9356 .endd
9357 As with all expansions, the substrings are expanded before the processing
9358 happens. Errors in these sub-expansions cause the expansion to fail. In
9359 addition, the following errors can occur:
9360
9361 .ilist
9362 Failure to create a socket file descriptor;
9363 .next
9364 Failure to connect the socket;
9365 .next
9366 Failure to write the request string;
9367 .next
9368 Timeout on reading from the socket.
9369 .endlist
9370
9371 By default, any of these errors causes the expansion to fail. However, if
9372 you supply a fifth substring, it is expanded and used when any of the above
9373 errors occurs. For example:
9374 .code
9375 ${readsocket{/socket/name}{request string}{3s}{\n}\
9376   {socket failure}}
9377 .endd
9378 You can test for the existence of a Unix domain socket by wrapping this
9379 expansion in &`${if exists`&, but there is a race condition between that test
9380 and the actual opening of the socket, so it is safer to use the fifth argument
9381 if you want to be absolutely sure of avoiding an expansion error for a
9382 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9383
9384 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9385 locks out the use of this expansion item in filter files.
9386
9387
9388 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9389 .cindex "expansion" "reducing a list to a scalar"
9390 .cindex "list" "reducing to a scalar"
9391 .vindex "&$value$&"
9392 .vindex "&$item$&"
9393 This operation reduces a list to a single, scalar string. After expansion,
9394 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9395 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9396 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9397 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9398 them. The result of that expansion is assigned to &$value$& before the next
9399 iteration. When the end of the list is reached, the final value of &$value$& is
9400 added to the expansion output. The &*reduce*& expansion item can be used in a
9401 number of ways. For example, to add up a list of numbers:
9402 .code
9403 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9404 .endd
9405 The result of that expansion would be &`6`&. The maximum of a list of numbers
9406 can be found:
9407 .code
9408 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9409 .endd
9410 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9411 restored to what they were before. See also the &*filter*& and &*map*&
9412 expansion items.
9413
9414 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9415 This item inserts &"raw"& header lines. It is described with the &%header%&
9416 expansion item above.
9417
9418 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9419         {*&<&'string2'&>&*}}*&"
9420 .cindex "expansion" "running a command"
9421 .cindex "&%run%& expansion item"
9422 The command and its arguments are first expanded separately, and then the
9423 command is run in a separate process, but under the same uid and gid. As in
9424 other command executions from Exim, a shell is not used by default. If you want
9425 a shell, you must explicitly code it.
9426
9427 The standard input for the command exists, but is empty. The standard output
9428 and standard error are set to the same file descriptor.
9429 .cindex "return code" "from &%run%& expansion"
9430 .vindex "&$value$&"
9431 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9432 and replaces the entire item; during this expansion, the standard output/error
9433 from the command is in the variable &$value$&. If the command fails,
9434 <&'string2'&>, if present, is expanded and used. Once again, during the
9435 expansion, the standard output/error from the command is in the variable
9436 &$value$&.
9437
9438 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9439 can be the word &"fail"& (not in braces) to force expansion failure if the
9440 command does not succeed. If both strings are omitted, the result is contents
9441 of the standard output/error on success, and nothing on failure.
9442
9443 .vindex "&$run_in_acl$&"
9444 The standard output/error of the command is put in the variable &$value$&.
9445 In this ACL example, the output of a command is logged for the admin to
9446 troubleshoot:
9447 .code
9448 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9449       log_message  = Output of id: $value
9450 .endd
9451 If the command requires shell idioms, such as the > redirect operator, the
9452 shell must be invoked directly, such as with:
9453 .code
9454 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9455 .endd
9456
9457 .vindex "&$runrc$&"
9458 The return code from the command is put in the variable &$runrc$&, and this
9459 remains set afterwards, so in a filter file you can do things like this:
9460 .code
9461 if "${run{x y z}{}}$runrc" is 1 then ...
9462   elif $runrc is 2 then ...
9463   ...
9464 endif
9465 .endd
9466 If execution of the command fails (for example, the command does not exist),
9467 the return code is 127 &-- the same code that shells use for non-existent
9468 commands.
9469
9470 &*Warning*&: In a router or transport, you cannot assume the order in which
9471 option values are expanded, except for those preconditions whose order of
9472 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9473 by the expansion of one option, and use it in another.
9474
9475 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9476 out the use of this expansion item in filter files.
9477
9478
9479 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9480 .cindex "expansion" "string substitution"
9481 .cindex "&%sg%& expansion item"
9482 This item works like Perl's substitution operator (s) with the global (/g)
9483 option; hence its name. However, unlike the Perl equivalent, Exim does not
9484 modify the subject string; instead it returns the modified string for insertion
9485 into the overall expansion. The item takes three arguments: the subject string,
9486 a regular expression, and a substitution string. For example:
9487 .code
9488 ${sg{abcdefabcdef}{abc}{xyz}}
9489 .endd
9490 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9491 if any $ or \ characters are required in the regular expression or in the
9492 substitution string, they have to be escaped. For example:
9493 .code
9494 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9495 .endd
9496 yields &"defabc"&, and
9497 .code
9498 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9499 .endd
9500 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9501 the regular expression from string expansion.
9502
9503
9504
9505 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9506 .cindex "&%substr%& expansion item"
9507 .cindex "substring extraction"
9508 .cindex "expansion" "substring extraction"
9509 The three strings are expanded; the first two must yield numbers. Call them
9510 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9511 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9512 can use the simpler operator notation that avoids some of the braces:
9513 .code
9514 ${substr_<n>_<m>:<string>}
9515 .endd
9516 The second number is optional (in both notations).
9517 If it is absent in the simpler format, the preceding underscore must also be
9518 omitted.
9519
9520 The &%substr%& item can be used to extract more general substrings than
9521 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9522 length required. For example
9523 .code
9524 ${substr{3}{2}{$local_part}}
9525 .endd
9526 If the starting offset is greater than the string length the result is the
9527 null string; if the length plus starting offset is greater than the string
9528 length, the result is the right-hand part of the string, starting from the
9529 given offset. The first character in the string has offset zero.
9530
9531 The &%substr%& expansion item can take negative offset values to count
9532 from the right-hand end of its operand. The last character is offset -1, the
9533 second-last is offset -2, and so on. Thus, for example,
9534 .code
9535 ${substr{-5}{2}{1234567}}
9536 .endd
9537 yields &"34"&. If the absolute value of a negative offset is greater than the
9538 length of the string, the substring starts at the beginning of the string, and
9539 the length is reduced by the amount of overshoot. Thus, for example,
9540 .code
9541 ${substr{-5}{2}{12}}
9542 .endd
9543 yields an empty string, but
9544 .code
9545 ${substr{-3}{2}{12}}
9546 .endd
9547 yields &"1"&.
9548
9549 When the second number is omitted from &%substr%&, the remainder of the string
9550 is taken if the offset is positive. If it is negative, all characters in the
9551 string preceding the offset point are taken. For example, an offset of -1 and
9552 no length, as in these semantically identical examples:
9553 .code
9554 ${substr_-1:abcde}
9555 ${substr{-1}{abcde}}
9556 .endd
9557 yields all but the last character of the string, that is, &"abcd"&.
9558
9559
9560
9561 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9562         {*&<&'replacements'&>&*}}*&"
9563 .cindex "expansion" "character translation"
9564 .cindex "&%tr%& expansion item"
9565 This item does single-character translation on its subject string. The second
9566 argument is a list of characters to be translated in the subject string. Each
9567 matching character is replaced by the corresponding character from the
9568 replacement list. For example
9569 .code
9570 ${tr{abcdea}{ac}{13}}
9571 .endd
9572 yields &`1b3de1`&. If there are duplicates in the second character string, the
9573 last occurrence is used. If the third string is shorter than the second, its
9574 last character is replicated. However, if it is empty, no translation takes
9575 place.
9576 .endlist
9577
9578
9579
9580 .section "Expansion operators" "SECTexpop"
9581 .cindex "expansion" "operators"
9582 For expansion items that perform transformations on a single argument string,
9583 the &"operator"& notation is used because it is simpler and uses fewer braces.
9584 The substring is first expanded before the operation is applied to it. The
9585 following operations can be performed:
9586
9587 .vlist
9588 .vitem &*${address:*&<&'string'&>&*}*&
9589 .cindex "expansion" "RFC 2822 address handling"
9590 .cindex "&%address%& expansion item"
9591 The string is interpreted as an RFC 2822 address, as it might appear in a
9592 header line, and the effective address is extracted from it. If the string does
9593 not parse successfully, the result is empty.
9594
9595
9596 .vitem &*${addresses:*&<&'string'&>&*}*&
9597 .cindex "expansion" "RFC 2822 address handling"
9598 .cindex "&%addresses%& expansion item"
9599 The string (after expansion) is interpreted as a list of addresses in RFC
9600 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9601 operative address (&'local-part@domain'&) is extracted from each item, and the
9602 result of the expansion is a colon-separated list, with appropriate
9603 doubling of colons should any happen to be present in the email addresses.
9604 Syntactically invalid RFC2822 address items are omitted from the output.
9605
9606 It is possible to specify a character other than colon for the output
9607 separator by starting the string with > followed by the new separator
9608 character. For example:
9609 .code
9610 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9611 .endd
9612 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9613 expansion item, which extracts the working address from a single RFC2822
9614 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9615 processing lists.
9616
9617
9618 .vitem &*${base62:*&<&'digits'&>&*}*&
9619 .cindex "&%base62%& expansion item"
9620 .cindex "expansion" "conversion to base 62"
9621 The string must consist entirely of decimal digits. The number is converted to
9622 base 62 and output as a string of six characters, including leading zeros. In
9623 the few operating environments where Exim uses base 36 instead of base 62 for
9624 its message identifiers (because those systems do not have case-sensitive file
9625 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9626 be absolutely clear: this is &'not'& base64 encoding.
9627
9628 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9629 .cindex "&%base62d%& expansion item"
9630 .cindex "expansion" "conversion to base 62"
9631 The string must consist entirely of base-62 digits, or, in operating
9632 environments where Exim uses base 36 instead of base 62 for its message
9633 identifiers, base-36 digits. The number is converted to decimal and output as a
9634 string.
9635
9636
9637 .vitem &*${domain:*&<&'string'&>&*}*&
9638 .cindex "domain" "extraction"
9639 .cindex "expansion" "domain extraction"
9640 The string is interpreted as an RFC 2822 address and the domain is extracted
9641 from it. If the string does not parse successfully, the result is empty.
9642
9643
9644 .vitem &*${escape:*&<&'string'&>&*}*&
9645 .cindex "expansion" "escaping non-printing characters"
9646 .cindex "&%escape%& expansion item"
9647 If the string contains any non-printing characters, they are converted to
9648 escape sequences starting with a backslash. Whether characters with the most
9649 significant bit set (so-called &"8-bit characters"&) count as printing or not
9650 is controlled by the &%print_topbitchars%& option.
9651
9652
9653 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9654 .cindex "expansion" "expression evaluation"
9655 .cindex "expansion" "arithmetic expression"
9656 .cindex "&%eval%& expansion item"
9657 These items supports simple arithmetic and bitwise logical operations in
9658 expansion strings. The string (after expansion) must be a conventional
9659 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9660 logical operators, and parentheses. All operations are carried out using
9661 integer arithmetic. The operator priorities are as follows (the same as in the
9662 C programming language):
9663 .table2 70pt 300pt
9664 .irow &'highest:'& "not (~), negate (-)"
9665 .irow ""   "multiply (*), divide (/), remainder (%)"
9666 .irow ""   "plus (+), minus (-)"
9667 .irow ""   "shift-left (<<), shift-right (>>)"
9668 .irow ""   "and (&&)"
9669 .irow ""   "xor (^)"
9670 .irow &'lowest:'&  "or (|)"
9671 .endtable
9672 Binary operators with the same priority are evaluated from left to right. White
9673 space is permitted before or after operators.
9674
9675 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9676 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9677 decimal, even if they start with a leading zero; hexadecimal numbers are not
9678 permitted. This can be useful when processing numbers extracted from dates or
9679 times, which often do have leading zeros.
9680
9681 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9682 or 1024*1024*1024,
9683 respectively. Negative numbers are supported. The result of the computation is
9684 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9685
9686 .display
9687 &`${eval:1+1}            `&  yields 2
9688 &`${eval:1+2*3}          `&  yields 7
9689 &`${eval:(1+2)*3}        `&  yields 9
9690 &`${eval:2+42%5}         `&  yields 4
9691 &`${eval:0xc&amp;5}          `&  yields 4
9692 &`${eval:0xc|5}          `&  yields 13
9693 &`${eval:0xc^5}          `&  yields 9
9694 &`${eval:0xc>>1}         `&  yields 6
9695 &`${eval:0xc<<1}         `&  yields 24
9696 &`${eval:~255&amp;0x1234}    `&  yields 4608
9697 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9698 .endd
9699
9700 As a more realistic example, in an ACL you might have
9701 .code
9702 deny   message = Too many bad recipients
9703        condition =                    \
9704          ${if and {                   \
9705            {>{$rcpt_count}{10}}       \
9706            {                          \
9707            <                          \
9708              {$recipients_count}      \
9709              {${eval:$rcpt_count/2}}  \
9710            }                          \
9711          }{yes}{no}}
9712 .endd
9713 The condition is true if there have been more than 10 RCPT commands and
9714 fewer than half of them have resulted in a valid recipient.
9715
9716
9717 .vitem &*${expand:*&<&'string'&>&*}*&
9718 .cindex "expansion" "re-expansion of substring"
9719 The &%expand%& operator causes a string to be expanded for a second time. For
9720 example,
9721 .code
9722 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9723 .endd
9724 first looks up a string in a file while expanding the operand for &%expand%&,
9725 and then re-expands what it has found.
9726
9727
9728 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9729 .cindex "Unicode"
9730 .cindex "UTF-8" "conversion from"
9731 .cindex "expansion" "UTF-8 conversion"
9732 .cindex "&%from_utf8%& expansion item"
9733 The world is slowly moving towards Unicode, although there are no standards for
9734 email yet. However, other applications (including some databases) are starting
9735 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9736 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9737 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9738 the result is an undefined sequence of bytes.
9739
9740 Unicode code points with values less than 256 are compatible with ASCII and
9741 ISO-8859-1 (also known as Latin-1).
9742 For example, character 169 is the copyright symbol in both cases, though the
9743 way it is encoded is different. In UTF-8, more than one byte is needed for
9744 characters with code values greater than 127, whereas ISO-8859-1 is a
9745 single-byte encoding (but thereby limited to 256 characters). This makes
9746 translation from UTF-8 to ISO-8859-1 straightforward.
9747
9748
9749 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9750 .cindex "hash function" "textual"
9751 .cindex "expansion" "textual hash"
9752 The &%hash%& operator is a simpler interface to the hashing function that can
9753 be used when the two parameters are fixed numbers (as opposed to strings that
9754 change when expanded). The effect is the same as
9755 .code
9756 ${hash{<n>}{<m>}{<string>}}
9757 .endd
9758 See the description of the general &%hash%& item above for details. The
9759 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9760
9761
9762
9763 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9764 .cindex "base64 encoding" "conversion from hex"
9765 .cindex "expansion" "hex to base64"
9766 .cindex "&%hex2b64%& expansion item"
9767 This operator converts a hex string into one that is base64 encoded. This can
9768 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9769
9770
9771 .vitem &*${lc:*&<&'string'&>&*}*&
9772 .cindex "case forcing in strings"
9773 .cindex "string" "case forcing"
9774 .cindex "lower casing"
9775 .cindex "expansion" "case forcing"
9776 .cindex "&%lc%& expansion item"
9777 This forces the letters in the string into lower-case, for example:
9778 .code
9779 ${lc:$local_part}
9780 .endd
9781
9782 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9783 .cindex "expansion" "string truncation"
9784 .cindex "&%length%& expansion item"
9785 The &%length%& operator is a simpler interface to the &%length%& function that
9786 can be used when the parameter is a fixed number (as opposed to a string that
9787 changes when expanded). The effect is the same as
9788 .code
9789 ${length{<number>}{<string>}}
9790 .endd
9791 See the description of the general &%length%& item above for details. Note that
9792 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9793 when &%length%& is used as an operator.
9794
9795
9796 .vitem &*${listcount:*&<&'string'&>&*}*&
9797 .cindex "expansion" "list item count"
9798 .cindex "list" "item count"
9799 .cindex "list" "count of items"
9800 .cindex "&%listcount%& expansion item"
9801 The string is interpreted as a list and the number of items is returned.
9802
9803
9804 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*&
9805 .cindex "expansion" "named list"
9806 .cindex "&%listnamed%& expansion item"
9807 The name is interpreted as a named list and the content of the list is returned,
9808 expanding any referenced lists, re-quoting as needed for colon-separation.
9809 If the optional type if given it must be one of "a", "d", "h" or "l"
9810 and selects address-, domain-, host- or localpart- lists to search among respectively.
9811 Otherwise all types are searched in an undefined order and the first
9812 matching list is returned.
9813
9814
9815 .vitem &*${local_part:*&<&'string'&>&*}*&
9816 .cindex "expansion" "local part extraction"
9817 .cindex "&%local_part%& expansion item"
9818 The string is interpreted as an RFC 2822 address and the local part is
9819 extracted from it. If the string does not parse successfully, the result is
9820 empty.
9821
9822
9823 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9824 .cindex "masked IP address"
9825 .cindex "IP address" "masking"
9826 .cindex "CIDR notation"
9827 .cindex "expansion" "IP address masking"
9828 .cindex "&%mask%& expansion item"
9829 If the form of the string to be operated on is not an IP address followed by a
9830 slash and an integer (that is, a network address in CIDR notation), the
9831 expansion fails. Otherwise, this operator converts the IP address to binary,
9832 masks off the least significant bits according to the bit count, and converts
9833 the result back to text, with mask appended. For example,
9834 .code
9835 ${mask:10.111.131.206/28}
9836 .endd
9837 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9838 be mostly used for looking up masked addresses in files, the result for an IPv6
9839 address uses dots to separate components instead of colons, because colon
9840 terminates a key string in lsearch files. So, for example,
9841 .code
9842 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9843 .endd
9844 returns the string
9845 .code
9846 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9847 .endd
9848 Letters in IPv6 addresses are always output in lower case.
9849
9850
9851 .vitem &*${md5:*&<&'string'&>&*}*&
9852 .cindex "MD5 hash"
9853 .cindex "expansion" "MD5 hash"
9854 .cindex "&%md5%& expansion item"
9855 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9856 as a 32-digit hexadecimal number, in which any letters are in lower case.
9857
9858
9859 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9860 .cindex "expansion" "numeric hash"
9861 .cindex "hash function" "numeric"
9862 The &%nhash%& operator is a simpler interface to the numeric hashing function
9863 that can be used when the two parameters are fixed numbers (as opposed to
9864 strings that change when expanded). The effect is the same as
9865 .code
9866 ${nhash{<n>}{<m>}{<string>}}
9867 .endd
9868 See the description of the general &%nhash%& item above for details.
9869
9870
9871 .vitem &*${quote:*&<&'string'&>&*}*&
9872 .cindex "quoting" "in string expansions"
9873 .cindex "expansion" "quoting"
9874 .cindex "&%quote%& expansion item"
9875 The &%quote%& operator puts its argument into double quotes if it
9876 is an empty string or
9877 contains anything other than letters, digits, underscores, dots, and hyphens.
9878 Any occurrences of double quotes and backslashes are escaped with a backslash.
9879 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9880 respectively For example,
9881 .code
9882 ${quote:ab"*"cd}
9883 .endd
9884 becomes
9885 .code
9886 "ab\"*\"cd"
9887 .endd
9888 The place where this is useful is when the argument is a substitution from a
9889 variable or a message header.
9890
9891 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9892 .cindex "&%quote_local_part%& expansion item"
9893 This operator is like &%quote%&, except that it quotes the string only if
9894 required to do so by the rules of RFC 2822 for quoting local parts. For
9895 example, a plus sign would not cause quoting (but it would for &%quote%&).
9896 If you are creating a new email address from the contents of &$local_part$&
9897 (or any other unknown data), you should always use this operator.
9898
9899
9900 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9901 .cindex "quoting" "lookup-specific"
9902 This operator applies lookup-specific quoting rules to the string. Each
9903 query-style lookup type has its own quoting rules which are described with
9904 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9905 .code
9906 ${quote_ldap:two * two}
9907 .endd
9908 returns
9909 .code
9910 two%20%5C2A%20two
9911 .endd
9912 For single-key lookup types, no quoting is ever necessary and this operator
9913 yields an unchanged string.
9914
9915
9916 .vitem &*${randint:*&<&'n'&>&*}*&
9917 .cindex "random number"
9918 This operator returns a somewhat random number which is less than the
9919 supplied number and is at least 0.  The quality of this randomness depends
9920 on how Exim was built; the values are not suitable for keying material.
9921 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9922 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9923 for versions of GnuTLS with that function.
9924 Otherwise, the implementation may be arc4random(), random() seeded by
9925 srandomdev() or srandom(), or a custom implementation even weaker than
9926 random().
9927
9928
9929 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9930 .cindex "expansion" "IP address"
9931 This operator reverses an IP address; for IPv4 addresses, the result is in
9932 dotted-quad decimal form, while for IPv6 addreses the result is in
9933 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9934 for DNS.  For example,
9935 .code
9936 ${reverse_ip:192.0.2.4}
9937 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
9938 .endd
9939 returns
9940 .code
9941 4.2.0.192
9942 f.7.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
9943 .endd
9944
9945
9946 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9947 .cindex "expansion" "RFC 2047"
9948 .cindex "RFC 2047" "expansion operator"
9949 .cindex "&%rfc2047%& expansion item"
9950 This operator encodes text according to the rules of RFC 2047. This is an
9951 encoding that is used in header lines to encode non-ASCII characters. It is
9952 assumed that the input string is in the encoding specified by the
9953 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9954 contains only characters in the range 33&--126, and no instances of the
9955 characters
9956 .code
9957 ? = ( ) < > @ , ; : \ " . [ ] _
9958 .endd
9959 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9960 string, using as many &"encoded words"& as necessary to encode all the
9961 characters.
9962
9963
9964 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9965 .cindex "expansion" "RFC 2047"
9966 .cindex "RFC 2047" "decoding"
9967 .cindex "&%rfc2047d%& expansion item"
9968 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9969 bytes are replaced by question marks. Characters are converted into the
9970 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9971 not recognized unless &%check_rfc2047_length%& is set false.
9972
9973 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9974 access a header line, RFC 2047 decoding is done automatically. You do not need
9975 to use this operator as well.
9976
9977
9978
9979 .vitem &*${rxquote:*&<&'string'&>&*}*&
9980 .cindex "quoting" "in regular expressions"
9981 .cindex "regular expressions" "quoting"
9982 .cindex "&%rxquote%& expansion item"
9983 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9984 characters in its argument. This is useful when substituting the values of
9985 variables or headers inside regular expressions.
9986
9987
9988 .vitem &*${sha1:*&<&'string'&>&*}*&
9989 .cindex "SHA-1 hash"
9990 .cindex "expansion" "SHA-1 hashing"
9991 .cindex "&%sha2%& expansion item"
9992 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9993 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9994
9995
9996 .vitem &*${stat:*&<&'string'&>&*}*&
9997 .cindex "expansion" "statting a file"
9998 .cindex "file" "extracting characteristics"
9999 .cindex "&%stat%& expansion item"
10000 The string, after expansion, must be a file path. A call to the &[stat()]&
10001 function is made for this path. If &[stat()]& fails, an error occurs and the
10002 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10003 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10004 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10005 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10006 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10007 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10008 can extract individual fields using the &%extract%& expansion item.
10009
10010 The use of the &%stat%& expansion in users' filter files can be locked out by
10011 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10012 systems for files larger than 2GB.
10013
10014 .vitem &*${str2b64:*&<&'string'&>&*}*&
10015 .cindex "expansion" "base64 encoding"
10016 .cindex "base64 encoding" "in string expansion"
10017 .cindex "&%str2b64%& expansion item"
10018 This operator converts a string into one that is base64 encoded.
10019
10020
10021
10022 .vitem &*${strlen:*&<&'string'&>&*}*&
10023 .cindex "expansion" "string length"
10024 .cindex "string" "length in expansion"
10025 .cindex "&%strlen%& expansion item"
10026 The item is replace by the length of the expanded string, expressed as a
10027 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10028
10029
10030 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10031 .cindex "&%substr%& expansion item"
10032 .cindex "substring extraction"
10033 .cindex "expansion" "substring expansion"
10034 The &%substr%& operator is a simpler interface to the &%substr%& function that
10035 can be used when the two parameters are fixed numbers (as opposed to strings
10036 that change when expanded). The effect is the same as
10037 .code
10038 ${substr{<start>}{<length>}{<string>}}
10039 .endd
10040 See the description of the general &%substr%& item above for details. The
10041 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10042
10043 .vitem &*${time_eval:*&<&'string'&>&*}*&
10044 .cindex "&%time_eval%& expansion item"
10045 .cindex "time interval" "decoding"
10046 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10047 seconds.
10048
10049 .vitem &*${time_interval:*&<&'string'&>&*}*&
10050 .cindex "&%time_interval%& expansion item"
10051 .cindex "time interval" "formatting"
10052 The argument (after sub-expansion) must be a sequence of decimal digits that
10053 represents an interval of time as a number of seconds. It is converted into a
10054 number of larger units and output in Exim's normal time format, for example,
10055 &`1w3d4h2m6s`&.
10056
10057 .vitem &*${uc:*&<&'string'&>&*}*&
10058 .cindex "case forcing in strings"
10059 .cindex "string" "case forcing"
10060 .cindex "upper casing"
10061 .cindex "expansion" "case forcing"
10062 .cindex "&%uc%& expansion item"
10063 This forces the letters in the string into upper-case.
10064 .endlist
10065
10066
10067
10068
10069
10070
10071 .section "Expansion conditions" "SECTexpcond"
10072 .scindex IIDexpcond "expansion" "conditions"
10073 The following conditions are available for testing by the &%${if%& construct
10074 while expanding strings:
10075
10076 .vlist
10077 .vitem &*!*&<&'condition'&>
10078 .cindex "expansion" "negating a condition"
10079 .cindex "negation" "in expansion condition"
10080 Preceding any condition with an exclamation mark negates the result of the
10081 condition.
10082
10083 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10084 .cindex "numeric comparison"
10085 .cindex "expansion" "numeric comparison"
10086 There are a number of symbolic operators for doing numeric comparisons. They
10087 are:
10088 .display
10089 &`=   `&   equal
10090 &`==  `&   equal
10091 &`>   `&   greater
10092 &`>=  `&   greater or equal
10093 &`<   `&   less
10094 &`<=  `&   less or equal
10095 .endd
10096 For example:
10097 .code
10098 ${if >{$message_size}{10M} ...
10099 .endd
10100 Note that the general negation operator provides for inequality testing. The
10101 two strings must take the form of optionally signed decimal integers,
10102 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10103 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10104 As a special case, the numerical value of an empty string is taken as
10105 zero.
10106
10107 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10108 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10109 10M, not if 10M is larger than &$message_size$&.
10110
10111
10112 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10113         {*&<&'arg2'&>&*}...}*&
10114 .cindex "expansion" "calling an acl"
10115 .cindex "&%acl%&" "expansion condition"
10116 The name and zero to nine argument strings are first expanded separately.  The expanded
10117 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10118 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10119 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10120 and may use the variables; if another acl expansion is used the values
10121 are restored after it returns.  If the ACL sets
10122 a value using a "message =" modifier the variable $value becomes
10123 the result of the expansion, otherwise it is empty.
10124 If the ACL returns accept the condition is true; if deny, false.
10125 If the ACL returns defer the result is a forced-fail.
10126
10127 .vitem &*bool&~{*&<&'string'&>&*}*&
10128 .cindex "expansion" "boolean parsing"
10129 .cindex "&%bool%& expansion condition"
10130 This condition turns a string holding a true or false representation into
10131 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10132 (case-insensitively); also positive integer numbers map to true if non-zero,
10133 false if zero.
10134 An empty string is treated as false.
10135 Leading and trailing whitespace is ignored;
10136 thus a string consisting only of whitespace is false.
10137 All other string values will result in expansion failure.
10138
10139 When combined with ACL variables, this expansion condition will let you
10140 make decisions in one place and act on those decisions in another place.
10141 For example:
10142 .code
10143 ${if bool{$acl_m_privileged_sender} ...
10144 .endd
10145
10146
10147 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10148 .cindex "expansion" "boolean parsing"
10149 .cindex "&%bool_lax%& expansion condition"
10150 Like &%bool%&, this condition turns a string into a boolean state.  But
10151 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10152 loose definition that the Router &%condition%& option uses.  The empty string
10153 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10154 true.  Leading and trailing whitespace is ignored.
10155
10156 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10157
10158 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10159 .cindex "expansion" "encrypted comparison"
10160 .cindex "encrypted strings, comparing"
10161 .cindex "&%crypteq%& expansion condition"
10162 This condition is included in the Exim binary if it is built to support any
10163 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10164 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10165 included in the binary.
10166
10167 The &%crypteq%& condition has two arguments. The first is encrypted and
10168 compared against the second, which is already encrypted. The second string may
10169 be in the LDAP form for storing encrypted strings, which starts with the
10170 encryption type in curly brackets, followed by the data. If the second string
10171 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10172 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10173 Typically this will be a field from a password file. An example of an encrypted
10174 string in LDAP form is:
10175 .code
10176 {md5}CY9rzUYh03PK3k6DJie09g==
10177 .endd
10178 If such a string appears directly in an expansion, the curly brackets have to
10179 be quoted, because they are part of the expansion syntax. For example:
10180 .code
10181 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10182 .endd
10183 The following encryption types (whose names are matched case-independently) are
10184 supported:
10185
10186 .ilist
10187 .cindex "MD5 hash"
10188 .cindex "base64 encoding" "in encrypted password"
10189 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10190 printable characters to compare with the remainder of the second string. If the
10191 length of the comparison string is 24, Exim assumes that it is base64 encoded
10192 (as in the above example). If the length is 32, Exim assumes that it is a
10193 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10194 comparison fails.
10195
10196 .next
10197 .cindex "SHA-1 hash"
10198 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10199 printable characters to compare with the remainder of the second string. If the
10200 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10201 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10202 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10203
10204 .next
10205 .cindex "&[crypt()]&"
10206 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10207 only the first eight characters of the password. However, in modern operating
10208 systems this is no longer true, and in many cases the entire password is used,
10209 whatever its length.
10210
10211 .next
10212 .cindex "&[crypt16()]&"
10213 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10214 use up to 16 characters of the password in some operating systems. Again, in
10215 modern operating systems, more characters may be used.
10216 .endlist
10217 Exim has its own version of &[crypt16()]&, which is just a double call to
10218 &[crypt()]&. For operating systems that have their own version, setting
10219 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10220 operating system version instead of its own. This option is set by default in
10221 the OS-dependent &_Makefile_& for those operating systems that are known to
10222 support &[crypt16()]&.
10223
10224 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10225 it was not using the same algorithm as some operating systems' versions. It
10226 turns out that as well as &[crypt16()]& there is a function called
10227 &[bigcrypt()]& in some operating systems. This may or may not use the same
10228 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10229
10230 However, since there is now a move away from the traditional &[crypt()]&
10231 functions towards using SHA1 and other algorithms, tidying up this area of
10232 Exim is seen as very low priority.
10233
10234 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10235 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10236 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10237 default is &`{crypt}`&. Whatever the default, you can always use either
10238 function by specifying it explicitly in curly brackets.
10239
10240 .vitem &*def:*&<&'variable&~name'&>
10241 .cindex "expansion" "checking for empty variable"
10242 .cindex "&%def%& expansion condition"
10243 The &%def%& condition must be followed by the name of one of the expansion
10244 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10245 variable does not contain the empty string. For example:
10246 .code
10247 ${if def:sender_ident {from $sender_ident}}
10248 .endd
10249 Note that the variable name is given without a leading &%$%& character. If the
10250 variable does not exist, the expansion fails.
10251
10252 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10253         &~&*def:h_*&<&'header&~name'&>&*:*&"
10254 .cindex "expansion" "checking header line existence"
10255 This condition is true if a message is being processed and the named header
10256 exists in the message. For example,
10257 .code
10258 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10259 .endd
10260 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10261 the header name must be terminated by a colon if white space does not follow.
10262
10263 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10264        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10265 .cindex "string" "comparison"
10266 .cindex "expansion" "string comparison"
10267 .cindex "&%eq%& expansion condition"
10268 .cindex "&%eqi%& expansion condition"
10269 The two substrings are first expanded. The condition is true if the two
10270 resulting strings are identical. For &%eq%& the comparison includes the case of
10271 letters, whereas for &%eqi%& the comparison is case-independent.
10272
10273 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10274 .cindex "expansion" "file existence test"
10275 .cindex "file" "existence test"
10276 .cindex "&%exists%&, expansion condition"
10277 The substring is first expanded and then interpreted as an absolute path. The
10278 condition is true if the named file (or directory) exists. The existence test
10279 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10280 users' filter files may be locked out by the system administrator.
10281
10282 .vitem &*first_delivery*&
10283 .cindex "delivery" "first"
10284 .cindex "first delivery"
10285 .cindex "expansion" "first delivery test"
10286 .cindex "&%first_delivery%& expansion condition"
10287 This condition, which has no data, is true during a message's first delivery
10288 attempt. It is false during any subsequent delivery attempts.
10289
10290
10291 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10292        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10293 .cindex "list" "iterative conditions"
10294 .cindex "expansion" "&*forall*& condition"
10295 .cindex "expansion" "&*forany*& condition"
10296 .vindex "&$item$&"
10297 These conditions iterate over a list. The first argument is expanded to form
10298 the list. By default, the list separator is a colon, but it can be changed by
10299 the normal method. The second argument is interpreted as a condition that is to
10300 be applied to each item in the list in turn. During the interpretation of the
10301 condition, the current list item is placed in a variable called &$item$&.
10302 .ilist
10303 For &*forany*&, interpretation stops if the condition is true for any item, and
10304 the result of the whole condition is true. If the condition is false for all
10305 items in the list, the overall condition is false.
10306 .next
10307 For &*forall*&, interpretation stops if the condition is false for any item,
10308 and the result of the whole condition is false. If the condition is true for
10309 all items in the list, the overall condition is true.
10310 .endlist
10311 Note that negation of &*forany*& means that the condition must be false for all
10312 items for the overall condition to succeed, and negation of &*forall*& means
10313 that the condition must be false for at least one item. In this example, the
10314 list separator is changed to a comma:
10315 .code
10316 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10317 .endd
10318 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10319 being processed, to enable these expansion items to be nested.
10320
10321
10322 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10323        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10324 .cindex "string" "comparison"
10325 .cindex "expansion" "string comparison"
10326 .cindex "&%ge%& expansion condition"
10327 .cindex "&%gei%& expansion condition"
10328 The two substrings are first expanded. The condition is true if the first
10329 string is lexically greater than or equal to the second string. For &%ge%& the
10330 comparison includes the case of letters, whereas for &%gei%& the comparison is
10331 case-independent.
10332
10333 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10334        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10335 .cindex "string" "comparison"
10336 .cindex "expansion" "string comparison"
10337 .cindex "&%gt%& expansion condition"
10338 .cindex "&%gti%& expansion condition"
10339 The two substrings are first expanded. The condition is true if the first
10340 string is lexically greater than the second string. For &%gt%& the comparison
10341 includes the case of letters, whereas for &%gti%& the comparison is
10342 case-independent.
10343
10344 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10345        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10346 .cindex "string" "comparison"
10347 .cindex "list" "iterative conditions"
10348 Both strings are expanded; the second string is treated as a list of simple
10349 strings; if the first string is a member of the second, then the condition
10350 is true.
10351
10352 These are simpler to use versions of the more powerful &*forany*& condition.
10353 Examples, and the &*forany*& equivalents:
10354 .code
10355 ${if inlist{needle}{foo:needle:bar}}
10356   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10357 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10358   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10359 .endd
10360
10361 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10362        &*isip4&~{*&<&'string'&>&*}*& &&&
10363        &*isip6&~{*&<&'string'&>&*}*&
10364 .cindex "IP address" "testing string format"
10365 .cindex "string" "testing for IP address"
10366 .cindex "&%isip%& expansion condition"
10367 .cindex "&%isip4%& expansion condition"
10368 .cindex "&%isip6%& expansion condition"
10369 The substring is first expanded, and then tested to see if it has the form of
10370 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10371 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10372
10373 For an IPv4 address, the test is for four dot-separated components, each of
10374 which consists of from one to three digits. For an IPv6 address, up to eight
10375 colon-separated components are permitted, each containing from one to four
10376 hexadecimal digits. There may be fewer than eight components if an empty
10377 component (adjacent colons) is present. Only one empty component is permitted.
10378
10379 &*Note*&: The checks are just on the form of the address; actual numerical
10380 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10381 check. The main use of these tests is to distinguish between IP addresses and
10382 host names, or between IPv4 and IPv6 addresses. For example, you could use
10383 .code
10384 ${if isip4{$sender_host_address}...
10385 .endd
10386 to test which IP version an incoming SMTP connection is using.
10387
10388 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10389 .cindex "LDAP" "use for authentication"
10390 .cindex "expansion" "LDAP authentication test"
10391 .cindex "&%ldapauth%& expansion condition"
10392 This condition supports user authentication using LDAP. See section
10393 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10394 queries. For this use, the query must contain a user name and password. The
10395 query itself is not used, and can be empty. The condition is true if the
10396 password is not empty, and the user name and password are accepted by the LDAP
10397 server. An empty password is rejected without calling LDAP because LDAP binds
10398 with an empty password are considered anonymous regardless of the username, and
10399 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10400 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10401 this can be used.
10402
10403
10404 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10405        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10406 .cindex "string" "comparison"
10407 .cindex "expansion" "string comparison"
10408 .cindex "&%le%& expansion condition"
10409 .cindex "&%lei%& expansion condition"
10410 The two substrings are first expanded. The condition is true if the first
10411 string is lexically less than or equal to the second string. For &%le%& the
10412 comparison includes the case of letters, whereas for &%lei%& the comparison is
10413 case-independent.
10414
10415 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10416        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10417 .cindex "string" "comparison"
10418 .cindex "expansion" "string comparison"
10419 .cindex "&%lt%& expansion condition"
10420 .cindex "&%lti%& expansion condition"
10421 The two substrings are first expanded. The condition is true if the first
10422 string is lexically less than the second string. For &%lt%& the comparison
10423 includes the case of letters, whereas for &%lti%& the comparison is
10424 case-independent.
10425
10426
10427 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10428 .cindex "expansion" "regular expression comparison"
10429 .cindex "regular expressions" "match in expanded string"
10430 .cindex "&%match%& expansion condition"
10431 The two substrings are first expanded. The second is then treated as a regular
10432 expression and applied to the first. Because of the pre-expansion, if the
10433 regular expression contains dollar, or backslash characters, they must be
10434 escaped. Care must also be taken if the regular expression contains braces
10435 (curly brackets). A closing brace must be escaped so that it is not taken as a
10436 premature termination of <&'string2'&>. The easiest approach is to use the
10437 &`\N`& feature to disable expansion of the regular expression.
10438 For example,
10439 .code
10440 ${if match {$local_part}{\N^\d{3}\N} ...
10441 .endd
10442 If the whole expansion string is in double quotes, further escaping of
10443 backslashes is also required.
10444
10445 The condition is true if the regular expression match succeeds.
10446 The regular expression is not required to begin with a circumflex
10447 metacharacter, but if there is no circumflex, the expression is not anchored,
10448 and it may match anywhere in the subject, not just at the start. If you want
10449 the pattern to match at the end of the subject, you must include the &`$`&
10450 metacharacter at an appropriate point.
10451
10452 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10453 At the start of an &%if%& expansion the values of the numeric variable
10454 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10455 succeeds causes them to be reset to the substrings of that condition and they
10456 will have these values during the expansion of the success string. At the end
10457 of the &%if%& expansion, the previous values are restored. After testing a
10458 combination of conditions using &%or%&, the subsequent values of the numeric
10459 variables are those of the condition that succeeded.
10460
10461 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10462 .cindex "&%match_address%& expansion condition"
10463 See &*match_local_part*&.
10464
10465 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10466 .cindex "&%match_domain%& expansion condition"
10467 See &*match_local_part*&.
10468
10469 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10470 .cindex "&%match_ip%& expansion condition"
10471 This condition matches an IP address to a list of IP address patterns. It must
10472 be followed by two argument strings. The first (after expansion) must be an IP
10473 address or an empty string. The second (not expanded) is a restricted host
10474 list that can match only an IP address, not a host name. For example:
10475 .code
10476 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10477 .endd
10478 The specific types of host list item that are permitted in the list are:
10479
10480 .ilist
10481 An IP address, optionally with a CIDR mask.
10482 .next
10483 A single asterisk, which matches any IP address.
10484 .next
10485 An empty item, which matches only if the IP address is empty. This could be
10486 useful for testing for a locally submitted message or one from specific hosts
10487 in a single test such as
10488 . ==== As this is a nested list, any displays it contains must be indented
10489 . ==== as otherwise they are too far to the left. This comment applies to
10490 . ==== the use of xmlto plus fop. There's no problem when formatting with
10491 . ==== sdop, with or without the extra indent.
10492 .code
10493   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10494 .endd
10495 where the first item in the list is the empty string.
10496 .next
10497 The item @[] matches any of the local host's interface addresses.
10498 .next
10499 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10500 even if &`net-`& is not specified. There is never any attempt to turn the IP
10501 address into a host name. The most common type of linear search for
10502 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10503 masks. For example:
10504 .code
10505   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10506 .endd
10507 It is of course possible to use other kinds of lookup, and in such a case, you
10508 do need to specify the &`net-`& prefix if you want to specify a specific
10509 address mask, for example:
10510 .code
10511   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10512 .endd
10513 However, unless you are combining a &%match_ip%& condition with others, it is
10514 just as easy to use the fact that a lookup is itself a condition, and write:
10515 .code
10516   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10517 .endd
10518 .endlist ilist
10519
10520 Note that <&'string2'&> is not itself subject to string expansion, unless
10521 Exim was built with the EXPAND_LISTMATCH_RHS option.
10522
10523 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10524
10525 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10526 .cindex "domain list" "in expansion condition"
10527 .cindex "address list" "in expansion condition"
10528 .cindex "local part" "list, in expansion condition"
10529 .cindex "&%match_local_part%& expansion condition"
10530 This condition, together with &%match_address%& and &%match_domain%&, make it
10531 possible to test domain, address, and local part lists within expansions. Each
10532 condition requires two arguments: an item and a list to match. A trivial
10533 example is:
10534 .code
10535 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10536 .endd
10537 In each case, the second argument may contain any of the allowable items for a
10538 list of the appropriate type. Also, because the second argument (after
10539 expansion) is a standard form of list, it is possible to refer to a named list.
10540 Thus, you can use conditions like this:
10541 .code
10542 ${if match_domain{$domain}{+local_domains}{...
10543 .endd
10544 .cindex "&`+caseful`&"
10545 For address lists, the matching starts off caselessly, but the &`+caseful`&
10546 item can be used, as in all address lists, to cause subsequent items to
10547 have their local parts matched casefully. Domains are always matched
10548 caselessly.
10549
10550 Note that <&'string2'&> is not itself subject to string expansion, unless
10551 Exim was built with the EXPAND_LISTMATCH_RHS option.
10552
10553 &*Note*&: Host lists are &'not'& supported in this way. This is because
10554 hosts have two identities: a name and an IP address, and it is not clear
10555 how to specify cleanly how such a test would work. However, IP addresses can be
10556 matched using &%match_ip%&.
10557
10558 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10559 .cindex "PAM authentication"
10560 .cindex "AUTH" "with PAM"
10561 .cindex "Solaris" "PAM support"
10562 .cindex "expansion" "PAM authentication test"
10563 .cindex "&%pam%& expansion condition"
10564 &'Pluggable Authentication Modules'&
10565 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10566 available in the latest releases of Solaris and in some GNU/Linux
10567 distributions. The Exim support, which is intended for use in conjunction with
10568 the SMTP AUTH command, is available only if Exim is compiled with
10569 .code
10570 SUPPORT_PAM=yes
10571 .endd
10572 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10573 in some releases of GNU/Linux &%-ldl%& is also needed.
10574
10575 The argument string is first expanded, and the result must be a
10576 colon-separated list of strings. Leading and trailing white space is ignored.
10577 The PAM module is initialized with the service name &"exim"& and the user name
10578 taken from the first item in the colon-separated data string (<&'string1'&>).
10579 The remaining items in the data string are passed over in response to requests
10580 from the authentication function. In the simple case there will only be one
10581 request, for a password, so the data consists of just two strings.
10582
10583 There can be problems if any of the strings are permitted to contain colon
10584 characters. In the usual way, these have to be doubled to avoid being taken as
10585 separators. If the data is being inserted from a variable, the &%sg%& expansion
10586 item can be used to double any existing colons. For example, the configuration
10587 of a LOGIN authenticator might contain this setting:
10588 .code
10589 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10590 .endd
10591 For a PLAIN authenticator you could use:
10592 .code
10593 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10594 .endd
10595 In some operating systems, PAM authentication can be done only from a process
10596 running as root. Since Exim is running as the Exim user when receiving
10597 messages, this means that PAM cannot be used directly in those systems.
10598 A patched version of the &'pam_unix'& module that comes with the
10599 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10600 The patched module allows one special uid/gid combination, in addition to root,
10601 to authenticate. If you build the patched module to allow the Exim user and
10602 group, PAM can then be used from an Exim authenticator.
10603
10604
10605 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10606 .cindex "&'pwcheck'& daemon"
10607 .cindex "Cyrus"
10608 .cindex "expansion" "&'pwcheck'& authentication test"
10609 .cindex "&%pwcheck%& expansion condition"
10610 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10611 This is one way of making it possible for passwords to be checked by a process
10612 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10613 deprecated. Its replacement is &'saslauthd'& (see below).
10614
10615 The pwcheck support is not included in Exim by default. You need to specify
10616 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10617 building Exim. For example:
10618 .code
10619 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10620 .endd
10621 You do not need to install the full Cyrus software suite in order to use
10622 the pwcheck daemon. You can compile and install just the daemon alone
10623 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10624 access to the &_/var/pwcheck_& directory.
10625
10626 The &%pwcheck%& condition takes one argument, which must be the user name and
10627 password, separated by a colon. For example, in a LOGIN authenticator
10628 configuration, you might have this:
10629 .code
10630 server_condition = ${if pwcheck{$auth1:$auth2}}
10631 .endd
10632 Again, for a PLAIN authenticator configuration, this would be:
10633 .code
10634 server_condition = ${if pwcheck{$auth2:$auth3}}
10635 .endd
10636 .vitem &*queue_running*&
10637 .cindex "queue runner" "detecting when delivering from"
10638 .cindex "expansion" "queue runner test"
10639 .cindex "&%queue_running%& expansion condition"
10640 This condition, which has no data, is true during delivery attempts that are
10641 initiated by queue runner processes, and false otherwise.
10642
10643
10644 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10645 .cindex "Radius"
10646 .cindex "expansion" "Radius authentication"
10647 .cindex "&%radius%& expansion condition"
10648 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10649 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10650 the Radius client configuration file in order to build Exim with Radius
10651 support.
10652
10653 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10654 library, using the original API. If you are using release 0.4.0 or later of
10655 this library, you need to set
10656 .code
10657 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10658 .endd
10659 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10660 &%libradius%& library that comes with FreeBSD. To do this, set
10661 .code
10662 RADIUS_LIB_TYPE=RADLIB
10663 .endd
10664 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10665 You may also have to supply a suitable setting in EXTRALIBS so that the
10666 Radius library can be found when Exim is linked.
10667
10668 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10669 Radius client library, which calls the Radius server. The condition is true if
10670 the authentication is successful. For example:
10671 .code
10672 server_condition = ${if radius{<arguments>}}
10673 .endd
10674
10675
10676 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10677         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10678 .cindex "&'saslauthd'& daemon"
10679 .cindex "Cyrus"
10680 .cindex "expansion" "&'saslauthd'& authentication test"
10681 .cindex "&%saslauthd%& expansion condition"
10682 This condition supports user authentication using the Cyrus &'saslauthd'&
10683 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10684 Using this daemon is one way of making it possible for passwords to be checked
10685 by a process that is not running as root.
10686
10687 The saslauthd support is not included in Exim by default. You need to specify
10688 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10689 building Exim. For example:
10690 .code
10691 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10692 .endd
10693 You do not need to install the full Cyrus software suite in order to use
10694 the saslauthd daemon. You can compile and install just the daemon alone
10695 from the Cyrus SASL library.
10696
10697 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10698 two are mandatory. For example:
10699 .code
10700 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10701 .endd
10702 The service and the realm are optional (which is why the arguments are enclosed
10703 in their own set of braces). For details of the meaning of the service and
10704 realm, and how to run the daemon, consult the Cyrus documentation.
10705 .endlist vlist
10706
10707
10708
10709 .section "Combining expansion conditions" "SECID84"
10710 .cindex "expansion" "combining conditions"
10711 Several conditions can be tested at once by combining them using the &%and%&
10712 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10713 conditions on their own, and precede their lists of sub-conditions. Each
10714 sub-condition must be enclosed in braces within the overall braces that contain
10715 the list. No repetition of &%if%& is used.
10716
10717
10718 .vlist
10719 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10720 .cindex "&""or""& expansion condition"
10721 .cindex "expansion" "&""or""& of conditions"
10722 The sub-conditions are evaluated from left to right. The condition is true if
10723 any one of the sub-conditions is true.
10724 For example,
10725 .code
10726 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10727 .endd
10728 When a true sub-condition is found, the following ones are parsed but not
10729 evaluated. If there are several &"match"& sub-conditions the values of the
10730 numeric variables afterwards are taken from the first one that succeeds.
10731
10732 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10733 .cindex "&""and""& expansion condition"
10734 .cindex "expansion" "&""and""& of conditions"
10735 The sub-conditions are evaluated from left to right. The condition is true if
10736 all of the sub-conditions are true. If there are several &"match"&
10737 sub-conditions, the values of the numeric variables afterwards are taken from
10738 the last one. When a false sub-condition is found, the following ones are
10739 parsed but not evaluated.
10740 .endlist
10741 .ecindex IIDexpcond
10742
10743
10744
10745
10746 .section "Expansion variables" "SECTexpvar"
10747 .cindex "expansion" "variables, list of"
10748 This section contains an alphabetical list of all the expansion variables. Some
10749 of them are available only when Exim is compiled with specific options such as
10750 support for TLS or the content scanning extension.
10751
10752 .vlist
10753 .vitem "&$0$&, &$1$&, etc"
10754 .cindex "numerical variables (&$1$& &$2$& etc)"
10755 When a &%match%& expansion condition succeeds, these variables contain the
10756 captured substrings identified by the regular expression during subsequent
10757 processing of the success string of the containing &%if%& expansion item.
10758 However, they do not retain their values afterwards; in fact, their previous
10759 values are restored at the end of processing an &%if%& item. The numerical
10760 variables may also be set externally by some other matching process which
10761 precedes the expansion of the string. For example, the commands available in
10762 Exim filter files include an &%if%& command with its own regular expression
10763 matching condition.
10764
10765 .vitem "&$acl_c...$&"
10766 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10767 can be given any name that starts with &$acl_c$& and is at least six characters
10768 long, but the sixth character must be either a digit or an underscore. For
10769 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10770 variables persist throughout the lifetime of an SMTP connection. They can be
10771 used to pass information between ACLs and between different invocations of the
10772 same ACL. When a message is received, the values of these variables are saved
10773 with the message, and can be accessed by filters, routers, and transports
10774 during subsequent delivery.
10775
10776 .vitem "&$acl_m...$&"
10777 These variables are like the &$acl_c...$& variables, except that their values
10778 are reset after a message has been received. Thus, if several messages are
10779 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10780 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10781 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10782 message is received, the values of these variables are saved with the message,
10783 and can be accessed by filters, routers, and transports during subsequent
10784 delivery.
10785
10786 .vitem &$acl_verify_message$&
10787 .vindex "&$acl_verify_message$&"
10788 After an address verification has failed, this variable contains the failure
10789 message. It retains its value for use in subsequent modifiers. The message can
10790 be preserved by coding like this:
10791 .code
10792 warn !verify = sender
10793      set acl_m0 = $acl_verify_message
10794 .endd
10795 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10796 &%log_message%& modifiers, to include information about the verification
10797 failure.
10798
10799 .vitem &$address_data$&
10800 .vindex "&$address_data$&"
10801 This variable is set by means of the &%address_data%& option in routers. The
10802 value then remains with the address while it is processed by subsequent routers
10803 and eventually a transport. If the transport is handling multiple addresses,
10804 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10805 for more details. &*Note*&: The contents of &$address_data$& are visible in
10806 user filter files.
10807
10808 If &$address_data$& is set when the routers are called from an ACL to verify
10809 a recipient address, the final value is still in the variable for subsequent
10810 conditions and modifiers of the ACL statement. If routing the address caused it
10811 to be redirected to just one address, the child address is also routed as part
10812 of the verification, and in this case the final value of &$address_data$& is
10813 from the child's routing.
10814
10815 If &$address_data$& is set when the routers are called from an ACL to verify a
10816 sender address, the final value is also preserved, but this time in
10817 &$sender_address_data$&, to distinguish it from data from a recipient
10818 address.
10819
10820 In both cases (recipient and sender verification), the value does not persist
10821 after the end of the current ACL statement. If you want to preserve
10822 these values for longer, you can save them in ACL variables.
10823
10824 .vitem &$address_file$&
10825 .vindex "&$address_file$&"
10826 When, as a result of aliasing, forwarding, or filtering, a message is directed
10827 to a specific file, this variable holds the name of the file when the transport
10828 is running. At other times, the variable is empty. For example, using the
10829 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10830 .code
10831 /home/r2d2/savemail
10832 .endd
10833 then when the &(address_file)& transport is running, &$address_file$&
10834 contains the text string &`/home/r2d2/savemail`&.
10835 .cindex "Sieve filter" "value of &$address_file$&"
10836 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10837 then up to the transport configuration to generate an appropriate absolute path
10838 to the relevant file.
10839
10840 .vitem &$address_pipe$&
10841 .vindex "&$address_pipe$&"
10842 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10843 this variable holds the pipe command when the transport is running.
10844
10845 .vitem "&$auth1$& &-- &$auth3$&"
10846 .vindex "&$auth1$&, &$auth2$&, etc"
10847 These variables are used in SMTP authenticators (see chapters
10848 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10849
10850 .vitem &$authenticated_id$&
10851 .cindex "authentication" "id"
10852 .vindex "&$authenticated_id$&"
10853 When a server successfully authenticates a client it may be configured to
10854 preserve some of the authentication information in the variable
10855 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10856 user/password authenticator configuration might preserve the user name for use
10857 in the routers. Note that this is not the same information that is saved in
10858 &$sender_host_authenticated$&.
10859 When a message is submitted locally (that is, not over a TCP connection)
10860 the value of &$authenticated_id$& is normally the login name of the calling
10861 process. However, a trusted user can override this by means of the &%-oMai%&
10862 command line option.
10863
10864
10865
10866
10867 .vitem &$authenticated_sender$&
10868 .cindex "sender" "authenticated"
10869 .cindex "authentication" "sender"
10870 .cindex "AUTH" "on MAIL command"
10871 .vindex "&$authenticated_sender$&"
10872 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10873 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10874 described in section &<<SECTauthparamail>>&. Unless the data is the string
10875 &"<>"&, it is set as the authenticated sender of the message, and the value is
10876 available during delivery in the &$authenticated_sender$& variable. If the
10877 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10878
10879 .vindex "&$qualify_domain$&"
10880 When a message is submitted locally (that is, not over a TCP connection), the
10881 value of &$authenticated_sender$& is an address constructed from the login
10882 name of the calling process and &$qualify_domain$&, except that a trusted user
10883 can override this by means of the &%-oMas%& command line option.
10884
10885
10886 .vitem &$authentication_failed$&
10887 .cindex "authentication" "failure"
10888 .vindex "&$authentication_failed$&"
10889 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10890 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10891 possible to distinguish between &"did not try to authenticate"&
10892 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10893 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10894 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10895 negative response to an AUTH command, including (for example) an attempt to use
10896 an undefined mechanism.
10897
10898 .vitem &$av_failed$&
10899 .cindex "content scanning" "AV scanner failure"
10900 This variable is available when Exim is compiled with the content-scanning
10901 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10902 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10903 the ACL malware condition.
10904
10905 .vitem &$body_linecount$&
10906 .cindex "message body" "line count"
10907 .cindex "body of message" "line count"
10908 .vindex "&$body_linecount$&"
10909 When a message is being received or delivered, this variable contains the
10910 number of lines in the message's body. See also &$message_linecount$&.
10911
10912 .vitem &$body_zerocount$&
10913 .cindex "message body" "binary zero count"
10914 .cindex "body of message" "binary zero count"
10915 .cindex "binary zero" "in message body"
10916 .vindex "&$body_zerocount$&"
10917 When a message is being received or delivered, this variable contains the
10918 number of binary zero bytes (ASCII NULs) in the message's body.
10919
10920 .vitem &$bounce_recipient$&
10921 .vindex "&$bounce_recipient$&"
10922 This is set to the recipient address of a bounce message while Exim is creating
10923 it. It is useful if a customized bounce message text file is in use (see
10924 chapter &<<CHAPemsgcust>>&).
10925
10926 .vitem &$bounce_return_size_limit$&
10927 .vindex "&$bounce_return_size_limit$&"
10928 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10929 up to a multiple of 1000. It is useful when a customized error message text
10930 file is in use (see chapter &<<CHAPemsgcust>>&).
10931
10932 .vitem &$caller_gid$&
10933 .cindex "gid (group id)" "caller"
10934 .vindex "&$caller_gid$&"
10935 The real group id under which the process that called Exim was running. This is
10936 not the same as the group id of the originator of a message (see
10937 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10938 incarnation normally contains the Exim gid.
10939
10940 .vitem &$caller_uid$&
10941 .cindex "uid (user id)" "caller"
10942 .vindex "&$caller_uid$&"
10943 The real user id under which the process that called Exim was running. This is
10944 not the same as the user id of the originator of a message (see
10945 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10946 incarnation normally contains the Exim uid.
10947
10948 .vitem &$compile_date$&
10949 .vindex "&$compile_date$&"
10950 The date on which the Exim binary was compiled.
10951
10952 .vitem &$compile_number$&
10953 .vindex "&$compile_number$&"
10954 The building process for Exim keeps a count of the number
10955 of times it has been compiled. This serves to distinguish different
10956 compilations of the same version of the program.
10957
10958 .vitem &$demime_errorlevel$&
10959 .vindex "&$demime_errorlevel$&"
10960 This variable is available when Exim is compiled with
10961 the content-scanning extension and the obsolete &%demime%& condition. For
10962 details, see section &<<SECTdemimecond>>&.
10963
10964 .vitem &$demime_reason$&
10965 .vindex "&$demime_reason$&"
10966 This variable is available when Exim is compiled with the
10967 content-scanning extension and the obsolete &%demime%& condition. For details,
10968 see section &<<SECTdemimecond>>&.
10969
10970 .vitem &$dnslist_domain$& &&&
10971        &$dnslist_matched$& &&&
10972        &$dnslist_text$& &&&
10973        &$dnslist_value$&
10974 .vindex "&$dnslist_domain$&"
10975 .vindex "&$dnslist_matched$&"
10976 .vindex "&$dnslist_text$&"
10977 .vindex "&$dnslist_value$&"
10978 .cindex "black list (DNS)"
10979 When a DNS (black) list lookup succeeds, these variables are set to contain
10980 the following data from the lookup: the list's domain name, the key that was
10981 looked up, the contents of any associated TXT record, and the value from the
10982 main A record. See section &<<SECID204>>& for more details.
10983
10984 .vitem &$domain$&
10985 .vindex "&$domain$&"
10986 When an address is being routed, or delivered on its own, this variable
10987 contains the domain. Uppercase letters in the domain are converted into lower
10988 case for &$domain$&.
10989
10990 Global address rewriting happens when a message is received, so the value of
10991 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10992 is set during user filtering, but not during system filtering, because a
10993 message may have many recipients and the system filter is called just once.
10994
10995 When more than one address is being delivered at once (for example, several
10996 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10997 have the same domain. Transports can be restricted to handling only one domain
10998 at a time if the value of &$domain$& is required at transport time &-- this is
10999 the default for local transports. For further details of the environment in
11000 which local transports are run, see chapter &<<CHAPenvironment>>&.
11001
11002 .oindex "&%delay_warning_condition%&"
11003 At the end of a delivery, if all deferred addresses have the same domain, it is
11004 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11005
11006 The &$domain$& variable is also used in some other circumstances:
11007
11008 .ilist
11009 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11010 the recipient address. The domain of the &'sender'& address is in
11011 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11012 normally set during the running of the MAIL ACL. However, if the sender address
11013 is verified with a callout during the MAIL ACL, the sender domain is placed in
11014 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11015 the &(smtp)& transport.
11016
11017 .next
11018 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11019 &$domain$& contains the domain portion of the address that is being rewritten;
11020 it can be used in the expansion of the replacement address, for example, to
11021 rewrite domains by file lookup.
11022
11023 .next
11024 With one important exception, whenever a domain list is being scanned,
11025 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11026 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11027 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11028 that, in a RCPT ACL, the sender domain list can be dependent on the
11029 recipient domain (which is what is in &$domain$& at this time).
11030
11031 .next
11032 .cindex "ETRN" "value of &$domain$&"
11033 .oindex "&%smtp_etrn_command%&"
11034 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11035 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11036 .endlist
11037
11038
11039 .vitem &$domain_data$&
11040 .vindex "&$domain_data$&"
11041 When the &%domains%& option on a router matches a domain by
11042 means of a lookup, the data read by the lookup is available during the running
11043 of the router as &$domain_data$&. In addition, if the driver routes the
11044 address to a transport, the value is available in that transport. If the
11045 transport is handling multiple addresses, the value from the first address is
11046 used.
11047
11048 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11049 domain by means of a lookup. The data read by the lookup is available during
11050 the rest of the ACL statement. In all other situations, this variable expands
11051 to nothing.
11052
11053 .vitem &$exim_gid$&
11054 .vindex "&$exim_gid$&"
11055 This variable contains the numerical value of the Exim group id.
11056
11057 .vitem &$exim_path$&
11058 .vindex "&$exim_path$&"
11059 This variable contains the path to the Exim binary.
11060
11061 .vitem &$exim_uid$&
11062 .vindex "&$exim_uid$&"
11063 This variable contains the numerical value of the Exim user id.
11064
11065 .vitem &$found_extension$&
11066 .vindex "&$found_extension$&"
11067 This variable is available when Exim is compiled with the
11068 content-scanning extension and the obsolete &%demime%& condition. For details,
11069 see section &<<SECTdemimecond>>&.
11070
11071 .vitem &$header_$&<&'name'&>
11072 This is not strictly an expansion variable. It is expansion syntax for
11073 inserting the message header line with the given name. Note that the name must
11074 be terminated by colon or white space, because it may contain a wide variety of
11075 characters. Note also that braces must &'not'& be used.
11076
11077 .vitem &$headers_added$&
11078 .vindex "&$headers_added$&"
11079 Within an ACL this variable contains the headers added so far by
11080 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11081 The headers are a newline-separated list.
11082
11083 .vitem &$home$&
11084 .vindex "&$home$&"
11085 When the &%check_local_user%& option is set for a router, the user's home
11086 directory is placed in &$home$& when the check succeeds. In particular, this
11087 means it is set during the running of users' filter files. A router may also
11088 explicitly set a home directory for use by a transport; this can be overridden
11089 by a setting on the transport itself.
11090
11091 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11092 of the environment variable HOME.
11093
11094 .vitem &$host$&
11095 .vindex "&$host$&"
11096 If a router assigns an address to a transport (any transport), and passes a
11097 list of hosts with the address, the value of &$host$& when the transport starts
11098 to run is the name of the first host on the list. Note that this applies both
11099 to local and remote transports.
11100
11101 .cindex "transport" "filter"
11102 .cindex "filter" "transport filter"
11103 For the &(smtp)& transport, if there is more than one host, the value of
11104 &$host$& changes as the transport works its way through the list. In
11105 particular, when the &(smtp)& transport is expanding its options for encryption
11106 using TLS, or for specifying a transport filter (see chapter
11107 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11108 is connected.
11109
11110 When used in the client part of an authenticator configuration (see chapter
11111 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11112 client is connected.
11113
11114
11115 .vitem &$host_address$&
11116 .vindex "&$host_address$&"
11117 This variable is set to the remote host's IP address whenever &$host$& is set
11118 for a remote connection. It is also set to the IP address that is being checked
11119 when the &%ignore_target_hosts%& option is being processed.
11120
11121 .vitem &$host_data$&
11122 .vindex "&$host_data$&"
11123 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11124 result of the lookup is made available in the &$host_data$& variable. This
11125 allows you, for example, to do things like this:
11126 .code
11127 deny  hosts = net-lsearch;/some/file
11128 message = $host_data
11129 .endd
11130 .vitem &$host_lookup_deferred$&
11131 .cindex "host name" "lookup, failure of"
11132 .vindex "&$host_lookup_deferred$&"
11133 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11134 message comes from a remote host and there is an attempt to look up the host's
11135 name from its IP address, and the attempt is not successful, one of these
11136 variables is set to &"1"&.
11137
11138 .ilist
11139 If the lookup receives a definite negative response (for example, a DNS lookup
11140 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11141
11142 .next
11143 If there is any kind of problem during the lookup, such that Exim cannot
11144 tell whether or not the host name is defined (for example, a timeout for a DNS
11145 lookup), &$host_lookup_deferred$& is set to &"1"&.
11146 .endlist ilist
11147
11148 Looking up a host's name from its IP address consists of more than just a
11149 single reverse lookup. Exim checks that a forward lookup of at least one of the
11150 names it receives from a reverse lookup yields the original IP address. If this
11151 is not the case, Exim does not accept the looked up name(s), and
11152 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11153 IP address (for example, the existence of a PTR record in the DNS) is not
11154 sufficient on its own for the success of a host name lookup. If the reverse
11155 lookup succeeds, but there is a lookup problem such as a timeout when checking
11156 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11157 &"1"&. See also &$sender_host_name$&.
11158
11159 .vitem &$host_lookup_failed$&
11160 .vindex "&$host_lookup_failed$&"
11161 See &$host_lookup_deferred$&.
11162
11163
11164 .vitem &$inode$&
11165 .vindex "&$inode$&"
11166 The only time this variable is set is while expanding the &%directory_file%&
11167 option in the &(appendfile)& transport. The variable contains the inode number
11168 of the temporary file which is about to be renamed. It can be used to construct
11169 a unique name for the file.
11170
11171 .vitem &$interface_address$&
11172 .vindex "&$interface_address$&"
11173 This is an obsolete name for &$received_ip_address$&.
11174
11175 .vitem &$interface_port$&
11176 .vindex "&$interface_port$&"
11177 This is an obsolete name for &$received_port$&.
11178
11179 .vitem &$item$&
11180 .vindex "&$item$&"
11181 This variable is used during the expansion of &*forall*& and &*forany*&
11182 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11183 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11184 empty.
11185
11186 .vitem &$ldap_dn$&
11187 .vindex "&$ldap_dn$&"
11188 This variable, which is available only when Exim is compiled with LDAP support,
11189 contains the DN from the last entry in the most recently successful LDAP
11190 lookup.
11191
11192 .vitem &$load_average$&
11193 .vindex "&$load_average$&"
11194 This variable contains the system load average, multiplied by 1000 so that it
11195 is an integer. For example, if the load average is 0.21, the value of the
11196 variable is 210. The value is recomputed every time the variable is referenced.
11197
11198 .vitem &$local_part$&
11199 .vindex "&$local_part$&"
11200 When an address is being routed, or delivered on its own, this
11201 variable contains the local part. When a number of addresses are being
11202 delivered together (for example, multiple RCPT commands in an SMTP
11203 session), &$local_part$& is not set.
11204
11205 Global address rewriting happens when a message is received, so the value of
11206 &$local_part$& during routing and delivery is the value after rewriting.
11207 &$local_part$& is set during user filtering, but not during system filtering,
11208 because a message may have many recipients and the system filter is called just
11209 once.
11210
11211 .vindex "&$local_part_prefix$&"
11212 .vindex "&$local_part_suffix$&"
11213 If a local part prefix or suffix has been recognized, it is not included in the
11214 value of &$local_part$& during routing and subsequent delivery. The values of
11215 any prefix or suffix are in &$local_part_prefix$& and
11216 &$local_part_suffix$&, respectively.
11217
11218 When a message is being delivered to a file, pipe, or autoreply transport as a
11219 result of aliasing or forwarding, &$local_part$& is set to the local part of
11220 the parent address, not to the file name or command (see &$address_file$& and
11221 &$address_pipe$&).
11222
11223 When an ACL is running for a RCPT command, &$local_part$& contains the
11224 local part of the recipient address.
11225
11226 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11227 &$local_part$& contains the local part of the address that is being rewritten;
11228 it can be used in the expansion of the replacement address, for example.
11229
11230 In all cases, all quoting is removed from the local part. For example, for both
11231 the addresses
11232 .code
11233 "abc:xyz"@test.example
11234 abc\:xyz@test.example
11235 .endd
11236 the value of &$local_part$& is
11237 .code
11238 abc:xyz
11239 .endd
11240 If you use &$local_part$& to create another address, you should always wrap it
11241 inside a quoting operator. For example, in a &(redirect)& router you could
11242 have:
11243 .code
11244 data = ${quote_local_part:$local_part}@new.domain.example
11245 .endd
11246 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11247 to process local parts in a case-dependent manner in a router, you can set the
11248 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11249
11250 .vitem &$local_part_data$&
11251 .vindex "&$local_part_data$&"
11252 When the &%local_parts%& option on a router matches a local part by means of a
11253 lookup, the data read by the lookup is available during the running of the
11254 router as &$local_part_data$&. In addition, if the driver routes the address
11255 to a transport, the value is available in that transport. If the transport is
11256 handling multiple addresses, the value from the first address is used.
11257
11258 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11259 matches a local part by means of a lookup. The data read by the lookup is
11260 available during the rest of the ACL statement. In all other situations, this
11261 variable expands to nothing.
11262
11263 .vitem &$local_part_prefix$&
11264 .vindex "&$local_part_prefix$&"
11265 When an address is being routed or delivered, and a
11266 specific prefix for the local part was recognized, it is available in this
11267 variable, having been removed from &$local_part$&.
11268
11269 .vitem &$local_part_suffix$&
11270 .vindex "&$local_part_suffix$&"
11271 When an address is being routed or delivered, and a
11272 specific suffix for the local part was recognized, it is available in this
11273 variable, having been removed from &$local_part$&.
11274
11275 .vitem &$local_scan_data$&
11276 .vindex "&$local_scan_data$&"
11277 This variable contains the text returned by the &[local_scan()]& function when
11278 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11279
11280 .vitem &$local_user_gid$&
11281 .vindex "&$local_user_gid$&"
11282 See &$local_user_uid$&.
11283
11284 .vitem &$local_user_uid$&
11285 .vindex "&$local_user_uid$&"
11286 This variable and &$local_user_gid$& are set to the uid and gid after the
11287 &%check_local_user%& router precondition succeeds. This means that their values
11288 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11289 and &%condition%&), for the &%address_data%& expansion, and for any
11290 router-specific expansions. At all other times, the values in these variables
11291 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11292
11293 .vitem &$localhost_number$&
11294 .vindex "&$localhost_number$&"
11295 This contains the expanded value of the
11296 &%localhost_number%& option. The expansion happens after the main options have
11297 been read.
11298
11299 .vitem &$log_inodes$&
11300 .vindex "&$log_inodes$&"
11301 The number of free inodes in the disk partition where Exim's
11302 log files are being written. The value is recalculated whenever the variable is
11303 referenced. If the relevant file system does not have the concept of inodes,
11304 the value of is -1. See also the &%check_log_inodes%& option.
11305
11306 .vitem &$log_space$&
11307 .vindex "&$log_space$&"
11308 The amount of free space (as a number of kilobytes) in the disk
11309 partition where Exim's log files are being written. The value is recalculated
11310 whenever the variable is referenced. If the operating system does not have the
11311 ability to find the amount of free space (only true for experimental systems),
11312 the space value is -1. See also the &%check_log_space%& option.
11313
11314
11315 .vitem &$mailstore_basename$&
11316 .vindex "&$mailstore_basename$&"
11317 This variable is set only when doing deliveries in &"mailstore"& format in the
11318 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11319 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11320 contains the basename of the files that are being written, that is, the name
11321 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11322 variable is empty.
11323
11324 .vitem &$malware_name$&
11325 .vindex "&$malware_name$&"
11326 This variable is available when Exim is compiled with the
11327 content-scanning extension. It is set to the name of the virus that was found
11328 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11329
11330 .vitem &$max_received_linelength$&
11331 .vindex "&$max_received_linelength$&"
11332 .cindex "maximum" "line length"
11333 .cindex "line length" "maximum"
11334 This variable contains the number of bytes in the longest line that was
11335 received as part of the message, not counting the line termination
11336 character(s).
11337
11338 .vitem &$message_age$&
11339 .cindex "message" "age of"
11340 .vindex "&$message_age$&"
11341 This variable is set at the start of a delivery attempt to contain the number
11342 of seconds since the message was received. It does not change during a single
11343 delivery attempt.
11344
11345 .vitem &$message_body$&
11346 .cindex "body of message" "expansion variable"
11347 .cindex "message body" "in expansion"
11348 .cindex "binary zero" "in message body"
11349 .vindex "&$message_body$&"
11350 .oindex "&%message_body_visible%&"
11351 This variable contains the initial portion of a message's body while it is
11352 being delivered, and is intended mainly for use in filter files. The maximum
11353 number of characters of the body that are put into the variable is set by the
11354 &%message_body_visible%& configuration option; the default is 500.
11355
11356 .oindex "&%message_body_newlines%&"
11357 By default, newlines are converted into spaces in &$message_body$&, to make it
11358 easier to search for phrases that might be split over a line break. However,
11359 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11360 zeros are always converted into spaces.
11361
11362 .vitem &$message_body_end$&
11363 .cindex "body of message" "expansion variable"
11364 .cindex "message body" "in expansion"
11365 .vindex "&$message_body_end$&"
11366 This variable contains the final portion of a message's
11367 body while it is being delivered. The format and maximum size are as for
11368 &$message_body$&.
11369
11370 .vitem &$message_body_size$&
11371 .cindex "body of message" "size"
11372 .cindex "message body" "size"
11373 .vindex "&$message_body_size$&"
11374 When a message is being delivered, this variable contains the size of the body
11375 in bytes. The count starts from the character after the blank line that
11376 separates the body from the header. Newlines are included in the count. See
11377 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11378
11379 .vitem &$message_exim_id$&
11380 .vindex "&$message_exim_id$&"
11381 When a message is being received or delivered, this variable contains the
11382 unique message id that is generated and used by Exim to identify the message.
11383 An id is not created for a message until after its header has been successfully
11384 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11385 line; it is the local id that Exim assigns to the message, for example:
11386 &`1BXTIK-0001yO-VA`&.
11387
11388 .vitem &$message_headers$&
11389 .vindex &$message_headers$&
11390 This variable contains a concatenation of all the header lines when a message
11391 is being processed, except for lines added by routers or transports. The header
11392 lines are separated by newline characters. Their contents are decoded in the
11393 same way as a header line that is inserted by &%bheader%&.
11394
11395 .vitem &$message_headers_raw$&
11396 .vindex &$message_headers_raw$&
11397 This variable is like &$message_headers$& except that no processing of the
11398 contents of header lines is done.
11399
11400 .vitem &$message_id$&
11401 This is an old name for &$message_exim_id$&, which is now deprecated.
11402
11403 .vitem &$message_linecount$&
11404 .vindex "&$message_linecount$&"
11405 This variable contains the total number of lines in the header and body of the
11406 message. Compare &$body_linecount$&, which is the count for the body only.
11407 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11408 number of lines received. Before delivery happens (that is, before filters,
11409 routers, and transports run) the count is increased to include the
11410 &'Received:'& header line that Exim standardly adds, and also any other header
11411 lines that are added by ACLs. The blank line that separates the message header
11412 from the body is not counted.
11413
11414 As with the special case of &$message_size$&, during the expansion of the
11415 appendfile transport's maildir_tag option in maildir format, the value of
11416 &$message_linecount$& is the precise size of the number of newlines in the
11417 file that has been written (minus one for the blank line between the
11418 header and the body).
11419
11420 Here is an example of the use of this variable in a DATA ACL:
11421 .code
11422 deny message   = Too many lines in message header
11423      condition = \
11424       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11425 .endd
11426 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11427 message has not yet been received.
11428
11429 .vitem &$message_size$&
11430 .cindex "size" "of message"
11431 .cindex "message" "size"
11432 .vindex "&$message_size$&"
11433 When a message is being processed, this variable contains its size in bytes. In
11434 most cases, the size includes those headers that were received with the
11435 message, but not those (such as &'Envelope-to:'&) that are added to individual
11436 deliveries as they are written. However, there is one special case: during the
11437 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11438 doing a delivery in maildir format, the value of &$message_size$& is the
11439 precise size of the file that has been written. See also
11440 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11441
11442 .cindex "RCPT" "value of &$message_size$&"
11443 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11444 contains the size supplied on the MAIL command, or -1 if no size was given. The
11445 value may not, of course, be truthful.
11446
11447 .vitem &$mime_$&&'xxx'&
11448 A number of variables whose names start with &$mime$& are
11449 available when Exim is compiled with the content-scanning extension. For
11450 details, see section &<<SECTscanmimepart>>&.
11451
11452 .vitem "&$n0$& &-- &$n9$&"
11453 These variables are counters that can be incremented by means
11454 of the &%add%& command in filter files.
11455
11456 .vitem &$original_domain$&
11457 .vindex "&$domain$&"
11458 .vindex "&$original_domain$&"
11459 When a top-level address is being processed for delivery, this contains the
11460 same value as &$domain$&. However, if a &"child"& address (for example,
11461 generated by an alias, forward, or filter file) is being processed, this
11462 variable contains the domain of the original address (lower cased). This
11463 differs from &$parent_domain$& only when there is more than one level of
11464 aliasing or forwarding. When more than one address is being delivered in a
11465 single transport run, &$original_domain$& is not set.
11466
11467 If a new address is created by means of a &%deliver%& command in a system
11468 filter, it is set up with an artificial &"parent"& address. This has the local
11469 part &'system-filter'& and the default qualify domain.
11470
11471 .vitem &$original_local_part$&
11472 .vindex "&$local_part$&"
11473 .vindex "&$original_local_part$&"
11474 When a top-level address is being processed for delivery, this contains the
11475 same value as &$local_part$&, unless a prefix or suffix was removed from the
11476 local part, because &$original_local_part$& always contains the full local
11477 part. When a &"child"& address (for example, generated by an alias, forward, or
11478 filter file) is being processed, this variable contains the full local part of
11479 the original address.
11480
11481 If the router that did the redirection processed the local part
11482 case-insensitively, the value in &$original_local_part$& is in lower case.
11483 This variable differs from &$parent_local_part$& only when there is more than
11484 one level of aliasing or forwarding. When more than one address is being
11485 delivered in a single transport run, &$original_local_part$& is not set.
11486
11487 If a new address is created by means of a &%deliver%& command in a system
11488 filter, it is set up with an artificial &"parent"& address. This has the local
11489 part &'system-filter'& and the default qualify domain.
11490
11491 .vitem &$originator_gid$&
11492 .cindex "gid (group id)" "of originating user"
11493 .cindex "sender" "gid"
11494 .vindex "&$caller_gid$&"
11495 .vindex "&$originator_gid$&"
11496 This variable contains the value of &$caller_gid$& that was set when the
11497 message was received. For messages received via the command line, this is the
11498 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11499 normally the gid of the Exim user.
11500
11501 .vitem &$originator_uid$&
11502 .cindex "uid (user id)" "of originating user"
11503 .cindex "sender" "uid"
11504 .vindex "&$caller_uid$&"
11505 .vindex "&$originaltor_uid$&"
11506 The value of &$caller_uid$& that was set when the message was received. For
11507 messages received via the command line, this is the uid of the sending user.
11508 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11509 user.
11510
11511 .vitem &$parent_domain$&
11512 .vindex "&$parent_domain$&"
11513 This variable is similar to &$original_domain$& (see
11514 above), except that it refers to the immediately preceding parent address.
11515
11516 .vitem &$parent_local_part$&
11517 .vindex "&$parent_local_part$&"
11518 This variable is similar to &$original_local_part$&
11519 (see above), except that it refers to the immediately preceding parent address.
11520
11521 .vitem &$pid$&
11522 .cindex "pid (process id)" "of current process"
11523 .vindex "&$pid$&"
11524 This variable contains the current process id.
11525
11526 .vitem &$pipe_addresses$&
11527 .cindex "filter" "transport filter"
11528 .cindex "transport" "filter"
11529 .vindex "&$pipe_addresses$&"
11530 This is not an expansion variable, but is mentioned here because the string
11531 &`$pipe_addresses`& is handled specially in the command specification for the
11532 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11533 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11534 It cannot be used in general expansion strings, and provokes an &"unknown
11535 variable"& error if encountered.
11536
11537 .vitem &$primary_hostname$&
11538 .vindex "&$primary_hostname$&"
11539 This variable contains the value set by &%primary_hostname%& in the
11540 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11541 a single-component name, Exim calls &[gethostbyname()]& (or
11542 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11543 qualified host name. See also &$smtp_active_hostname$&.
11544
11545
11546 .vitem &$prvscheck_address$&
11547 This variable is used in conjunction with the &%prvscheck%& expansion item,
11548 which is described in sections &<<SECTexpansionitems>>& and
11549 &<<SECTverifyPRVS>>&.
11550
11551 .vitem &$prvscheck_keynum$&
11552 This variable is used in conjunction with the &%prvscheck%& expansion item,
11553 which is described in sections &<<SECTexpansionitems>>& and
11554 &<<SECTverifyPRVS>>&.
11555
11556 .vitem &$prvscheck_result$&
11557 This variable is used in conjunction with the &%prvscheck%& expansion item,
11558 which is described in sections &<<SECTexpansionitems>>& and
11559 &<<SECTverifyPRVS>>&.
11560
11561 .vitem &$qualify_domain$&
11562 .vindex "&$qualify_domain$&"
11563 The value set for the &%qualify_domain%& option in the configuration file.
11564
11565 .vitem &$qualify_recipient$&
11566 .vindex "&$qualify_recipient$&"
11567 The value set for the &%qualify_recipient%& option in the configuration file,
11568 or if not set, the value of &$qualify_domain$&.
11569
11570 .vitem &$rcpt_count$&
11571 .vindex "&$rcpt_count$&"
11572 When a message is being received by SMTP, this variable contains the number of
11573 RCPT commands received for the current message. If this variable is used in a
11574 RCPT ACL, its value includes the current command.
11575
11576 .vitem &$rcpt_defer_count$&
11577 .vindex "&$rcpt_defer_count$&"
11578 .cindex "4&'xx'& responses" "count of"
11579 When a message is being received by SMTP, this variable contains the number of
11580 RCPT commands in the current message that have previously been rejected with a
11581 temporary (4&'xx'&) response.
11582
11583 .vitem &$rcpt_fail_count$&
11584 .vindex "&$rcpt_fail_count$&"
11585 When a message is being received by SMTP, this variable contains the number of
11586 RCPT commands in the current message that have previously been rejected with a
11587 permanent (5&'xx'&) response.
11588
11589 .vitem &$received_count$&
11590 .vindex "&$received_count$&"
11591 This variable contains the number of &'Received:'& header lines in the message,
11592 including the one added by Exim (so its value is always greater than zero). It
11593 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11594 delivering.
11595
11596 .vitem &$received_for$&
11597 .vindex "&$received_for$&"
11598 If there is only a single recipient address in an incoming message, this
11599 variable contains that address when the &'Received:'& header line is being
11600 built. The value is copied after recipient rewriting has happened, but before
11601 the &[local_scan()]& function is run.
11602
11603 .vitem &$received_ip_address$&
11604 .vindex "&$received_ip_address$&"
11605 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11606 variable is set to the address of the local IP interface, and &$received_port$&
11607 is set to the local port number. (The remote IP address and port are in
11608 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11609 the port value is -1 unless it has been set using the &%-oMi%& command line
11610 option.
11611
11612 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11613 could be used, for example, to make the file name for a TLS certificate depend
11614 on which interface and/or port is being used for the incoming connection. The
11615 values of &$received_ip_address$& and &$received_port$& are saved with any
11616 messages that are received, thus making these variables available at delivery
11617 time.
11618
11619 &*Note:*& There are no equivalent variables for outgoing connections, because
11620 the values are unknown (unless they are explicitly set by options of the
11621 &(smtp)& transport).
11622
11623 .vitem &$received_port$&
11624 .vindex "&$received_port$&"
11625 See &$received_ip_address$&.
11626
11627 .vitem &$received_protocol$&
11628 .vindex "&$received_protocol$&"
11629 When a message is being processed, this variable contains the name of the
11630 protocol by which it was received. Most of the names used by Exim are defined
11631 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11632 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11633 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11634 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11635 connection and the client was successfully authenticated.
11636
11637 Exim uses the protocol name &"smtps"& for the case when encryption is
11638 automatically set up on connection without the use of STARTTLS (see
11639 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11640 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11641 where the client initially uses EHLO, sets up an encrypted connection using
11642 STARTTLS, and then uses HELO afterwards.
11643
11644 The &%-oMr%& option provides a way of specifying a custom protocol name for
11645 messages that are injected locally by trusted callers. This is commonly used to
11646 identify messages that are being re-injected after some kind of scanning.
11647
11648 .vitem &$received_time$&
11649 .vindex "&$received_time$&"
11650 This variable contains the date and time when the current message was received,
11651 as a number of seconds since the start of the Unix epoch.
11652
11653 .vitem &$recipient_data$&
11654 .vindex "&$recipient_data$&"
11655 This variable is set after an indexing lookup success in an ACL &%recipients%&
11656 condition. It contains the data from the lookup, and the value remains set
11657 until the next &%recipients%& test. Thus, you can do things like this:
11658 .display
11659 &`require recipients  = cdb*@;/some/file`&
11660 &`deny    `&&'some further test involving'& &`$recipient_data`&
11661 .endd
11662 &*Warning*&: This variable is set only when a lookup is used as an indexing
11663 method in the address list, using the semicolon syntax as in the example above.
11664 The variable is not set for a lookup that is used as part of the string
11665 expansion that all such lists undergo before being interpreted.
11666
11667 .vitem &$recipient_verify_failure$&
11668 .vindex "&$recipient_verify_failure$&"
11669 In an ACL, when a recipient verification fails, this variable contains
11670 information about the failure. It is set to one of the following words:
11671
11672 .ilist
11673 &"qualify"&: The address was unqualified (no domain), and the message
11674 was neither local nor came from an exempted host.
11675
11676 .next
11677 &"route"&: Routing failed.
11678
11679 .next
11680 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11681 or before the MAIL command (that is, on initial connection, HELO, or
11682 MAIL).
11683
11684 .next
11685 &"recipient"&: The RCPT command in a callout was rejected.
11686 .next
11687
11688 &"postmaster"&: The postmaster check in a callout was rejected.
11689 .endlist
11690
11691 The main use of this variable is expected to be to distinguish between
11692 rejections of MAIL and rejections of RCPT.
11693
11694 .vitem &$recipients$&
11695 .vindex "&$recipients$&"
11696 This variable contains a list of envelope recipients for a message. A comma and
11697 a space separate the addresses in the replacement text. However, the variable
11698 is not generally available, to prevent exposure of Bcc recipients in
11699 unprivileged users' filter files. You can use &$recipients$& only in these
11700 cases:
11701
11702 .olist
11703 In a system filter file.
11704 .next
11705 In the ACLs associated with the DATA command and with non-SMTP messages, that
11706 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11707 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11708 &%acl_not_smtp_mime%&.
11709 .next
11710 From within a &[local_scan()]& function.
11711 .endlist
11712
11713
11714 .vitem &$recipients_count$&
11715 .vindex "&$recipients_count$&"
11716 When a message is being processed, this variable contains the number of
11717 envelope recipients that came with the message. Duplicates are not excluded
11718 from the count. While a message is being received over SMTP, the number
11719 increases for each accepted recipient. It can be referenced in an ACL.
11720
11721
11722 .vitem &$regex_match_string$&
11723 .vindex "&$regex_match_string$&"
11724 This variable is set to contain the matching regular expression after a
11725 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11726
11727
11728 .vitem &$reply_address$&
11729 .vindex "&$reply_address$&"
11730 When a message is being processed, this variable contains the contents of the
11731 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11732 contents of the &'From:'& header line. Apart from the removal of leading
11733 white space, the value is not processed in any way. In particular, no RFC 2047
11734 decoding or character code translation takes place.
11735
11736 .vitem &$return_path$&
11737 .vindex "&$return_path$&"
11738 When a message is being delivered, this variable contains the return path &--
11739 the sender field that will be sent as part of the envelope. It is not enclosed
11740 in <> characters. At the start of routing an address, &$return_path$& has the
11741 same value as &$sender_address$&, but if, for example, an incoming message to a
11742 mailing list has been expanded by a router which specifies a different address
11743 for bounce messages, &$return_path$& subsequently contains the new bounce
11744 address, whereas &$sender_address$& always contains the original sender address
11745 that was received with the message. In other words, &$sender_address$& contains
11746 the incoming envelope sender, and &$return_path$& contains the outgoing
11747 envelope sender.
11748
11749 .vitem &$return_size_limit$&
11750 .vindex "&$return_size_limit$&"
11751 This is an obsolete name for &$bounce_return_size_limit$&.
11752
11753 .vitem &$runrc$&
11754 .cindex "return code" "from &%run%& expansion"
11755 .vindex "&$runrc$&"
11756 This variable contains the return code from a command that is run by the
11757 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11758 assume the order in which option values are expanded, except for those
11759 preconditions whose order of testing is documented. Therefore, you cannot
11760 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11761 another.
11762
11763 .vitem &$self_hostname$&
11764 .oindex "&%self%&" "value of host name"
11765 .vindex "&$self_hostname$&"
11766 When an address is routed to a supposedly remote host that turns out to be the
11767 local host, what happens is controlled by the &%self%& generic router option.
11768 One of its values causes the address to be passed to another router. When this
11769 happens, &$self_hostname$& is set to the name of the local host that the
11770 original router encountered. In other circumstances its contents are null.
11771
11772 .vitem &$sender_address$&
11773 .vindex "&$sender_address$&"
11774 When a message is being processed, this variable contains the sender's address
11775 that was received in the message's envelope. The case of letters in the address
11776 is retained, in both the local part and the domain. For bounce messages, the
11777 value of this variable is the empty string. See also &$return_path$&.
11778
11779 .vitem &$sender_address_data$&
11780 .vindex "&$address_data$&"
11781 .vindex "&$sender_address_data$&"
11782 If &$address_data$& is set when the routers are called from an ACL to verify a
11783 sender address, the final value is preserved in &$sender_address_data$&, to
11784 distinguish it from data from a recipient address. The value does not persist
11785 after the end of the current ACL statement. If you want to preserve it for
11786 longer, you can save it in an ACL variable.
11787
11788 .vitem &$sender_address_domain$&
11789 .vindex "&$sender_address_domain$&"
11790 The domain portion of &$sender_address$&.
11791
11792 .vitem &$sender_address_local_part$&
11793 .vindex "&$sender_address_local_part$&"
11794 The local part portion of &$sender_address$&.
11795
11796 .vitem &$sender_data$&
11797 .vindex "&$sender_data$&"
11798 This variable is set after a lookup success in an ACL &%senders%& condition or
11799 in a router &%senders%& option. It contains the data from the lookup, and the
11800 value remains set until the next &%senders%& test. Thus, you can do things like
11801 this:
11802 .display
11803 &`require senders      = cdb*@;/some/file`&
11804 &`deny    `&&'some further test involving'& &`$sender_data`&
11805 .endd
11806 &*Warning*&: This variable is set only when a lookup is used as an indexing
11807 method in the address list, using the semicolon syntax as in the example above.
11808 The variable is not set for a lookup that is used as part of the string
11809 expansion that all such lists undergo before being interpreted.
11810
11811 .vitem &$sender_fullhost$&
11812 .vindex "&$sender_fullhost$&"
11813 When a message is received from a remote host, this variable contains the host
11814 name and IP address in a single string. It ends with the IP address in square
11815 brackets, followed by a colon and a port number if the logging of ports is
11816 enabled. The format of the rest of the string depends on whether the host
11817 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11818 looking up its IP address. (Looking up the IP address can be forced by the
11819 &%host_lookup%& option, independent of verification.) A plain host name at the
11820 start of the string is a verified host name; if this is not present,
11821 verification either failed or was not requested. A host name in parentheses is
11822 the argument of a HELO or EHLO command. This is omitted if it is identical to
11823 the verified host name or to the host's IP address in square brackets.
11824
11825 .vitem &$sender_helo_name$&
11826 .vindex "&$sender_helo_name$&"
11827 When a message is received from a remote host that has issued a HELO or EHLO
11828 command, the argument of that command is placed in this variable. It is also
11829 set if HELO or EHLO is used when a message is received using SMTP locally via
11830 the &%-bs%& or &%-bS%& options.
11831
11832 .vitem &$sender_host_address$&
11833 .vindex "&$sender_host_address$&"
11834 When a message is received from a remote host, this variable contains that
11835 host's IP address. For locally submitted messages, it is empty.
11836
11837 .vitem &$sender_host_authenticated$&
11838 .vindex "&$sender_host_authenticated$&"
11839 This variable contains the name (not the public name) of the authenticator
11840 driver that successfully authenticated the client from which the message was
11841 received. It is empty if there was no successful authentication. See also
11842 &$authenticated_id$&.
11843
11844 .new
11845 .vitem &$sender_host_dnssec$&
11846 .vindex "&$sender_host_dnssec$&"
11847 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11848 otherwise) then this boolean will have been set true if, and only if, the
11849 resolver library states that the reverse DNS was authenticated data.  At all
11850 other times, this variable is false.
11851
11852 It is likely that you will need to coerce DNSSEC support on in the resolver
11853 library, by setting:
11854 .code
11855 dns_use_dnssec = 1
11856 .endd
11857
11858 Exim does not perform DNSSEC validation itself, instead leaving that to a
11859 validating resolver (eg, unbound, or bind with suitable configuration).
11860
11861 Exim does not (currently) check to see if the forward DNS was also secured
11862 with DNSSEC, only the reverse DNS.
11863
11864 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11865 mechanism in the list, then this variable will be false.
11866 .wen
11867
11868
11869 .vitem &$sender_host_name$&
11870 .vindex "&$sender_host_name$&"
11871 When a message is received from a remote host, this variable contains the
11872 host's name as obtained by looking up its IP address. For messages received by
11873 other means, this variable is empty.
11874
11875 .vindex "&$host_lookup_failed$&"
11876 If the host name has not previously been looked up, a reference to
11877 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11878 A looked up name is accepted only if it leads back to the original IP address
11879 via a forward lookup. If either the reverse or the forward lookup fails to find
11880 any data, or if the forward lookup does not yield the original IP address,
11881 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11882
11883 .vindex "&$host_lookup_deferred$&"
11884 However, if either of the lookups cannot be completed (for example, there is a
11885 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11886 &$host_lookup_failed$& remains set to &"0"&.
11887
11888 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11889 host name again if there is a subsequent reference to &$sender_host_name$&
11890 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11891 is set to &"1"&.
11892
11893 Exim does not automatically look up every calling host's name. If you want
11894 maximum efficiency, you should arrange your configuration so that it avoids
11895 these lookups altogether. The lookup happens only if one or more of the
11896 following are true:
11897
11898 .ilist
11899 A string containing &$sender_host_name$& is expanded.
11900 .next
11901 The calling host matches the list in &%host_lookup%&. In the default
11902 configuration, this option is set to *, so it must be changed if lookups are
11903 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11904 .next
11905 Exim needs the host name in order to test an item in a host list. The items
11906 that require this are described in sections &<<SECThoslispatnam>>& and
11907 &<<SECThoslispatnamsk>>&.
11908 .next
11909 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11910 In this case, the host name is required to compare with the name quoted in any
11911 EHLO or HELO commands that the client issues.
11912 .next
11913 The remote host issues a EHLO or HELO command that quotes one of the
11914 domains in &%helo_lookup_domains%&. The default value of this option is
11915 . ==== As this is a nested list, any displays it contains must be indented
11916 . ==== as otherwise they are too far to the left.
11917 .code
11918   helo_lookup_domains = @ : @[]
11919 .endd
11920 which causes a lookup if a remote host (incorrectly) gives the server's name or
11921 IP address in an EHLO or HELO command.
11922 .endlist
11923
11924
11925 .vitem &$sender_host_port$&
11926 .vindex "&$sender_host_port$&"
11927 When a message is received from a remote host, this variable contains the port
11928 number that was used on the remote host.
11929
11930 .vitem &$sender_ident$&
11931 .vindex "&$sender_ident$&"
11932 When a message is received from a remote host, this variable contains the
11933 identification received in response to an RFC 1413 request. When a message has
11934 been received locally, this variable contains the login name of the user that
11935 called Exim.
11936
11937 .vitem &$sender_rate_$&&'xxx'&
11938 A number of variables whose names begin &$sender_rate_$& are set as part of the
11939 &%ratelimit%& ACL condition. Details are given in section
11940 &<<SECTratelimiting>>&.
11941
11942 .vitem &$sender_rcvhost$&
11943 .cindex "DNS" "reverse lookup"
11944 .cindex "reverse DNS lookup"
11945 .vindex "&$sender_rcvhost$&"
11946 This is provided specifically for use in &'Received:'& headers. It starts with
11947 either the verified host name (as obtained from a reverse DNS lookup) or, if
11948 there is no verified host name, the IP address in square brackets. After that
11949 there may be text in parentheses. When the first item is a verified host name,
11950 the first thing in the parentheses is the IP address in square brackets,
11951 followed by a colon and a port number if port logging is enabled. When the
11952 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11953 the parentheses.
11954
11955 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11956 was used and its argument was not identical to the real host name or IP
11957 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11958 all three items are present in the parentheses, a newline and tab are inserted
11959 into the string, to improve the formatting of the &'Received:'& header.
11960
11961 .vitem &$sender_verify_failure$&
11962 .vindex "&$sender_verify_failure$&"
11963 In an ACL, when a sender verification fails, this variable contains information
11964 about the failure. The details are the same as for
11965 &$recipient_verify_failure$&.
11966
11967 .vitem &$sending_ip_address$&
11968 .vindex "&$sending_ip_address$&"
11969 This variable is set whenever an outgoing SMTP connection to another host has
11970 been set up. It contains the IP address of the local interface that is being
11971 used. This is useful if a host that has more than one IP address wants to take
11972 on different personalities depending on which one is being used. For incoming
11973 connections, see &$received_ip_address$&.
11974
11975 .vitem &$sending_port$&
11976 .vindex "&$sending_port$&"
11977 This variable is set whenever an outgoing SMTP connection to another host has
11978 been set up. It contains the local port that is being used. For incoming
11979 connections, see &$received_port$&.
11980
11981 .vitem &$smtp_active_hostname$&
11982 .vindex "&$smtp_active_hostname$&"
11983 During an incoming SMTP session, this variable contains the value of the active
11984 host name, as specified by the &%smtp_active_hostname%& option. The value of
11985 &$smtp_active_hostname$& is saved with any message that is received, so its
11986 value can be consulted during routing and delivery.
11987
11988 .vitem &$smtp_command$&
11989 .vindex "&$smtp_command$&"
11990 During the processing of an incoming SMTP command, this variable contains the
11991 entire command. This makes it possible to distinguish between HELO and EHLO in
11992 the HELO ACL, and also to distinguish between commands such as these:
11993 .code
11994 MAIL FROM:<>
11995 MAIL FROM: <>
11996 .endd
11997 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11998 command, the address in &$smtp_command$& is the original address before any
11999 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12000 the address after SMTP-time rewriting.
12001
12002 .vitem &$smtp_command_argument$&
12003 .cindex "SMTP" "command, argument for"
12004 .vindex "&$smtp_command_argument$&"
12005 While an ACL is running to check an SMTP command, this variable contains the
12006 argument, that is, the text that follows the command name, with leading white
12007 space removed. Following the introduction of &$smtp_command$&, this variable is
12008 somewhat redundant, but is retained for backwards compatibility.
12009
12010 .vitem &$smtp_count_at_connection_start$&
12011 .vindex "&$smtp_count_at_connection_start$&"
12012 This variable is set greater than zero only in processes spawned by the Exim
12013 daemon for handling incoming SMTP connections. The name is deliberately long,
12014 in order to emphasize what the contents are. When the daemon accepts a new
12015 connection, it increments this variable. A copy of the variable is passed to
12016 the child process that handles the connection, but its value is fixed, and
12017 never changes. It is only an approximation of how many incoming connections
12018 there actually are, because many other connections may come and go while a
12019 single connection is being processed. When a child process terminates, the
12020 daemon decrements its copy of the variable.
12021
12022 .vitem "&$sn0$& &-- &$sn9$&"
12023 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12024 that were current at the end of the system filter file. This allows a system
12025 filter file to set values that can be tested in users' filter files. For
12026 example, a system filter could set a value indicating how likely it is that a
12027 message is junk mail.
12028
12029 .vitem &$spam_$&&'xxx'&
12030 A number of variables whose names start with &$spam$& are available when Exim
12031 is compiled with the content-scanning extension. For details, see section
12032 &<<SECTscanspamass>>&.
12033
12034
12035 .vitem &$spool_directory$&
12036 .vindex "&$spool_directory$&"
12037 The name of Exim's spool directory.
12038
12039 .vitem &$spool_inodes$&
12040 .vindex "&$spool_inodes$&"
12041 The number of free inodes in the disk partition where Exim's spool files are
12042 being written. The value is recalculated whenever the variable is referenced.
12043 If the relevant file system does not have the concept of inodes, the value of
12044 is -1. See also the &%check_spool_inodes%& option.
12045
12046 .vitem &$spool_space$&
12047 .vindex "&$spool_space$&"
12048 The amount of free space (as a number of kilobytes) in the disk partition where
12049 Exim's spool files are being written. The value is recalculated whenever the
12050 variable is referenced. If the operating system does not have the ability to
12051 find the amount of free space (only true for experimental systems), the space
12052 value is -1. For example, to check in an ACL that there is at least 50
12053 megabytes free on the spool, you could write:
12054 .code
12055 condition = ${if > {$spool_space}{50000}}
12056 .endd
12057 See also the &%check_spool_space%& option.
12058
12059
12060 .vitem &$thisaddress$&
12061 .vindex "&$thisaddress$&"
12062 This variable is set only during the processing of the &%foranyaddress%&
12063 command in a filter file. Its use is explained in the description of that
12064 command, which can be found in the separate document entitled &'Exim's
12065 interfaces to mail filtering'&.
12066
12067 .vitem &$tls_in_bits$&
12068 .vindex "&$tls_in_bits$&"
12069 Contains an approximation of the TLS cipher's bit-strength
12070 on the inbound connection; the meaning of
12071 this depends upon the TLS implementation used.
12072 If TLS has not been negotiated, the value will be 0.
12073 The value of this is automatically fed into the Cyrus SASL authenticator
12074 when acting as a server, to specify the "external SSF" (a SASL term).
12075
12076 The deprecated &$tls_bits$& variable refers to the inbound side
12077 except when used in the context of an outbound SMTP delivery, when it refers to
12078 the outbound.
12079
12080 .vitem &$tls_out_bits$&
12081 .vindex "&$tls_out_bits$&"
12082 Contains an approximation of the TLS cipher's bit-strength
12083 on an outbound SMTP connection; the meaning of
12084 this depends upon the TLS implementation used.
12085 If TLS has not been negotiated, the value will be 0.
12086
12087 .vitem &$tls_in_certificate_verified$&
12088 .vindex "&$tls_in_certificate_verified$&"
12089 This variable is set to &"1"& if a TLS certificate was verified when the
12090 message was received, and &"0"& otherwise.
12091
12092 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12093 except when used in the context of an outbound SMTP delivery, when it refers to
12094 the outbound.
12095
12096 .vitem &$tls_out_certificate_verified$&
12097 .vindex "&$tls_out_certificate_verified$&"
12098 This variable is set to &"1"& if a TLS certificate was verified when an
12099 outbound SMTP connection was made,
12100 and &"0"& otherwise.
12101
12102 .vitem &$tls_in_cipher$&
12103 .vindex "&$tls_in_cipher$&"
12104 .vindex "&$tls_cipher$&"
12105 When a message is received from a remote host over an encrypted SMTP
12106 connection, this variable is set to the cipher suite that was negotiated, for
12107 example DES-CBC3-SHA. In other circumstances, in particular, for message
12108 received over unencrypted connections, the variable is empty. Testing
12109 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12110 non-encrypted connections during ACL processing.
12111
12112 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12113 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12114 becomes the same as &$tls_out_cipher$&.
12115
12116 .vitem &$tls_out_cipher$&
12117 .vindex "&$tls_out_cipher$&"
12118 This variable is
12119 cleared before any outgoing SMTP connection is made,
12120 and then set to the outgoing cipher suite if one is negotiated. See chapter
12121 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12122 details of the &(smtp)& transport.
12123
12124 .vitem &$tls_in_peerdn$&
12125 .vindex "&$tls_in_peerdn$&"
12126 .vindex "&$tls_peerdn$&"
12127 When a message is received from a remote host over an encrypted SMTP
12128 connection, and Exim is configured to request a certificate from the client,
12129 the value of the Distinguished Name of the certificate is made available in the
12130 &$tls_in_peerdn$& during subsequent processing.
12131
12132 The deprecated &$tls_peerdn$& variable refers to the inbound side
12133 except when used in the context of an outbound SMTP delivery, when it refers to
12134 the outbound.
12135
12136 .vitem &$tls_out_peerdn$&
12137 .vindex "&$tls_out_peerdn$&"
12138 When a message is being delivered to a remote host over an encrypted SMTP
12139 connection, and Exim is configured to request a certificate from the server,
12140 the value of the Distinguished Name of the certificate is made available in the
12141 &$tls_out_peerdn$& during subsequent processing.
12142
12143 .vitem &$tls_in_sni$&
12144 .vindex "&$tls_in_sni$&"
12145 .vindex "&$tls_sni$&"
12146 .cindex "TLS" "Server Name Indication"
12147 When a TLS session is being established, if the client sends the Server
12148 Name Indication extension, the value will be placed in this variable.
12149 If the variable appears in &%tls_certificate%& then this option and
12150 some others, described in &<<SECTtlssni>>&,
12151 will be re-expanded early in the TLS session, to permit
12152 a different certificate to be presented (and optionally a different key to be
12153 used) to the client, based upon the value of the SNI extension.
12154
12155 The deprecated &$tls_sni$& variable refers to the inbound side
12156 except when used in the context of an outbound SMTP delivery, when it refers to
12157 the outbound.
12158
12159 .vitem &$tls_out_sni$&
12160 .vindex "&$tls_out_sni$&"
12161 .cindex "TLS" "Server Name Indication"
12162 During outbound
12163 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12164 the transport.
12165
12166 .vitem &$tod_bsdinbox$&
12167 .vindex "&$tod_bsdinbox$&"
12168 The time of day and the date, in the format required for BSD-style mailbox
12169 files, for example: Thu Oct 17 17:14:09 1995.
12170
12171 .vitem &$tod_epoch$&
12172 .vindex "&$tod_epoch$&"
12173 The time and date as a number of seconds since the start of the Unix epoch.
12174
12175 .vitem &$tod_epoch_l$&
12176 .vindex "&$tod_epoch_l$&"
12177 The time and date as a number of microseconds since the start of the Unix epoch.
12178
12179 .vitem &$tod_full$&
12180 .vindex "&$tod_full$&"
12181 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12182 +0100. The timezone is always given as a numerical offset from UTC, with
12183 positive values used for timezones that are ahead (east) of UTC, and negative
12184 values for those that are behind (west).
12185
12186 .vitem &$tod_log$&
12187 .vindex "&$tod_log$&"
12188 The time and date in the format used for writing Exim's log files, for example:
12189 1995-10-12 15:32:29, but without a timezone.
12190
12191 .vitem &$tod_logfile$&
12192 .vindex "&$tod_logfile$&"
12193 This variable contains the date in the format yyyymmdd. This is the format that
12194 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12195 flag.
12196
12197 .vitem &$tod_zone$&
12198 .vindex "&$tod_zone$&"
12199 This variable contains the numerical value of the local timezone, for example:
12200 -0500.
12201
12202 .vitem &$tod_zulu$&
12203 .vindex "&$tod_zulu$&"
12204 This variable contains the UTC date and time in &"Zulu"& format, as specified
12205 by ISO 8601, for example: 20030221154023Z.
12206
12207 .vitem &$value$&
12208 .vindex "&$value$&"
12209 This variable contains the result of an expansion lookup, extraction operation,
12210 or external command, as described above. It is also used during a
12211 &*reduce*& expansion.
12212
12213 .vitem &$version_number$&
12214 .vindex "&$version_number$&"
12215 The version number of Exim.
12216
12217 .vitem &$warn_message_delay$&
12218 .vindex "&$warn_message_delay$&"
12219 This variable is set only during the creation of a message warning about a
12220 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12221
12222 .vitem &$warn_message_recipients$&
12223 .vindex "&$warn_message_recipients$&"
12224 This variable is set only during the creation of a message warning about a
12225 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12226 .endlist
12227 .ecindex IIDstrexp
12228
12229
12230
12231 . ////////////////////////////////////////////////////////////////////////////
12232 . ////////////////////////////////////////////////////////////////////////////
12233
12234 .chapter "Embedded Perl" "CHAPperl"
12235 .scindex IIDperl "Perl" "calling from Exim"
12236 Exim can be built to include an embedded Perl interpreter. When this is done,
12237 Perl subroutines can be called as part of the string expansion process. To make
12238 use of the Perl support, you need version 5.004 or later of Perl installed on
12239 your system. To include the embedded interpreter in the Exim binary, include
12240 the line
12241 .code
12242 EXIM_PERL = perl.o
12243 .endd
12244 in your &_Local/Makefile_& and then build Exim in the normal way.
12245
12246
12247 .section "Setting up so Perl can be used" "SECID85"
12248 .oindex "&%perl_startup%&"
12249 Access to Perl subroutines is via a global configuration option called
12250 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12251 no &%perl_startup%& option in the Exim configuration file then no Perl
12252 interpreter is started and there is almost no overhead for Exim (since none of
12253 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12254 option then the associated value is taken to be Perl code which is executed in
12255 a newly created Perl interpreter.
12256
12257 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12258 need backslashes before any characters to escape special meanings. The option
12259 should usually be something like
12260 .code
12261 perl_startup = do '/etc/exim.pl'
12262 .endd
12263 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12264 use from Exim. Exim can be configured either to start up a Perl interpreter as
12265 soon as it is entered, or to wait until the first time it is needed. Starting
12266 the interpreter at the beginning ensures that it is done while Exim still has
12267 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12268 fact used in a particular run. Also, note that this does not mean that Exim is
12269 necessarily running as root when Perl is called at a later time. By default,
12270 the interpreter is started only when it is needed, but this can be changed in
12271 two ways:
12272
12273 .ilist
12274 .oindex "&%perl_at_start%&"
12275 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12276 a startup when Exim is entered.
12277 .next
12278 The command line option &%-ps%& also requests a startup when Exim is entered,
12279 overriding the setting of &%perl_at_start%&.
12280 .endlist
12281
12282 There is also a command line option &%-pd%& (for delay) which suppresses the
12283 initial startup, even if &%perl_at_start%& is set.
12284
12285
12286 .section "Calling Perl subroutines" "SECID86"
12287 When the configuration file includes a &%perl_startup%& option you can make use
12288 of the string expansion item to call the Perl subroutines that are defined
12289 by the &%perl_startup%& code. The operator is used in any of the following
12290 forms:
12291 .code
12292 ${perl{foo}}
12293 ${perl{foo}{argument}}
12294 ${perl{foo}{argument1}{argument2} ... }
12295 .endd
12296 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12297 arguments may be passed. Passing more than this results in an expansion failure
12298 with an error message of the form
12299 .code
12300 Too many arguments passed to Perl subroutine "foo" (max is 8)
12301 .endd
12302 The return value of the Perl subroutine is evaluated in a scalar context before
12303 it is passed back to Exim to be inserted into the expanded string. If the
12304 return value is &'undef'&, the expansion is forced to fail in the same way as
12305 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12306 by obeying Perl's &%die%& function, the expansion fails with the error message
12307 that was passed to &%die%&.
12308
12309
12310 .section "Calling Exim functions from Perl" "SECID87"
12311 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12312 is available to call back into Exim's string expansion function. For example,
12313 the Perl code
12314 .code
12315 my $lp = Exim::expand_string('$local_part');
12316 .endd
12317 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12318 Note those are single quotes and not double quotes to protect against
12319 &$local_part$& being interpolated as a Perl variable.
12320
12321 If the string expansion is forced to fail by a &"fail"& item, the result of
12322 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12323 expansion string, the Perl call from the original expansion string fails with
12324 an appropriate error message, in the same way as if &%die%& were used.
12325
12326 .cindex "debugging" "from embedded Perl"
12327 .cindex "log" "writing from embedded Perl"
12328 Two other Exim functions are available for use from within Perl code.
12329 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12330 debugging is enabled. If you want a newline at the end, you must supply it.
12331 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12332 timestamp. In this case, you should not supply a terminating newline.
12333
12334
12335 .section "Use of standard output and error by Perl" "SECID88"
12336 .cindex "Perl" "standard output and error"
12337 You should not write to the standard error or output streams from within your
12338 Perl code, as it is not defined how these are set up. In versions of Exim
12339 before 4.50, it is possible for the standard output or error to refer to the
12340 SMTP connection during message reception via the daemon. Writing to this stream
12341 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12342 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12343 avoided, but the output is lost.
12344
12345 .cindex "Perl" "use of &%warn%&"
12346 The Perl &%warn%& statement writes to the standard error stream by default.
12347 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12348 you have no control. When Exim starts up the Perl interpreter, it arranges for
12349 output from the &%warn%& statement to be written to the Exim main log. You can
12350 change this by including appropriate Perl magic somewhere in your Perl code.
12351 For example, to discard &%warn%& output completely, you need this:
12352 .code
12353 $SIG{__WARN__} = sub { };
12354 .endd
12355 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12356 example, the code for the subroutine is empty, so it does nothing, but you can
12357 include any Perl code that you like. The text of the &%warn%& message is passed
12358 as the first subroutine argument.
12359 .ecindex IIDperl
12360
12361
12362 . ////////////////////////////////////////////////////////////////////////////
12363 . ////////////////////////////////////////////////////////////////////////////
12364
12365 .chapter "Starting the daemon and the use of network interfaces" &&&
12366          "CHAPinterfaces" &&&
12367          "Starting the daemon"
12368 .cindex "daemon" "starting"
12369 .cindex "interface" "listening"
12370 .cindex "network interface"
12371 .cindex "interface" "network"
12372 .cindex "IP address" "for listening"
12373 .cindex "daemon" "listening IP addresses"
12374 .cindex "TCP/IP" "setting listening interfaces"
12375 .cindex "TCP/IP" "setting listening ports"
12376 A host that is connected to a TCP/IP network may have one or more physical
12377 hardware network interfaces. Each of these interfaces may be configured as one
12378 or more &"logical"& interfaces, which are the entities that a program actually
12379 works with. Each of these logical interfaces is associated with an IP address.
12380 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12381 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12382 knowledge about the host's interfaces for use in three different circumstances:
12383
12384 .olist
12385 When a listening daemon is started, Exim needs to know which interfaces
12386 and ports to listen on.
12387 .next
12388 When Exim is routing an address, it needs to know which IP addresses
12389 are associated with local interfaces. This is required for the correct
12390 processing of MX lists by removing the local host and others with the
12391 same or higher priority values. Also, Exim needs to detect cases
12392 when an address is routed to an IP address that in fact belongs to the
12393 local host. Unless the &%self%& router option or the &%allow_localhost%&
12394 option of the smtp transport is set (as appropriate), this is treated
12395 as an error situation.
12396 .next
12397 When Exim connects to a remote host, it may need to know which interface to use
12398 for the outgoing connection.
12399 .endlist
12400
12401
12402 Exim's default behaviour is likely to be appropriate in the vast majority
12403 of cases. If your host has only one interface, and you want all its IP
12404 addresses to be treated in the same way, and you are using only the
12405 standard SMTP port, you should not need to take any special action. The
12406 rest of this chapter does not apply to you.
12407
12408 In a more complicated situation you may want to listen only on certain
12409 interfaces, or on different ports, and for this reason there are a number of
12410 options that can be used to influence Exim's behaviour. The rest of this
12411 chapter describes how they operate.
12412
12413 When a message is received over TCP/IP, the interface and port that were
12414 actually used are set in &$received_ip_address$& and &$received_port$&.
12415
12416
12417
12418 .section "Starting a listening daemon" "SECID89"
12419 When a listening daemon is started (by means of the &%-bd%& command line
12420 option), the interfaces and ports on which it listens are controlled by the
12421 following options:
12422
12423 .ilist
12424 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12425 compatibility, this option can also be specified in the singular.)
12426 .next
12427 &%local_interfaces%& contains list of interface IP addresses on which to
12428 listen. Each item may optionally also specify a port.
12429 .endlist
12430
12431 The default list separator in both cases is a colon, but this can be changed as
12432 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12433 it is usually best to change the separator to avoid having to double all the
12434 colons. For example:
12435 .code
12436 local_interfaces = <; 127.0.0.1 ; \
12437                       192.168.23.65 ; \
12438                       ::1 ; \
12439                       3ffe:ffff:836f::fe86:a061
12440 .endd
12441 There are two different formats for specifying a port along with an IP address
12442 in &%local_interfaces%&:
12443
12444 .olist
12445 The port is added onto the address with a dot separator. For example, to listen
12446 on port 1234 on two different IP addresses:
12447 .code
12448 local_interfaces = <; 192.168.23.65.1234 ; \
12449                       3ffe:ffff:836f::fe86:a061.1234
12450 .endd
12451 .next
12452 The IP address is enclosed in square brackets, and the port is added
12453 with a colon separator, for example:
12454 .code
12455 local_interfaces = <; [192.168.23.65]:1234 ; \
12456                       [3ffe:ffff:836f::fe86:a061]:1234
12457 .endd
12458 .endlist
12459
12460 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12461 default setting contains just one port:
12462 .code
12463 daemon_smtp_ports = smtp
12464 .endd
12465 If more than one port is listed, each interface that does not have its own port
12466 specified listens on all of them. Ports that are listed in
12467 &%daemon_smtp_ports%& can be identified either by name (defined in
12468 &_/etc/services_&) or by number. However, when ports are given with individual
12469 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12470
12471
12472
12473 .section "Special IP listening addresses" "SECID90"
12474 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12475 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12476 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12477 instead of setting up separate listening sockets for each interface. The
12478 default value of &%local_interfaces%& is
12479 .code
12480 local_interfaces = 0.0.0.0
12481 .endd
12482 when Exim is built without IPv6 support; otherwise it is:
12483 .code
12484 local_interfaces = <; ::0 ; 0.0.0.0
12485 .endd
12486 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12487
12488
12489
12490 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12491 The &%-oX%& command line option can be used to override the values of
12492 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12493 instance. Another way of doing this would be to use macros and the &%-D%&
12494 option. However, &%-oX%& can be used by any admin user, whereas modification of
12495 the runtime configuration by &%-D%& is allowed only when the caller is root or
12496 exim.
12497
12498 The value of &%-oX%& is a list of items. The default colon separator can be
12499 changed in the usual way if required. If there are any items that do not
12500 contain dots or colons (that is, are not IP addresses), the value of
12501 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12502 items that do contain dots or colons, the value of &%local_interfaces%& is
12503 replaced by those items. Thus, for example,
12504 .code
12505 -oX 1225
12506 .endd
12507 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12508 whereas
12509 .code
12510 -oX 192.168.34.5.1125
12511 .endd
12512 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12513 (However, since &%local_interfaces%& now contains no items without ports, the
12514 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12515
12516
12517
12518 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12519 .cindex "ssmtp protocol"
12520 .cindex "smtps protocol"
12521 .cindex "SMTP" "ssmtp protocol"
12522 .cindex "SMTP" "smtps protocol"
12523 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12524 before the STARTTLS command was standardized for SMTP. Some legacy clients
12525 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12526 list of port numbers, connections to those ports must use SSMTP. The most
12527 common use of this option is expected to be
12528 .code
12529 tls_on_connect_ports = 465
12530 .endd
12531 because 465 is the usual port number used by the legacy clients. There is also
12532 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12533 this way when a daemon is started.
12534
12535 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12536 daemon to listen on those ports. You must still specify them in
12537 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12538 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12539 connections via the daemon.)
12540
12541
12542
12543
12544 .section "IPv6 address scopes" "SECID92"
12545 .cindex "IPv6" "address scopes"
12546 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12547 can, in principle, have the same link-local IPv6 address on different
12548 interfaces. Thus, additional information is needed, over and above the IP
12549 address, to distinguish individual interfaces. A convention of using a
12550 percent sign followed by something (often the interface name) has been
12551 adopted in some cases, leading to addresses like this:
12552 .code
12553 fe80::202:b3ff:fe03:45c1%eth0
12554 .endd
12555 To accommodate this usage, a percent sign followed by an arbitrary string is
12556 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12557 to convert a textual IPv6 address for actual use. This function recognizes the
12558 percent convention in operating systems that support it, and it processes the
12559 address appropriately. Unfortunately, some older libraries have problems with
12560 &[getaddrinfo()]&. If
12561 .code
12562 IPV6_USE_INET_PTON=yes
12563 .endd
12564 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12565 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12566 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12567 function.) Of course, this means that the additional functionality of
12568 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12569
12570 .section "Disabling IPv6" "SECID93"
12571 .cindex "IPv6" "disabling"
12572 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12573 run on a host whose kernel does not support IPv6. The binary will fall back to
12574 using IPv4, but it may waste resources looking up AAAA records, and trying to
12575 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12576 .oindex "&%disable_ipv6%&"
12577 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12578 activities take place. AAAA records are never looked up, and any IPv6 addresses
12579 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12580 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12581 to handle IPv6 literal addresses.
12582
12583 On the other hand, when IPv6 is in use, there may be times when you want to
12584 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12585 option to globally suppress the lookup of AAAA records for specified domains,
12586 and you can use the &%ignore_target_hosts%& generic router option to ignore
12587 IPv6 addresses in an individual router.
12588
12589
12590
12591 .section "Examples of starting a listening daemon" "SECID94"
12592 The default case in an IPv6 environment is
12593 .code
12594 daemon_smtp_ports = smtp
12595 local_interfaces = <; ::0 ; 0.0.0.0
12596 .endd
12597 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12598 Either one or two sockets may be used, depending on the characteristics of
12599 the TCP/IP stack. (This is complicated and messy; for more information,
12600 read the comments in the &_daemon.c_& source file.)
12601
12602 To specify listening on ports 25 and 26 on all interfaces:
12603 .code
12604 daemon_smtp_ports = 25 : 26
12605 .endd
12606 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12607 .code
12608 local_interfaces = <; ::0.25     ; ::0.26 \
12609                       0.0.0.0.25 ; 0.0.0.0.26
12610 .endd
12611 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12612 IPv4 loopback address only:
12613 .code
12614 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12615 .endd
12616 To specify listening on the default port on specific interfaces only:
12617 .code
12618 local_interfaces = 10.0.0.67 : 192.168.34.67
12619 .endd
12620 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12621
12622
12623
12624 .section "Recognizing the local host" "SECTreclocipadd"
12625 The &%local_interfaces%& option is also used when Exim needs to determine
12626 whether or not an IP address refers to the local host. That is, the IP
12627 addresses of all the interfaces on which a daemon is listening are always
12628 treated as local.
12629
12630 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12631 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12632 available interfaces from the operating system, and extracts the relevant
12633 (that is, IPv4 or IPv6) addresses to use for checking.
12634
12635 Some systems set up large numbers of virtual interfaces in order to provide
12636 many virtual web servers. In this situation, you may want to listen for
12637 email on only a few of the available interfaces, but nevertheless treat all
12638 interfaces as local when routing. You can do this by setting
12639 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12640 &"all"& wildcard values. These addresses are recognized as local, but are not
12641 used for listening. Consider this example:
12642 .code
12643 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12644                       192.168.53.235 ; \
12645                       3ffe:2101:12:1:a00:20ff:fe86:a061
12646
12647 extra_local_interfaces = <; ::0 ; 0.0.0.0
12648 .endd
12649 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12650 address, but all available interface addresses are treated as local when
12651 Exim is routing.
12652
12653 In some environments the local host name may be in an MX list, but with an IP
12654 address that is not assigned to any local interface. In other cases it may be
12655 desirable to treat other host names as if they referred to the local host. Both
12656 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12657 This contains host names rather than IP addresses. When a host is referenced
12658 during routing, either via an MX record or directly, it is treated as the local
12659 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12660 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12661
12662
12663
12664 .section "Delivering to a remote host" "SECID95"
12665 Delivery to a remote host is handled by the smtp transport. By default, it
12666 allows the system's TCP/IP functions to choose which interface to use (if
12667 there is more than one) when connecting to a remote host. However, the
12668 &%interface%& option can be set to specify which interface is used. See the
12669 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12670 details.
12671
12672
12673
12674
12675 . ////////////////////////////////////////////////////////////////////////////
12676 . ////////////////////////////////////////////////////////////////////////////
12677
12678 .chapter "Main configuration" "CHAPmainconfig"
12679 .scindex IIDconfima "configuration file" "main section"
12680 .scindex IIDmaiconf "main configuration"
12681 The first part of the run time configuration file contains three types of item:
12682
12683 .ilist
12684 Macro definitions: These lines start with an upper case letter. See section
12685 &<<SECTmacrodefs>>& for details of macro processing.
12686 .next
12687 Named list definitions: These lines start with one of the words &"domainlist"&,
12688 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12689 section &<<SECTnamedlists>>&.
12690 .next
12691 Main configuration settings: Each setting occupies one line of the file
12692 (with possible continuations). If any setting is preceded by the word
12693 &"hide"&, the &%-bP%& command line option displays its value to admin users
12694 only. See section &<<SECTcos>>& for a description of the syntax of these option
12695 settings.
12696 .endlist
12697
12698 This chapter specifies all the main configuration options, along with their
12699 types and default values. For ease of finding a particular option, they appear
12700 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12701 are now so many options, they are first listed briefly in functional groups, as
12702 an aid to finding the name of the option you are looking for. Some options are
12703 listed in more than one group.
12704
12705 .section "Miscellaneous" "SECID96"
12706 .table2
12707 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12708 .row &%disable_ipv6%&                "do no IPv6 processing"
12709 .row &%keep_malformed%&              "for broken files &-- should not happen"
12710 .row &%localhost_number%&            "for unique message ids in clusters"
12711 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12712 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12713 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12714 .row &%print_topbitchars%&           "top-bit characters are printing"
12715 .row &%timezone%&                    "force time zone"
12716 .endtable
12717
12718
12719 .section "Exim parameters" "SECID97"
12720 .table2
12721 .row &%exim_group%&                  "override compiled-in value"
12722 .row &%exim_path%&                   "override compiled-in value"
12723 .row &%exim_user%&                   "override compiled-in value"
12724 .row &%primary_hostname%&            "default from &[uname()]&"
12725 .row &%split_spool_directory%&       "use multiple directories"
12726 .row &%spool_directory%&             "override compiled-in value"
12727 .endtable
12728
12729
12730
12731 .section "Privilege controls" "SECID98"
12732 .table2
12733 .row &%admin_groups%&                "groups that are Exim admin users"
12734 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12735 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12736 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12737 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12738 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12739 .row &%never_users%&                 "do not run deliveries as these"
12740 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12741 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12742 .row &%trusted_groups%&              "groups that are trusted"
12743 .row &%trusted_users%&               "users that are trusted"
12744 .endtable
12745
12746
12747
12748 .section "Logging" "SECID99"
12749 .table2
12750 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12751 .row &%log_file_path%&               "override compiled-in value"
12752 .row &%log_selector%&                "set/unset optional logging"
12753 .row &%log_timezone%&                "add timezone to log lines"
12754 .row &%message_logs%&                "create per-message logs"
12755 .row &%preserve_message_logs%&       "after message completion"
12756 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12757 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12758 .row &%syslog_facility%&             "set syslog &""facility""& field"
12759 .row &%syslog_processname%&          "set syslog &""ident""& field"
12760 .row &%syslog_timestamp%&            "timestamp syslog lines"
12761 .row &%write_rejectlog%&             "control use of message log"
12762 .endtable
12763
12764
12765
12766 .section "Frozen messages" "SECID100"
12767 .table2
12768 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12769 .row &%freeze_tell%&                 "send message when freezing"
12770 .row &%move_frozen_messages%&        "to another directory"
12771 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12772 .endtable
12773
12774
12775
12776 .section "Data lookups" "SECID101"
12777 .table2
12778 .row &%ibase_servers%&               "InterBase servers"
12779 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12780 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12781 .row &%ldap_cert_file%&              "client cert file for LDAP"
12782 .row &%ldap_cert_key%&               "client key file for LDAP"
12783 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12784 .row &%ldap_default_servers%&        "used if no server in query"
12785 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12786 .row &%ldap_start_tls%&              "require TLS within LDAP"
12787 .row &%ldap_version%&                "set protocol version"
12788 .row &%lookup_open_max%&             "lookup files held open"
12789 .row &%mysql_servers%&               "default MySQL servers"
12790 .row &%oracle_servers%&              "Oracle servers"
12791 .row &%pgsql_servers%&               "default PostgreSQL servers"
12792 .row &%sqlite_lock_timeout%&         "as it says"
12793 .endtable
12794
12795
12796
12797 .section "Message ids" "SECID102"
12798 .table2
12799 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12800 .row &%message_id_header_text%&      "ditto"
12801 .endtable
12802
12803
12804
12805 .section "Embedded Perl Startup" "SECID103"
12806 .table2
12807 .row &%perl_at_start%&               "always start the interpreter"
12808 .row &%perl_startup%&                "code to obey when starting Perl"
12809 .endtable
12810
12811
12812
12813 .section "Daemon" "SECID104"
12814 .table2
12815 .row &%daemon_smtp_ports%&           "default ports"
12816 .row &%daemon_startup_retries%&      "number of times to retry"
12817 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12818 .row &%extra_local_interfaces%&      "not necessarily listened on"
12819 .row &%local_interfaces%&            "on which to listen, with optional ports"
12820 .row &%pid_file_path%&               "override compiled-in value"
12821 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12822 .endtable
12823
12824
12825
12826 .section "Resource control" "SECID105"
12827 .table2
12828 .row &%check_log_inodes%&            "before accepting a message"
12829 .row &%check_log_space%&             "before accepting a message"
12830 .row &%check_spool_inodes%&          "before accepting a message"
12831 .row &%check_spool_space%&           "before accepting a message"
12832 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12833 .row &%queue_only_load%&             "queue incoming if load high"
12834 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12835 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12836 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12837 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12838 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12839 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12840 .row &%smtp_accept_max_per_connection%& "messages per connection"
12841 .row &%smtp_accept_max_per_host%&    "connections from one host"
12842 .row &%smtp_accept_queue%&           "queue mail if more connections"
12843 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12844                                            connection"
12845 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12846 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12847 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12848 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12849 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12850 .endtable
12851
12852
12853
12854 .section "Policy controls" "SECID106"
12855 .table2
12856 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12857 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12858 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12859 .row &%acl_smtp_auth%&               "ACL for AUTH"
12860 .row &%acl_smtp_connect%&            "ACL for connection"
12861 .row &%acl_smtp_data%&               "ACL for DATA"
12862 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12863 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12864 .row &%acl_smtp_expn%&               "ACL for EXPN"
12865 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12866 .row &%acl_smtp_mail%&               "ACL for MAIL"
12867 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12868 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12869 .row &%acl_smtp_predata%&            "ACL for start of data"
12870 .row &%acl_smtp_quit%&               "ACL for QUIT"
12871 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12872 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12873 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12874 .row &%av_scanner%&                  "specify virus scanner"
12875 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12876                                       words""&"
12877 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12878 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12879 .row &%header_maxsize%&              "total size of message header"
12880 .row &%header_line_maxsize%&         "individual header line limit"
12881 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12882 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12883 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12884 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12885 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12886 .row &%host_lookup%&                 "host name looked up for these hosts"
12887 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12888 .row &%host_reject_connection%&      "reject connection from these hosts"
12889 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12890 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12891 .row &%message_size_limit%&          "for all messages"
12892 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12893 .row &%spamd_address%&               "set interface to SpamAssassin"
12894 .row &%strict_acl_vars%&             "object to unset ACL variables"
12895 .endtable
12896
12897
12898
12899 .section "Callout cache" "SECID107"
12900 .table2
12901 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12902                                          item"
12903 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12904                                          item"
12905 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12906 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12907 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12908 .endtable
12909
12910
12911
12912 .section "TLS" "SECID108"
12913 .table2
12914 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12915 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
12916 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12917 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12918 .row &%tls_certificate%&             "location of server certificate"
12919 .row &%tls_crl%&                     "certificate revocation list"
12920 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12921 .row &%tls_dhparam%&                 "DH parameters for server"
12922 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12923 .row &%tls_privatekey%&              "location of server private key"
12924 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12925 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12926 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12927 .row &%tls_verify_certificates%&     "expected client certificates"
12928 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12929 .endtable
12930
12931
12932
12933 .section "Local user handling" "SECID109"
12934 .table2
12935 .row &%finduser_retries%&            "useful in NIS environments"
12936 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12937 .row &%gecos_pattern%&               "ditto"
12938 .row &%max_username_length%&         "for systems that truncate"
12939 .row &%unknown_login%&               "used when no login name found"
12940 .row &%unknown_username%&            "ditto"
12941 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12942 .row &%uucp_from_sender%&            "ditto"
12943 .endtable
12944
12945
12946
12947 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12948 .table2
12949 .row &%header_maxsize%&              "total size of message header"
12950 .row &%header_line_maxsize%&         "individual header line limit"
12951 .row &%message_size_limit%&          "applies to all messages"
12952 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12953 .row &%received_header_text%&        "expanded to make &'Received:'&"
12954 .row &%received_headers_max%&        "for mail loop detection"
12955 .row &%recipients_max%&              "limit per message"
12956 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12957 .endtable
12958
12959
12960
12961
12962 .section "Non-SMTP incoming messages" "SECID111"
12963 .table2
12964 .row &%receive_timeout%&             "for non-SMTP messages"
12965 .endtable
12966
12967
12968
12969
12970
12971 .section "Incoming SMTP messages" "SECID112"
12972 See also the &'Policy controls'& section above.
12973
12974 .table2
12975 .row &%host_lookup%&                 "host name looked up for these hosts"
12976 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12977 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12978 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12979 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12980 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12981 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12982 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12983 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12984 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12985 .row &%smtp_accept_max_per_connection%& "messages per connection"
12986 .row &%smtp_accept_max_per_host%&    "connections from one host"
12987 .row &%smtp_accept_queue%&           "queue mail if more connections"
12988 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12989                                            connection"
12990 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12991 .row &%smtp_active_hostname%&        "host name to use in messages"
12992 .row &%smtp_banner%&                 "text for welcome banner"
12993 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12994 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12995 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12996 .row &%smtp_etrn_command%&           "what to run for ETRN"
12997 .row &%smtp_etrn_serialize%&         "only one at once"
12998 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12999 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13000 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13001 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13002 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13003 .row &%smtp_receive_timeout%&        "per command or data line"
13004 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13005 .row &%smtp_return_error_details%&   "give detail on rejections"
13006 .endtable
13007
13008
13009
13010 .section "SMTP extensions" "SECID113"
13011 .table2
13012 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13013 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13014 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13015 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13016 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13017 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13018 .endtable
13019
13020
13021
13022 .section "Processing messages" "SECID114"
13023 .table2
13024 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13025 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13026 .row &%allow_utf8_domains%&          "in addresses"
13027 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13028                                       words""&"
13029 .row &%delivery_date_remove%&        "from incoming messages"
13030 .row &%envelope_to_remove%&          "from incoming messages"
13031 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13032 .row &%headers_charset%&             "default for translations"
13033 .row &%qualify_domain%&              "default for senders"
13034 .row &%qualify_recipient%&           "default for recipients"
13035 .row &%return_path_remove%&          "from incoming messages"
13036 .row &%strip_excess_angle_brackets%& "in addresses"
13037 .row &%strip_trailing_dot%&          "at end of addresses"
13038 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13039 .endtable
13040
13041
13042
13043 .section "System filter" "SECID115"
13044 .table2
13045 .row &%system_filter%&               "locate system filter"
13046 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13047                                             directory"
13048 .row &%system_filter_file_transport%& "transport for delivery to a file"
13049 .row &%system_filter_group%&         "group for filter running"
13050 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13051 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13052 .row &%system_filter_user%&          "user for filter running"
13053 .endtable
13054
13055
13056
13057 .section "Routing and delivery" "SECID116"
13058 .table2
13059 .row &%disable_ipv6%&                "do no IPv6 processing"
13060 .row &%dns_again_means_nonexist%&    "for broken domains"
13061 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13062 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13063 .row &%dns_retrans%&                 "parameter for resolver"
13064 .row &%dns_retry%&                   "parameter for resolver"
13065 .row &%dns_use_dnssec%&              "parameter for resolver"
13066 .row &%dns_use_edns0%&               "parameter for resolver"
13067 .row &%hold_domains%&                "hold delivery for these domains"
13068 .row &%local_interfaces%&            "for routing checks"
13069 .row &%queue_domains%&               "no immediate delivery for these"
13070 .row &%queue_only%&                  "no immediate delivery at all"
13071 .row &%queue_only_file%&             "no immediate delivery if file exists"
13072 .row &%queue_only_load%&             "no immediate delivery if load is high"
13073 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13074 .row &%queue_only_override%&         "allow command line to override"
13075 .row &%queue_run_in_order%&          "order of arrival"
13076 .row &%queue_run_max%&               "of simultaneous queue runners"
13077 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13078 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13079 .row &%remote_sort_domains%&         "order of remote deliveries"
13080 .row &%retry_data_expire%&           "timeout for retry data"
13081 .row &%retry_interval_max%&          "safety net for retry rules"
13082 .endtable
13083
13084
13085
13086 .section "Bounce and warning messages" "SECID117"
13087 .table2
13088 .row &%bounce_message_file%&         "content of bounce"
13089 .row &%bounce_message_text%&         "content of bounce"
13090 .row &%bounce_return_body%&          "include body if returning message"
13091 .row &%bounce_return_message%&       "include original message in bounce"
13092 .row &%bounce_return_size_limit%&    "limit on returned message"
13093 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13094 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13095 .row &%errors_copy%&                 "copy bounce messages"
13096 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13097 .row &%delay_warning%&               "time schedule"
13098 .row &%delay_warning_condition%&     "condition for warning messages"
13099 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13100 .row &%smtp_return_error_details%&   "give detail on rejections"
13101 .row &%warn_message_file%&           "content of warning message"
13102 .endtable
13103
13104
13105
13106 .section "Alphabetical list of main options" "SECTalomo"
13107 Those options that undergo string expansion before use are marked with
13108 &dagger;.
13109
13110 .option accept_8bitmime main boolean true
13111 .cindex "8BITMIME"
13112 .cindex "8-bit characters"
13113 .cindex "log" "selectors"
13114 .cindex "log" "8BITMIME"
13115 This option causes Exim to send 8BITMIME in its response to an SMTP
13116 EHLO command, and to accept the BODY= parameter on MAIL commands.
13117 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13118 takes no steps to do anything special with messages received by this route.
13119
13120 Historically Exim kept this option off by default, but the maintainers
13121 feel that in today's Internet, this causes more problems than it solves.
13122 It now defaults to true.
13123 A more detailed analysis of the issues is provided by Dan Bernstein:
13124 .display
13125 &url(http://cr.yp.to/smtp/8bitmime.html)
13126 .endd
13127
13128 To log received 8BITMIME status use
13129 .code
13130 log_selector = +8bitmime
13131 .endd
13132
13133 .option acl_not_smtp main string&!! unset
13134 .cindex "&ACL;" "for non-SMTP messages"
13135 .cindex "non-SMTP messages" "ACLs for"
13136 This option defines the ACL that is run when a non-SMTP message has been
13137 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13138 further details.
13139
13140 .option acl_not_smtp_mime main string&!! unset
13141 This option defines the ACL that is run for individual MIME parts of non-SMTP
13142 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13143 SMTP messages.
13144
13145 .option acl_not_smtp_start main string&!! unset
13146 .cindex "&ACL;" "at start of non-SMTP message"
13147 .cindex "non-SMTP messages" "ACLs for"
13148 This option defines the ACL that is run before Exim starts reading a
13149 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13150
13151 .option acl_smtp_auth main string&!! unset
13152 .cindex "&ACL;" "setting up for SMTP commands"
13153 .cindex "AUTH" "ACL for"
13154 This option defines the ACL that is run when an SMTP AUTH command is
13155 received. See chapter &<<CHAPACL>>& for further details.
13156
13157 .option acl_smtp_connect main string&!! unset
13158 .cindex "&ACL;" "on SMTP connection"
13159 This option defines the ACL that is run when an SMTP connection is received.
13160 See chapter &<<CHAPACL>>& for further details.
13161
13162 .option acl_smtp_data main string&!! unset
13163 .cindex "DATA" "ACL for"
13164 This option defines the ACL that is run after an SMTP DATA command has been
13165 processed and the message itself has been received, but before the final
13166 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13167
13168 .option acl_smtp_etrn main string&!! unset
13169 .cindex "ETRN" "ACL for"
13170 This option defines the ACL that is run when an SMTP ETRN command is
13171 received. See chapter &<<CHAPACL>>& for further details.
13172
13173 .option acl_smtp_expn main string&!! unset
13174 .cindex "EXPN" "ACL for"
13175 This option defines the ACL that is run when an SMTP EXPN command is
13176 received. See chapter &<<CHAPACL>>& for further details.
13177
13178 .option acl_smtp_helo main string&!! unset
13179 .cindex "EHLO" "ACL for"
13180 .cindex "HELO" "ACL for"
13181 This option defines the ACL that is run when an SMTP EHLO or HELO
13182 command is received. See chapter &<<CHAPACL>>& for further details.
13183
13184
13185 .option acl_smtp_mail main string&!! unset
13186 .cindex "MAIL" "ACL for"
13187 This option defines the ACL that is run when an SMTP MAIL command is
13188 received. See chapter &<<CHAPACL>>& for further details.
13189
13190 .option acl_smtp_mailauth main string&!! unset
13191 .cindex "AUTH" "on MAIL command"
13192 This option defines the ACL that is run when there is an AUTH parameter on
13193 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13194 &<<CHAPSMTPAUTH>>& for details of authentication.
13195
13196 .option acl_smtp_mime main string&!! unset
13197 .cindex "MIME content scanning" "ACL for"
13198 This option is available when Exim is built with the content-scanning
13199 extension. It defines the ACL that is run for each MIME part in a message. See
13200 section &<<SECTscanmimepart>>& for details.
13201
13202 .option acl_smtp_predata main string&!! unset
13203 This option defines the ACL that is run when an SMTP DATA command is
13204 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13205 further details.
13206
13207 .option acl_smtp_quit main string&!! unset
13208 .cindex "QUIT, ACL for"
13209 This option defines the ACL that is run when an SMTP QUIT command is
13210 received. See chapter &<<CHAPACL>>& for further details.
13211
13212 .option acl_smtp_rcpt main string&!! unset
13213 .cindex "RCPT" "ACL for"
13214 This option defines the ACL that is run when an SMTP RCPT command is
13215 received. See chapter &<<CHAPACL>>& for further details.
13216
13217 .option acl_smtp_starttls main string&!! unset
13218 .cindex "STARTTLS, ACL for"
13219 This option defines the ACL that is run when an SMTP STARTTLS command is
13220 received. See chapter &<<CHAPACL>>& for further details.
13221
13222 .option acl_smtp_vrfy main string&!! unset
13223 .cindex "VRFY" "ACL for"
13224 This option defines the ACL that is run when an SMTP VRFY command is
13225 received. See chapter &<<CHAPACL>>& for further details.
13226
13227 .option admin_groups main "string list&!!" unset
13228 .cindex "admin user"
13229 This option is expanded just once, at the start of Exim's processing. If the
13230 current group or any of the supplementary groups of an Exim caller is in this
13231 colon-separated list, the caller has admin privileges. If all your system
13232 programmers are in a specific group, for example, you can give them all Exim
13233 admin privileges by putting that group in &%admin_groups%&. However, this does
13234 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13235 To permit this, you have to add individuals to the Exim group.
13236
13237 .option allow_domain_literals main boolean false
13238 .cindex "domain literal"
13239 If this option is set, the RFC 2822 domain literal format is permitted in
13240 email addresses. The option is not set by default, because the domain literal
13241 format is not normally required these days, and few people know about it. It
13242 has, however, been exploited by mail abusers.
13243
13244 Unfortunately, it seems that some DNS black list maintainers are using this
13245 format to report black listing to postmasters. If you want to accept messages
13246 addressed to your hosts by IP address, you need to set
13247 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13248 domains (defined in the named domain list &%local_domains%& in the default
13249 configuration). This &"magic string"& matches the domain literal form of all
13250 the local host's IP addresses.
13251
13252
13253 .option allow_mx_to_ip main boolean false
13254 .cindex "MX record" "pointing to IP address"
13255 It appears that more and more DNS zone administrators are breaking the rules
13256 and putting domain names that look like IP addresses on the right hand side of
13257 MX records. Exim follows the rules and rejects this, giving an error message
13258 that explains the mis-configuration. However, some other MTAs support this
13259 practice, so to avoid &"Why can't Exim do this?"& complaints,
13260 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13261 recommended, except when you have no other choice.
13262
13263 .option allow_utf8_domains main boolean false
13264 .cindex "domain" "UTF-8 characters in"
13265 .cindex "UTF-8" "in domain name"
13266 Lots of discussion is going on about internationalized domain names. One
13267 camp is strongly in favour of just using UTF-8 characters, and it seems
13268 that at least two other MTAs permit this. This option allows Exim users to
13269 experiment if they wish.
13270
13271 If it is set true, Exim's domain parsing function allows valid
13272 UTF-8 multicharacters to appear in domain name components, in addition to
13273 letters, digits, and hyphens. However, just setting this option is not
13274 enough; if you want to look up these domain names in the DNS, you must also
13275 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13276 suitable setting is:
13277 .code
13278 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13279   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13280 .endd
13281 Alternatively, you can just disable this feature by setting
13282 .code
13283 dns_check_names_pattern =
13284 .endd
13285 That is, set the option to an empty string so that no check is done.
13286
13287
13288 .option auth_advertise_hosts main "host list&!!" *
13289 .cindex "authentication" "advertising"
13290 .cindex "AUTH" "advertising"
13291 If any server authentication mechanisms are configured, Exim advertises them in
13292 response to an EHLO command only if the calling host matches this list.
13293 Otherwise, Exim does not advertise AUTH.
13294 Exim does not accept AUTH commands from clients to which it has not
13295 advertised the availability of AUTH. The advertising of individual
13296 authentication mechanisms can be controlled by the use of the
13297 &%server_advertise_condition%& generic authenticator option on the individual
13298 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13299
13300 Certain mail clients (for example, Netscape) require the user to provide a name
13301 and password for authentication if AUTH is advertised, even though it may
13302 not be needed (the host may accept messages from hosts on its local LAN without
13303 authentication, for example). The &%auth_advertise_hosts%& option can be used
13304 to make these clients more friendly by excluding them from the set of hosts to
13305 which Exim advertises AUTH.
13306
13307 .cindex "AUTH" "advertising when encrypted"
13308 If you want to advertise the availability of AUTH only when the connection
13309 is encrypted using TLS, you can make use of the fact that the value of this
13310 option is expanded, with a setting like this:
13311 .code
13312 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13313 .endd
13314 .vindex "&$tls_in_cipher$&"
13315 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13316 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13317 expansion is *, which matches all hosts.
13318
13319
13320 .option auto_thaw main time 0s
13321 .cindex "thawing messages"
13322 .cindex "unfreezing messages"
13323 If this option is set to a time greater than zero, a queue runner will try a
13324 new delivery attempt on any frozen message, other than a bounce message, if
13325 this much time has passed since it was frozen. This may result in the message
13326 being re-frozen if nothing has changed since the last attempt. It is a way of
13327 saying &"keep on trying, even though there are big problems"&.
13328
13329 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13330 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13331 thought to be very useful any more, and its use should probably be avoided.
13332
13333
13334 .option av_scanner main string "see below"
13335 This option is available if Exim is built with the content-scanning extension.
13336 It specifies which anti-virus scanner to use. The default value is:
13337 .code
13338 sophie:/var/run/sophie
13339 .endd
13340 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13341 before use. See section &<<SECTscanvirus>>& for further details.
13342
13343
13344 .option bi_command main string unset
13345 .oindex "&%-bi%&"
13346 This option supplies the name of a command that is run when Exim is called with
13347 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13348 just the command name, it is not a complete command line. If an argument is
13349 required, it must come from the &%-oA%& command line option.
13350
13351
13352 .option bounce_message_file main string unset
13353 .cindex "bounce message" "customizing"
13354 .cindex "customizing" "bounce message"
13355 This option defines a template file containing paragraphs of text to be used
13356 for constructing bounce messages.  Details of the file's contents are given in
13357 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13358
13359
13360 .option bounce_message_text main string unset
13361 When this option is set, its contents are included in the default bounce
13362 message immediately after &"This message was created automatically by mail
13363 delivery software."& It is not used if &%bounce_message_file%& is set.
13364
13365 .option bounce_return_body main boolean true
13366 .cindex "bounce message" "including body"
13367 This option controls whether the body of an incoming message is included in a
13368 bounce message when &%bounce_return_message%& is true. The default setting
13369 causes the entire message, both header and body, to be returned (subject to the
13370 value of &%bounce_return_size_limit%&). If this option is false, only the
13371 message header is included. In the case of a non-SMTP message containing an
13372 error that is detected during reception, only those header lines preceding the
13373 point at which the error was detected are returned.
13374 .cindex "bounce message" "including original"
13375
13376 .option bounce_return_message main boolean true
13377 If this option is set false, none of the original message is included in
13378 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13379 &%bounce_return_body%&.
13380
13381
13382 .option bounce_return_size_limit main integer 100K
13383 .cindex "size" "of bounce, limit"
13384 .cindex "bounce message" "size limit"
13385 .cindex "limit" "bounce message size"
13386 This option sets a limit in bytes on the size of messages that are returned to
13387 senders as part of bounce messages when &%bounce_return_message%& is true. The
13388 limit should be less than the value of the global &%message_size_limit%& and of
13389 any &%message_size_limit%& settings on transports, to allow for the bounce text
13390 that Exim generates. If this option is set to zero there is no limit.
13391
13392 When the body of any message that is to be included in a bounce message is
13393 greater than the limit, it is truncated, and a comment pointing this out is
13394 added at the top. The actual cutoff may be greater than the value given, owing
13395 to the use of buffering for transferring the message in chunks (typically 8K in
13396 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13397 messages.
13398
13399 .option bounce_sender_authentication main string unset
13400 .cindex "bounce message" "sender authentication"
13401 .cindex "authentication" "bounce message"
13402 .cindex "AUTH" "on bounce message"
13403 This option provides an authenticated sender address that is sent with any
13404 bounce messages generated by Exim that are sent over an authenticated SMTP
13405 connection. A typical setting might be:
13406 .code
13407 bounce_sender_authentication = mailer-daemon@my.domain.example
13408 .endd
13409 which would cause bounce messages to be sent using the SMTP command:
13410 .code
13411 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13412 .endd
13413 The value of &%bounce_sender_authentication%& must always be a complete email
13414 address.
13415
13416 .option callout_domain_negative_expire main time 3h
13417 .cindex "caching" "callout timeouts"
13418 .cindex "callout" "caching timeouts"
13419 This option specifies the expiry time for negative callout cache data for a
13420 domain. See section &<<SECTcallver>>& for details of callout verification, and
13421 section &<<SECTcallvercache>>& for details of the caching.
13422
13423
13424 .option callout_domain_positive_expire main time 7d
13425 This option specifies the expiry time for positive callout cache data for a
13426 domain. See section &<<SECTcallver>>& for details of callout verification, and
13427 section &<<SECTcallvercache>>& for details of the caching.
13428
13429
13430 .option callout_negative_expire main time 2h
13431 This option specifies the expiry time for negative callout cache data for an
13432 address. See section &<<SECTcallver>>& for details of callout verification, and
13433 section &<<SECTcallvercache>>& for details of the caching.
13434
13435
13436 .option callout_positive_expire main time 24h
13437 This option specifies the expiry time for positive callout cache data for an
13438 address. See section &<<SECTcallver>>& for details of callout verification, and
13439 section &<<SECTcallvercache>>& for details of the caching.
13440
13441
13442 .option callout_random_local_part main string&!! "see below"
13443 This option defines the &"random"& local part that can be used as part of
13444 callout verification. The default value is
13445 .code
13446 $primary_hostname-$tod_epoch-testing
13447 .endd
13448 See section &<<CALLaddparcall>>& for details of how this value is used.
13449
13450
13451 .option check_log_inodes main integer 0
13452 See &%check_spool_space%& below.
13453
13454
13455 .option check_log_space main integer 0
13456 See &%check_spool_space%& below.
13457
13458 .oindex "&%check_rfc2047_length%&"
13459 .cindex "RFC 2047" "disabling length check"
13460 .option check_rfc2047_length main boolean true
13461 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13462 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13463 word; strings to be encoded that exceed this length are supposed to use
13464 multiple encoded words. By default, Exim does not recognize encoded words that
13465 exceed the maximum length. However, it seems that some software, in violation
13466 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13467 set false, Exim recognizes encoded words of any length.
13468
13469
13470 .option check_spool_inodes main integer 0
13471 See &%check_spool_space%& below.
13472
13473
13474 .option check_spool_space main integer 0
13475 .cindex "checking disk space"
13476 .cindex "disk space, checking"
13477 .cindex "spool directory" "checking space"
13478 The four &%check_...%& options allow for checking of disk resources before a
13479 message is accepted.
13480
13481 .vindex "&$log_inodes$&"
13482 .vindex "&$log_space$&"
13483 .vindex "&$spool_inodes$&"
13484 .vindex "&$spool_space$&"
13485 When any of these options are set, they apply to all incoming messages. If you
13486 want to apply different checks to different kinds of message, you can do so by
13487 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13488 &$spool_space$& in an ACL with appropriate additional conditions.
13489
13490
13491 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13492 either value is greater than zero, for example:
13493 .code
13494 check_spool_space = 10M
13495 check_spool_inodes = 100
13496 .endd
13497 The spool partition is the one that contains the directory defined by
13498 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13499 transit.
13500
13501 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13502 files are written if either is greater than zero. These should be set only if
13503 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13504
13505 If there is less space or fewer inodes than requested, Exim refuses to accept
13506 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13507 error response to the MAIL command. If ESMTP is in use and there was a
13508 SIZE parameter on the MAIL command, its value is added to the
13509 &%check_spool_space%& value, and the check is performed even if
13510 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13511
13512 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13513 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13514
13515 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13516 failure a message is written to stderr and Exim exits with a non-zero code, as
13517 it obviously cannot send an error message of any kind.
13518
13519 .option daemon_smtp_ports main string &`smtp`&
13520 .cindex "port" "for daemon"
13521 .cindex "TCP/IP" "setting listening ports"
13522 This option specifies one or more default SMTP ports on which the Exim daemon
13523 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13524 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13525
13526 .option daemon_startup_retries main integer 9
13527 .cindex "daemon startup, retrying"
13528 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13529 the daemon at startup when it cannot immediately bind a listening socket
13530 (typically because the socket is already in use): &%daemon_startup_retries%&
13531 defines the number of retries after the first failure, and
13532 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13533
13534 .option daemon_startup_sleep main time 30s
13535 See &%daemon_startup_retries%&.
13536
13537 .option delay_warning main "time list" 24h
13538 .cindex "warning of delay"
13539 .cindex "delay warning, specifying"
13540 When a message is delayed, Exim sends a warning message to the sender at
13541 intervals specified by this option. The data is a colon-separated list of times
13542 after which to send warning messages. If the value of the option is an empty
13543 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13544 message has been on the queue for longer than the last time, the last interval
13545 between the times is used to compute subsequent warning times. For example,
13546 with
13547 .code
13548 delay_warning = 4h:8h:24h
13549 .endd
13550 the first message is sent after 4 hours, the second after 8 hours, and
13551 the third one after 24 hours. After that, messages are sent every 16 hours,
13552 because that is the interval between the last two times on the list. If you set
13553 just one time, it specifies the repeat interval. For example, with:
13554 .code
13555 delay_warning = 6h
13556 .endd
13557 messages are repeated every six hours. To stop warnings after a given time, set
13558 a very large time at the end of the list. For example:
13559 .code
13560 delay_warning = 2h:12h:99d
13561 .endd
13562
13563 .option delay_warning_condition main string&!! "see below"
13564 .vindex "&$domain$&"
13565 The string is expanded at the time a warning message might be sent. If all the
13566 deferred addresses have the same domain, it is set in &$domain$& during the
13567 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13568 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13569 &"false"& (the comparison being done caselessly) then the warning message is
13570 not sent. The default is:
13571 .code
13572 delay_warning_condition = ${if or {\
13573   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13574   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13575   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13576   } {no}{yes}}
13577 .endd
13578 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13579 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13580 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13581 &"auto-replied"& in an &'Auto-Submitted:'& header.
13582
13583 .option deliver_drop_privilege main boolean false
13584 .cindex "unprivileged delivery"
13585 .cindex "delivery" "unprivileged"
13586 If this option is set true, Exim drops its root privilege at the start of a
13587 delivery process, and runs as the Exim user throughout. This severely restricts
13588 the kinds of local delivery that are possible, but is viable in certain types
13589 of configuration. There is a discussion about the use of root privilege in
13590 chapter &<<CHAPsecurity>>&.
13591
13592 .option deliver_queue_load_max main fixed-point unset
13593 .cindex "load average"
13594 .cindex "queue runner" "abandoning"
13595 When this option is set, a queue run is abandoned if the system load average
13596 becomes greater than the value of the option. The option has no effect on
13597 ancient operating systems on which Exim cannot determine the load average.
13598 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13599
13600
13601 .option delivery_date_remove main boolean true
13602 .cindex "&'Delivery-date:'& header line"
13603 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13604 message when it is delivered, in exactly the same way as &'Return-path:'& is
13605 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13606 should not be present in incoming messages, and this option causes them to be
13607 removed at the time the message is received, to avoid any problems that might
13608 occur when a delivered message is subsequently sent on to some other recipient.
13609
13610 .option disable_fsync main boolean false
13611 .cindex "&[fsync()]&, disabling"
13612 This option is available only if Exim was built with the compile-time option
13613 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13614 a runtime configuration generates an &"unknown option"& error. You should not
13615 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13616 really, really, really understand what you are doing. &'No pre-compiled
13617 distributions of Exim should ever make this option available.'&
13618
13619 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13620 updated files' data to be written to disc before continuing. Unexpected events
13621 such as crashes and power outages may cause data to be lost or scrambled.
13622 Here be Dragons. &*Beware.*&
13623
13624
13625 .option disable_ipv6 main boolean false
13626 .cindex "IPv6" "disabling"
13627 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13628 activities take place. AAAA records are never looked up, and any IPv6 addresses
13629 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13630 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13631 to handle IPv6 literal addresses.
13632
13633
13634 .option dns_again_means_nonexist main "domain list&!!" unset
13635 .cindex "DNS" "&""try again""& response; overriding"
13636 DNS lookups give a &"try again"& response for the DNS errors
13637 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13638 keep trying to deliver a message, or to give repeated temporary errors to
13639 incoming mail. Sometimes the effect is caused by a badly set up name server and
13640 may persist for a long time. If a domain which exhibits this problem matches
13641 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13642 This option should be used with care. You can make it apply to reverse lookups
13643 by a setting such as this:
13644 .code
13645 dns_again_means_nonexist = *.in-addr.arpa
13646 .endd
13647 This option applies to all DNS lookups that Exim does. It also applies when the
13648 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13649 since these are most likely to be caused by DNS lookup problems. The
13650 &(dnslookup)& router has some options of its own for controlling what happens
13651 when lookups for MX or SRV records give temporary errors. These more specific
13652 options are applied after this global option.
13653
13654 .option dns_check_names_pattern main string "see below"
13655 .cindex "DNS" "pre-check of name syntax"
13656 When this option is set to a non-empty string, it causes Exim to check domain
13657 names for characters that are not allowed in host names before handing them to
13658 the DNS resolver, because some resolvers give temporary errors for names that
13659 contain unusual characters. If a domain name contains any unwanted characters,
13660 a &"not found"& result is forced, and the resolver is not called. The check is
13661 done by matching the domain name against a regular expression, which is the
13662 value of this option. The default pattern is
13663 .code
13664 dns_check_names_pattern = \
13665   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13666 .endd
13667 which permits only letters, digits, slashes, and hyphens in components, but
13668 they must start and end with a letter or digit. Slashes are not, in fact,
13669 permitted in host names, but they are found in certain NS records (which can be
13670 accessed in Exim by using a &%dnsdb%& lookup). If you set
13671 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13672 empty string.
13673
13674 .option dns_csa_search_limit main integer 5
13675 This option controls the depth of parental searching for CSA SRV records in the
13676 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13677
13678 .option dns_csa_use_reverse main boolean true
13679 This option controls whether or not an IP address, given as a CSA domain, is
13680 reversed and looked up in the reverse DNS, as described in more detail in
13681 section &<<SECTverifyCSA>>&.
13682
13683 .option dns_ipv4_lookup main "domain list&!!" unset
13684 .cindex "IPv6" "DNS lookup for AAAA records"
13685 .cindex "DNS" "IPv6 lookup for AAAA records"
13686 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13687 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13688 (A records) when trying to find IP addresses for hosts, unless the host's
13689 domain matches this list.
13690
13691 This is a fudge to help with name servers that give big delays or otherwise do
13692 not work for the AAAA record type. In due course, when the world's name
13693 servers have all been upgraded, there should be no need for this option.
13694
13695
13696 .option dns_retrans main time 0s
13697 .cindex "DNS" "resolver options"
13698 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13699 retransmission and retry parameters for DNS lookups. Values of zero (the
13700 defaults) leave the system default settings unchanged. The first value is the
13701 time between retries, and the second is the number of retries. It isn't
13702 totally clear exactly how these settings affect the total time a DNS lookup may
13703 take. I haven't found any documentation about timeouts on DNS lookups; these
13704 parameter values are available in the external resolver interface structure,
13705 but nowhere does it seem to describe how they are used or what you might want
13706 to set in them.
13707
13708
13709 .option dns_retry main integer 0
13710 See &%dns_retrans%& above.
13711
13712
13713 .new
13714 .option dns_use_dnssec main integer -1
13715 .cindex "DNS" "resolver options"
13716 .cindex "DNS" "DNSSEC"
13717 If this option is set to a non-negative number then Exim will initialise the
13718 DNS resolver library to either use or not use DNSSEC, overriding the system
13719 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13720
13721 If the resolver library does not support DNSSEC then this option has no effect.
13722 .wen
13723
13724
13725 .option dns_use_edns0 main integer -1
13726 .cindex "DNS" "resolver options"
13727 .cindex "DNS" "EDNS0"
13728 If this option is set to a non-negative number then Exim will initialise the
13729 DNS resolver library to either use or not use EDNS0 extensions, overriding
13730 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13731 on.
13732
13733 If the resolver library does not support EDNS0 then this option has no effect.
13734
13735
13736 .option drop_cr main boolean false
13737 This is an obsolete option that is now a no-op. It used to affect the way Exim
13738 handled CR and LF characters in incoming messages. What happens now is
13739 described in section &<<SECTlineendings>>&.
13740
13741 .option dsn_from main "string&!!" "see below"
13742 .cindex "&'From:'& header line" "in bounces"
13743 .cindex "bounce messages" "&'From:'& line, specifying"
13744 This option can be used to vary the contents of &'From:'& header lines in
13745 bounces and other automatically generated messages (&"Delivery Status
13746 Notifications"& &-- hence the name of the option). The default setting is:
13747 .code
13748 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13749 .endd
13750 The value is expanded every time it is needed. If the expansion fails, a
13751 panic is logged, and the default value is used.
13752
13753 .option envelope_to_remove main boolean true
13754 .cindex "&'Envelope-to:'& header line"
13755 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13756 message when it is delivered, in exactly the same way as &'Return-path:'& is
13757 handled. &'Envelope-to:'& records the original recipient address from the
13758 messages's envelope that caused the delivery to happen. Such headers should not
13759 be present in incoming messages, and this option causes them to be removed at
13760 the time the message is received, to avoid any problems that might occur when a
13761 delivered message is subsequently sent on to some other recipient.
13762
13763
13764 .option errors_copy main "string list&!!" unset
13765 .cindex "bounce message" "copy to other address"
13766 .cindex "copy of bounce message"
13767 Setting this option causes Exim to send bcc copies of bounce messages that it
13768 generates to other addresses. &*Note*&: This does not apply to bounce messages
13769 coming from elsewhere. The value of the option is a colon-separated list of
13770 items. Each item consists of a pattern, terminated by white space, followed by
13771 a comma-separated list of email addresses. If a pattern contains spaces, it
13772 must be enclosed in double quotes.
13773
13774 Each pattern is processed in the same way as a single item in an address list
13775 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13776 the bounce message, the message is copied to the addresses on the list. The
13777 items are scanned in order, and once a matching one is found, no further items
13778 are examined. For example:
13779 .code
13780 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13781               rqps@mydomain   hostmaster@mydomain.example,\
13782                               postmaster@mydomain.example
13783 .endd
13784 .vindex "&$domain$&"
13785 .vindex "&$local_part$&"
13786 The address list is expanded before use. The expansion variables &$local_part$&
13787 and &$domain$& are set from the original recipient of the error message, and if
13788 there was any wildcard matching in the pattern, the expansion
13789 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13790 variables &$0$&, &$1$&, etc. are set in the normal way.
13791
13792
13793 .option errors_reply_to main string unset
13794 .cindex "bounce message" "&'Reply-to:'& in"
13795 By default, Exim's bounce and delivery warning messages contain the header line
13796 .display
13797 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13798 .endd
13799 .oindex &%quota_warn_message%&
13800 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13801 A warning message that is generated by the &%quota_warn_message%& option in an
13802 &(appendfile)& transport may contain its own &'From:'& header line that
13803 overrides the default.
13804
13805 Experience shows that people reply to bounce messages. If the
13806 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13807 and warning messages. For example:
13808 .code
13809 errors_reply_to = postmaster@my.domain.example
13810 .endd
13811 The value of the option is not expanded. It must specify a valid RFC 2822
13812 address. However, if a warning message that is generated by the
13813 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13814 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13815 not used.
13816
13817
13818 .option exim_group main string "compile-time configured"
13819 .cindex "gid (group id)" "Exim's own"
13820 .cindex "Exim group"
13821 This option changes the gid under which Exim runs when it gives up root
13822 privilege. The default value is compiled into the binary. The value of this
13823 option is used only when &%exim_user%& is also set. Unless it consists entirely
13824 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13825 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13826 security issues.
13827
13828
13829 .option exim_path main string "see below"
13830 .cindex "Exim binary, path name"
13831 This option specifies the path name of the Exim binary, which is used when Exim
13832 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13833 the directory configured at compile time by the BIN_DIRECTORY setting. It
13834 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13835 other place.
13836 &*Warning*&: Do not use a macro to define the value of this option, because
13837 you will break those Exim utilities that scan the configuration file to find
13838 where the binary is. (They then use the &%-bP%& option to extract option
13839 settings such as the value of &%spool_directory%&.)
13840
13841
13842 .option exim_user main string "compile-time configured"
13843 .cindex "uid (user id)" "Exim's own"
13844 .cindex "Exim user"
13845 This option changes the uid under which Exim runs when it gives up root
13846 privilege. The default value is compiled into the binary. Ownership of the run
13847 time configuration file and the use of the &%-C%& and &%-D%& command line
13848 options is checked against the values in the binary, not what is set here.
13849
13850 Unless it consists entirely of digits, the string is looked up using
13851 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13852 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13853 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13854
13855
13856 .option extra_local_interfaces main "string list" unset
13857 This option defines network interfaces that are to be considered local when
13858 routing, but which are not used for listening by the daemon. See section
13859 &<<SECTreclocipadd>>& for details.
13860
13861
13862 . Allow this long option name to split; give it unsplit as a fifth argument
13863 . for the automatic .oindex that is generated by .option.
13864
13865 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13866          extract_addresses_remove_arguments
13867 .oindex "&%-t%&"
13868 .cindex "command line" "addresses with &%-t%&"
13869 .cindex "Sendmail compatibility" "&%-t%& option"
13870 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13871 are present on the command line when the &%-t%& option is used to build an
13872 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13873 line addresses are removed from the recipients list. This is also how Smail
13874 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13875 command line addresses are added to those obtained from the header lines. When
13876 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13877 argument headers. If it is set false, Exim adds rather than removes argument
13878 addresses.
13879
13880
13881 .option finduser_retries main integer 0
13882 .cindex "NIS, retrying user lookups"
13883 On systems running NIS or other schemes in which user and group information is
13884 distributed from a remote system, there can be times when &[getpwnam()]& and
13885 related functions fail, even when given valid data, because things time out.
13886 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13887 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13888 many extra times to find a user or a group, waiting for one second between
13889 retries.
13890
13891 .cindex "&_/etc/passwd_&" "multiple reading of"
13892 You should not set this option greater than zero if your user information is in
13893 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13894 search the file multiple times for non-existent users, and also cause delay.
13895
13896
13897
13898 .option freeze_tell main "string list, comma separated" unset
13899 .cindex "freezing messages" "sending a message when freezing"
13900 On encountering certain errors, or when configured to do so in a system filter,
13901 ACL, or special router, Exim freezes a message. This means that no further
13902 delivery attempts take place until an administrator thaws the message, or the
13903 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13904 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13905 warning message whenever it freezes something, unless the message it is
13906 freezing is a locally-generated bounce message. (Without this exception there
13907 is the possibility of looping.) The warning message is sent to the addresses
13908 supplied as the comma-separated value of this option. If several of the
13909 message's addresses cause freezing, only a single message is sent. If the
13910 freezing was automatic, the reason(s) for freezing can be found in the message
13911 log. If you configure freezing in a filter or ACL, you must arrange for any
13912 logging that you require.
13913
13914
13915 .option gecos_name main string&!! unset
13916 .cindex "HP-UX"
13917 .cindex "&""gecos""& field, parsing"
13918 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13919 password file to hold other information in addition to users' real names. Exim
13920 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13921 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13922 of the field are used unchanged, except that, if an ampersand is encountered,
13923 it is replaced by the user's login name with the first character forced to
13924 upper case, since this is a convention that is observed on many systems.
13925
13926 When these options are set, &%gecos_pattern%& is treated as a regular
13927 expression that is to be applied to the field (again with && replaced by the
13928 login name), and if it matches, &%gecos_name%& is expanded and used as the
13929 user's name.
13930
13931 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13932 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13933 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13934 name terminates at the first comma, the following can be used:
13935 .code
13936 gecos_pattern = ([^,]*)
13937 gecos_name = $1
13938 .endd
13939
13940 .option gecos_pattern main string unset
13941 See &%gecos_name%& above.
13942
13943
13944 .option gnutls_compat_mode main boolean unset
13945 This option controls whether GnuTLS is used in compatibility mode in an Exim
13946 server. This reduces security slightly, but improves interworking with older
13947 implementations of TLS.
13948
13949
13950 .new
13951 option gnutls_enable_pkcs11 main boolean unset
13952 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
13953 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
13954
13955 See
13956 &url(http://www.gnu.org/software/gnutls/manual/gnutls.html#Smart-cards-and-HSMs)
13957 for documentation.
13958 .wen
13959
13960
13961
13962 .option headers_charset main string "see below"
13963 This option sets a default character set for translating from encoded MIME
13964 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13965 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13966 ultimate default is ISO-8859-1. For more details see the description of header
13967 insertions in section &<<SECTexpansionitems>>&.
13968
13969
13970
13971 .option header_maxsize main integer "see below"
13972 .cindex "header section" "maximum size of"
13973 .cindex "limit" "size of message header section"
13974 This option controls the overall maximum size of a message's header
13975 section. The default is the value of HEADER_MAXSIZE in
13976 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13977 sections are rejected.
13978
13979
13980 .option header_line_maxsize main integer 0
13981 .cindex "header lines" "maximum size of"
13982 .cindex "limit" "size of one header line"
13983 This option limits the length of any individual header line in a message, after
13984 all the continuations have been joined together. Messages with individual
13985 header lines that are longer than the limit are rejected. The default value of
13986 zero means &"no limit"&.
13987
13988
13989
13990
13991 .option helo_accept_junk_hosts main "host list&!!" unset
13992 .cindex "HELO" "accepting junk data"
13993 .cindex "EHLO" "accepting junk data"
13994 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13995 mail, and gives an error response for invalid data. Unfortunately, there are
13996 some SMTP clients that send syntactic junk. They can be accommodated by setting
13997 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13998 if you want to do semantic checking.
13999 See also &%helo_allow_chars%& for a way of extending the permitted character
14000 set.
14001
14002
14003 .option helo_allow_chars main string unset
14004 .cindex "HELO" "underscores in"
14005 .cindex "EHLO" "underscores in"
14006 .cindex "underscore in EHLO/HELO"
14007 This option can be set to a string of rogue characters that are permitted in
14008 all EHLO and HELO names in addition to the standard letters, digits,
14009 hyphens, and dots. If you really must allow underscores, you can set
14010 .code
14011 helo_allow_chars = _
14012 .endd
14013 Note that the value is one string, not a list.
14014
14015
14016 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14017 .cindex "HELO" "forcing reverse lookup"
14018 .cindex "EHLO" "forcing reverse lookup"
14019 If the domain given by a client in a HELO or EHLO command matches this
14020 list, a reverse lookup is done in order to establish the host's true name. The
14021 default forces a lookup if the client host gives the server's name or any of
14022 its IP addresses (in brackets), something that broken clients have been seen to
14023 do.
14024
14025
14026 .option helo_try_verify_hosts main "host list&!!" unset
14027 .cindex "HELO verifying" "optional"
14028 .cindex "EHLO" "verifying, optional"
14029 By default, Exim just checks the syntax of HELO and EHLO commands (see
14030 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14031 to do more extensive checking of the data supplied by these commands. The ACL
14032 condition &`verify = helo`& is provided to make this possible.
14033 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14034 to force the check to occur. From release 4.53 onwards, this is no longer
14035 necessary. If the check has not been done before &`verify = helo`& is
14036 encountered, it is done at that time. Consequently, this option is obsolete.
14037 Its specification is retained here for backwards compatibility.
14038
14039 When an EHLO or HELO command is received, if the calling host matches
14040 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14041 EHLO command either:
14042
14043 .ilist
14044 is an IP literal matching the calling address of the host, or
14045 .next
14046 .cindex "DNS" "reverse lookup"
14047 .cindex "reverse DNS lookup"
14048 matches the host name that Exim obtains by doing a reverse lookup of the
14049 calling host address, or
14050 .next
14051 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14052 available) yields the calling host address.
14053 .endlist
14054
14055 However, the EHLO or HELO command is not rejected if any of the checks
14056 fail. Processing continues, but the result of the check is remembered, and can
14057 be detected later in an ACL by the &`verify = helo`& condition.
14058
14059 .option helo_verify_hosts main "host list&!!" unset
14060 .cindex "HELO verifying" "mandatory"
14061 .cindex "EHLO" "verifying, mandatory"
14062 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14063 backwards compatibility. For hosts that match this option, Exim checks the host
14064 name given in the HELO or EHLO in the same way as for
14065 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14066 rejected with a 550 error, and entries are written to the main and reject logs.
14067 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14068 error.
14069
14070 .option hold_domains main "domain list&!!" unset
14071 .cindex "domain" "delaying delivery"
14072 .cindex "delivery" "delaying certain domains"
14073 This option allows mail for particular domains to be held on the queue
14074 manually. The option is overridden if a message delivery is forced with the
14075 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14076 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14077 item in &%hold_domains%&, no routing or delivery for that address is done, and
14078 it is deferred every time the message is looked at.
14079
14080 This option is intended as a temporary operational measure for delaying the
14081 delivery of mail while some problem is being sorted out, or some new
14082 configuration tested. If you just want to delay the processing of some
14083 domains until a queue run occurs, you should use &%queue_domains%& or
14084 &%queue_smtp_domains%&, not &%hold_domains%&.
14085
14086 A setting of &%hold_domains%& does not override Exim's code for removing
14087 messages from the queue if they have been there longer than the longest retry
14088 time in any retry rule. If you want to hold messages for longer than the normal
14089 retry times, insert a dummy retry rule with a long retry time.
14090
14091
14092 .option host_lookup main "host list&!!" unset
14093 .cindex "host name" "lookup, forcing"
14094 Exim does not look up the name of a calling host from its IP address unless it
14095 is required to compare against some host list, or the host matches
14096 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14097 option (which normally contains IP addresses rather than host names). The
14098 default configuration file contains
14099 .code
14100 host_lookup = *
14101 .endd
14102 which causes a lookup to happen for all hosts. If the expense of these lookups
14103 is felt to be too great, the setting can be changed or removed.
14104
14105 After a successful reverse lookup, Exim does a forward lookup on the name it
14106 has obtained, to verify that it yields the IP address that it started with. If
14107 this check fails, Exim behaves as if the name lookup failed.
14108
14109 .vindex "&$host_lookup_failed$&"
14110 .vindex "&$sender_host_name$&"
14111 After any kind of failure, the host name (in &$sender_host_name$&) remains
14112 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14113 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14114 &`verify = reverse_host_lookup`& in ACLs.
14115
14116
14117 .option host_lookup_order main "string list" &`bydns:byaddr`&
14118 This option specifies the order of different lookup methods when Exim is trying
14119 to find a host name from an IP address. The default is to do a DNS lookup
14120 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14121 if that fails. You can change the order of these lookups, or omit one entirely,
14122 if you want.
14123
14124 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14125 multiple PTR records in the DNS and the IP address is not listed in
14126 &_/etc/hosts_&. Different operating systems give different results in this
14127 case. That is why the default tries a DNS lookup first.
14128
14129
14130
14131 .option host_reject_connection main "host list&!!" unset
14132 .cindex "host" "rejecting connections from"
14133 If this option is set, incoming SMTP calls from the hosts listed are rejected
14134 as soon as the connection is made.
14135 This option is obsolete, and retained only for backward compatibility, because
14136 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14137 connections immediately.
14138
14139 The ability to give an immediate rejection (either by this option or using an
14140 ACL) is provided for use in unusual cases. Many hosts will just try again,
14141 sometimes without much delay. Normally, it is better to use an ACL to reject
14142 incoming messages at a later stage, such as after RCPT commands. See
14143 chapter &<<CHAPACL>>&.
14144
14145
14146 .option hosts_connection_nolog main "host list&!!" unset
14147 .cindex "host" "not logging connections from"
14148 This option defines a list of hosts for which connection logging does not
14149 happen, even though the &%smtp_connection%& log selector is set. For example,
14150 you might want not to log SMTP connections from local processes, or from
14151 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14152 the daemon; you should therefore strive to restrict its value to a short inline
14153 list of IP addresses and networks. To disable logging SMTP connections from
14154 local processes, you must create a host list with an empty item. For example:
14155 .code
14156 hosts_connection_nolog = :
14157 .endd
14158 If the &%smtp_connection%& log selector is not set, this option has no effect.
14159
14160
14161
14162 .option hosts_treat_as_local main "domain list&!!" unset
14163 .cindex "local host" "domains treated as"
14164 .cindex "host" "treated as local"
14165 If this option is set, any host names that match the domain list are treated as
14166 if they were the local host when Exim is scanning host lists obtained from MX
14167 records
14168 or other sources. Note that the value of this option is a domain list, not a
14169 host list, because it is always used to check host names, not IP addresses.
14170
14171 This option also applies when Exim is matching the special items
14172 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14173 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14174 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14175 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14176 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14177 interfaces and recognizing the local host.
14178
14179
14180 .option ibase_servers main "string list" unset
14181 .cindex "InterBase" "server list"
14182 This option provides a list of InterBase servers and associated connection data,
14183 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14184 The option is available only if Exim has been built with InterBase support.
14185
14186
14187
14188 .option ignore_bounce_errors_after main time 10w
14189 .cindex "bounce message" "discarding"
14190 .cindex "discarding bounce message"
14191 This option affects the processing of bounce messages that cannot be delivered,
14192 that is, those that suffer a permanent delivery failure. (Bounce messages that
14193 suffer temporary delivery failures are of course retried in the usual way.)
14194
14195 After a permanent delivery failure, bounce messages are frozen,
14196 because there is no sender to whom they can be returned. When a frozen bounce
14197 message has been on the queue for more than the given time, it is unfrozen at
14198 the next queue run, and a further delivery is attempted. If delivery fails
14199 again, the bounce message is discarded. This makes it possible to keep failed
14200 bounce messages around for a shorter time than the normal maximum retry time
14201 for frozen messages. For example,
14202 .code
14203 ignore_bounce_errors_after = 12h
14204 .endd
14205 retries failed bounce message deliveries after 12 hours, discarding any further
14206 failures. If the value of this option is set to a zero time period, bounce
14207 failures are discarded immediately. Setting a very long time (as in the default
14208 value) has the effect of disabling this option. For ways of automatically
14209 dealing with other kinds of frozen message, see &%auto_thaw%& and
14210 &%timeout_frozen_after%&.
14211
14212
14213 .option ignore_fromline_hosts main "host list&!!" unset
14214 .cindex "&""From""& line"
14215 .cindex "UUCP" "&""From""& line"
14216 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14217 the headers of a message. By default this is treated as the start of the
14218 message's body, which means that any following headers are not recognized as
14219 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14220 match those hosts that insist on sending it. If the sender is actually a local
14221 process rather than a remote host, and is using &%-bs%& to inject the messages,
14222 &%ignore_fromline_local%& must be set to achieve this effect.
14223
14224
14225 .option ignore_fromline_local main boolean false
14226 See &%ignore_fromline_hosts%& above.
14227
14228
14229 .option keep_malformed main time 4d
14230 This option specifies the length of time to keep messages whose spool files
14231 have been corrupted in some way. This should, of course, never happen. At the
14232 next attempt to deliver such a message, it gets removed. The incident is
14233 logged.
14234
14235
14236 .option ldap_ca_cert_dir main string unset
14237 .cindex "LDAP", "TLS CA certificate directory"
14238 This option indicates which directory contains CA certificates for verifying
14239 a TLS certificate presented by an LDAP server.
14240 While Exim does not provide a default value, your SSL library may.
14241 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14242 and constrained to be a directory.
14243
14244
14245 .option ldap_ca_cert_file main string unset
14246 .cindex "LDAP", "TLS CA certificate file"
14247 This option indicates which file contains CA certificates for verifying
14248 a TLS certificate presented by an LDAP server.
14249 While Exim does not provide a default value, your SSL library may.
14250 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14251 and constrained to be a file.
14252
14253
14254 .option ldap_cert_file main string unset
14255 .cindex "LDAP" "TLS client certificate file"
14256 This option indicates which file contains an TLS client certificate which
14257 Exim should present to the LDAP server during TLS negotiation.
14258 Should be used together with &%ldap_cert_key%&.
14259
14260
14261 .option ldap_cert_key main string unset
14262 .cindex "LDAP" "TLS client key file"
14263 This option indicates which file contains the secret/private key to use
14264 to prove identity to the LDAP server during TLS negotiation.
14265 Should be used together with &%ldap_cert_file%&, which contains the
14266 identity to be proven.
14267
14268
14269 .option ldap_cipher_suite main string unset
14270 .cindex "LDAP" "TLS cipher suite"
14271 This controls the TLS cipher-suite negotiation during TLS negotiation with
14272 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14273 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14274
14275
14276 .option ldap_default_servers main "string list" unset
14277 .cindex "LDAP" "default servers"
14278 This option provides a list of LDAP servers which are tried in turn when an
14279 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14280 details of LDAP queries. This option is available only when Exim has been built
14281 with LDAP support.
14282
14283
14284 .option ldap_require_cert main string unset.
14285 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14286 This should be one of the values "hard", "demand", "allow", "try" or "never".
14287 A value other than one of these is interpreted as "never".
14288 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14289 Although Exim does not set a default, the LDAP library probably defaults
14290 to hard/demand.
14291
14292
14293 .option ldap_start_tls main boolean false
14294 .cindex "LDAP" "whether or not to negotiate TLS"
14295 If set, Exim will attempt to negotiate TLS with the LDAP server when
14296 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14297 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14298 of SSL-on-connect.
14299 In the event of failure to negotiate TLS, the action taken is controlled
14300 by &%ldap_require_cert%&.
14301
14302
14303 .option ldap_version main integer unset
14304 .cindex "LDAP" "protocol version, forcing"
14305 This option can be used to force Exim to set a specific protocol version for
14306 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14307 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14308 the LDAP headers; otherwise it is 2. This option is available only when Exim
14309 has been built with LDAP support.
14310
14311
14312
14313 .option local_from_check main boolean true
14314 .cindex "&'Sender:'& header line" "disabling addition of"
14315 .cindex "&'From:'& header line" "disabling checking of"
14316 When a message is submitted locally (that is, not over a TCP/IP connection) by
14317 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14318 checks that the &'From:'& header line matches the login of the calling user and
14319 the domain specified by &%qualify_domain%&.
14320
14321 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14322 locally submitted message is automatically qualified by Exim, unless the
14323 &%-bnq%& command line option is used.
14324
14325 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14326 on the local part. If the &'From:'& header line does not match, Exim adds a
14327 &'Sender:'& header with an address constructed from the calling user's login
14328 and the default qualify domain.
14329
14330 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14331 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14332 &'Sender:'& header lines supplied by untrusted users, you must also set
14333 &%local_sender_retain%& to be true.
14334
14335 .cindex "envelope sender"
14336 These options affect only the header lines in the message. The envelope sender
14337 is still forced to be the login id at the qualify domain unless
14338 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14339
14340 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14341 request similar header line checking. See section &<<SECTthesenhea>>&, which
14342 has more details about &'Sender:'& processing.
14343
14344
14345
14346
14347 .option local_from_prefix main string unset
14348 When Exim checks the &'From:'& header line of locally submitted messages for
14349 matching the login id (see &%local_from_check%& above), it can be configured to
14350 ignore certain prefixes and suffixes in the local part of the address. This is
14351 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14352 appropriate lists, in the same form as the &%local_part_prefix%& and
14353 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14354 example, if
14355 .code
14356 local_from_prefix = *-
14357 .endd
14358 is set, a &'From:'& line containing
14359 .code
14360 From: anything-user@your.domain.example
14361 .endd
14362 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14363 matches the actual sender address that is constructed from the login name and
14364 qualify domain.
14365
14366
14367 .option local_from_suffix main string unset
14368 See &%local_from_prefix%& above.
14369
14370
14371 .option local_interfaces main "string list" "see below"
14372 This option controls which network interfaces are used by the daemon for
14373 listening; they are also used to identify the local host when routing. Chapter
14374 &<<CHAPinterfaces>>& contains a full description of this option and the related
14375 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14376 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14377 &%local_interfaces%& is
14378 .code
14379 local_interfaces = 0.0.0.0
14380 .endd
14381 when Exim is built without IPv6 support; otherwise it is
14382 .code
14383 local_interfaces = <; ::0 ; 0.0.0.0
14384 .endd
14385
14386 .option local_scan_timeout main time 5m
14387 .cindex "timeout" "for &[local_scan()]& function"
14388 .cindex "&[local_scan()]& function" "timeout"
14389 This timeout applies to the &[local_scan()]& function (see chapter
14390 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14391 the incoming message is rejected with a temporary error if it is an SMTP
14392 message. For a non-SMTP message, the message is dropped and Exim ends with a
14393 non-zero code. The incident is logged on the main and reject logs.
14394
14395
14396
14397 .option local_sender_retain main boolean false
14398 .cindex "&'Sender:'& header line" "retaining from local submission"
14399 When a message is submitted locally (that is, not over a TCP/IP connection) by
14400 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14401 do not want this to happen, you must set &%local_sender_retain%&, and you must
14402 also set &%local_from_check%& to be false (Exim will complain if you do not).
14403 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14404 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14405
14406
14407
14408
14409 .option localhost_number main string&!! unset
14410 .cindex "host" "locally unique number for"
14411 .cindex "message ids" "with multiple hosts"
14412 .vindex "&$localhost_number$&"
14413 Exim's message ids are normally unique only within the local host. If
14414 uniqueness among a set of hosts is required, each host must set a different
14415 value for the &%localhost_number%& option. The string is expanded immediately
14416 after reading the configuration file (so that a number can be computed from the
14417 host name, for example) and the result of the expansion must be a number in the
14418 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14419 systems). This is available in subsequent string expansions via the variable
14420 &$localhost_number$&. When &%localhost_number is set%&, the final two
14421 characters of the message id, instead of just being a fractional part of the
14422 time, are computed from the time and the local host number as described in
14423 section &<<SECTmessiden>>&.
14424
14425
14426
14427 .option log_file_path main "string list&!!" "set at compile time"
14428 .cindex "log" "file path for"
14429 This option sets the path which is used to determine the names of Exim's log
14430 files, or indicates that logging is to be to syslog, or both. It is expanded
14431 when Exim is entered, so it can, for example, contain a reference to the host
14432 name. If no specific path is set for the log files at compile or run time, they
14433 are written in a sub-directory called &_log_& in Exim's spool directory.
14434 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14435 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14436 used. If this string is fixed at your installation (contains no expansion
14437 variables) it is recommended that you do not set this option in the
14438 configuration file, but instead supply the path using LOG_FILE_PATH in
14439 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14440 early on &-- in particular, failure to read the configuration file.
14441
14442
14443 .option log_selector main string unset
14444 .cindex "log" "selectors"
14445 This option can be used to reduce or increase the number of things that Exim
14446 writes to its log files. Its argument is made up of names preceded by plus or
14447 minus characters. For example:
14448 .code
14449 log_selector = +arguments -retry_defer
14450 .endd
14451 A list of possible names and what they control is given in the chapter on
14452 logging, in section &<<SECTlogselector>>&.
14453
14454
14455 .option log_timezone main boolean false
14456 .cindex "log" "timezone for entries"
14457 .vindex "&$tod_log$&"
14458 .vindex "&$tod_zone$&"
14459 By default, the timestamps on log lines are in local time without the
14460 timezone. This means that if your timezone changes twice a year, the timestamps
14461 in log lines are ambiguous for an hour when the clocks go back. One way of
14462 avoiding this problem is to set the timezone to UTC. An alternative is to set
14463 &%log_timezone%& true. This turns on the addition of the timezone offset to
14464 timestamps in log lines. Turning on this option can add quite a lot to the size
14465 of log files because each line is extended by 6 characters. Note that the
14466 &$tod_log$& variable contains the log timestamp without the zone, but there is
14467 another variable called &$tod_zone$& that contains just the timezone offset.
14468
14469
14470 .option lookup_open_max main integer 25
14471 .cindex "too many open files"
14472 .cindex "open files, too many"
14473 .cindex "file" "too many open"
14474 .cindex "lookup" "maximum open files"
14475 .cindex "limit" "open files for lookups"
14476 This option limits the number of simultaneously open files for single-key
14477 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14478 Exim normally keeps these files open during routing, because often the same
14479 file is required several times. If the limit is reached, Exim closes the least
14480 recently used file. Note that if you are using the &'ndbm'& library, it
14481 actually opens two files for each logical DBM database, though it still counts
14482 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14483 open files"& errors with NDBM, you need to reduce the value of
14484 &%lookup_open_max%&.
14485
14486
14487 .option max_username_length main integer 0
14488 .cindex "length of login name"
14489 .cindex "user name" "maximum length"
14490 .cindex "limit" "user name length"
14491 Some operating systems are broken in that they truncate long arguments to
14492 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14493 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14494 an argument that is longer behaves as if &[getpwnam()]& failed.
14495
14496
14497 .option message_body_newlines main bool false
14498 .cindex "message body" "newlines in variables"
14499 .cindex "newline" "in message body variables"
14500 .vindex "&$message_body$&"
14501 .vindex "&$message_body_end$&"
14502 By default, newlines in the message body are replaced by spaces when setting
14503 the &$message_body$& and &$message_body_end$& expansion variables. If this
14504 option is set true, this no longer happens.
14505
14506
14507 .option message_body_visible main integer 500
14508 .cindex "body of message" "visible size"
14509 .cindex "message body" "visible size"
14510 .vindex "&$message_body$&"
14511 .vindex "&$message_body_end$&"
14512 This option specifies how much of a message's body is to be included in the
14513 &$message_body$& and &$message_body_end$& expansion variables.
14514
14515
14516 .option message_id_header_domain main string&!! unset
14517 .cindex "&'Message-ID:'& header line"
14518 If this option is set, the string is expanded and used as the right hand side
14519 (domain) of the &'Message-ID:'& header that Exim creates if a
14520 locally-originated incoming message does not have one. &"Locally-originated"&
14521 means &"not received over TCP/IP."&
14522 Otherwise, the primary host name is used.
14523 Only letters, digits, dot and hyphen are accepted; any other characters are
14524 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14525 empty string, the option is ignored.
14526
14527
14528 .option message_id_header_text main string&!! unset
14529 If this variable is set, the string is expanded and used to augment the text of
14530 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14531 message does not have one. The text of this header is required by RFC 2822 to
14532 take the form of an address. By default, Exim uses its internal message id as
14533 the local part, and the primary host name as the domain. If this option is set,
14534 it is expanded, and provided the expansion is not forced to fail, and does not
14535 yield an empty string, the result is inserted into the header immediately
14536 before the @, separated from the internal message id by a dot. Any characters
14537 that are illegal in an address are automatically converted into hyphens. This
14538 means that variables such as &$tod_log$& can be used, because the spaces and
14539 colons will become hyphens.
14540
14541
14542 .option message_logs main boolean true
14543 .cindex "message logs" "disabling"
14544 .cindex "log" "message log; disabling"
14545 If this option is turned off, per-message log files are not created in the
14546 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14547 Exim, by reducing the number of files involved in handling a message from a
14548 minimum of four (header spool file, body spool file, delivery journal, and
14549 per-message log) to three. The other major I/O activity is Exim's main log,
14550 which is not affected by this option.
14551
14552
14553 .option message_size_limit main string&!! 50M
14554 .cindex "message" "size limit"
14555 .cindex "limit" "message size"
14556 .cindex "size" "of message, limit"
14557 This option limits the maximum size of message that Exim will process. The
14558 value is expanded for each incoming connection so, for example, it can be made
14559 to depend on the IP address of the remote host for messages arriving via
14560 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14561 optionally followed by K or M.
14562
14563 &*Note*&: This limit cannot be made to depend on a message's sender or any
14564 other properties of an individual message, because it has to be advertised in
14565 the server's response to EHLO. String expansion failure causes a temporary
14566 error. A value of zero means no limit, but its use is not recommended. See also
14567 &%bounce_return_size_limit%&.
14568
14569 Incoming SMTP messages are failed with a 552 error if the limit is
14570 exceeded; locally-generated messages either get a stderr message or a delivery
14571 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14572 an oversized message is logged in both the main and the reject logs. See also
14573 the generic transport option &%message_size_limit%&, which limits the size of
14574 message that an individual transport can process.
14575
14576 If you use a virus-scanner and set this option to to a value larger than the
14577 maximum size that your virus-scanner is configured to support, you may get
14578 failures triggered by large mails.  The right size to configure for the
14579 virus-scanner depends upon what data is passed and the options in use but it's
14580 probably safest to just set it to a little larger than this value.  Eg, with a
14581 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14582 some problems may result.
14583
14584 A value of 0 will disable size limit checking; Exim will still advertise the
14585 SIZE extension in an EHLO response, but without a limit, so as to permit
14586 SMTP clients to still indicate the message size along with the MAIL verb.
14587
14588
14589 .option move_frozen_messages main boolean false
14590 .cindex "frozen messages" "moving"
14591 This option, which is available only if Exim has been built with the setting
14592 .code
14593 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14594 .endd
14595 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14596 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14597 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14598 standard utilities for handling such moved messages, and they do not show up in
14599 lists generated by &%-bp%& or by the Exim monitor.
14600
14601
14602 .option mua_wrapper main boolean false
14603 Setting this option true causes Exim to run in a very restrictive mode in which
14604 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14605 contains a full description of this facility.
14606
14607
14608
14609 .option mysql_servers main "string list" unset
14610 .cindex "MySQL" "server list"
14611 This option provides a list of MySQL servers and associated connection data, to
14612 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14613 option is available only if Exim has been built with MySQL support.
14614
14615
14616 .option never_users main "string list&!!" unset
14617 This option is expanded just once, at the start of Exim's processing. Local
14618 message deliveries are normally run in processes that are setuid to the
14619 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14620 It is usually desirable to prevent any deliveries from running as root, as a
14621 safety precaution.
14622
14623 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14624 list of users that must not be used for local deliveries. This list is fixed in
14625 the binary and cannot be overridden by the configuration file. By default, it
14626 contains just the single user name &"root"&. The &%never_users%& runtime option
14627 can be used to add more users to the fixed list.
14628
14629 If a message is to be delivered as one of the users on the fixed list or the
14630 &%never_users%& list, an error occurs, and delivery is deferred. A common
14631 example is
14632 .code
14633 never_users = root:daemon:bin
14634 .endd
14635 Including root is redundant if it is also on the fixed list, but it does no
14636 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14637 transport driver.
14638
14639
14640 .option openssl_options main "string list" "+no_sslv2"
14641 .cindex "OpenSSL "compatibility options"
14642 This option allows an administrator to adjust the SSL options applied
14643 by OpenSSL to connections.  It is given as a space-separated list of items,
14644 each one to be +added or -subtracted from the current value.
14645
14646 This option is only available if Exim is built against OpenSSL.  The values
14647 available for this option vary according to the age of your OpenSSL install.
14648 The &"all"& value controls a subset of flags which are available, typically
14649 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14650 list the values known on your system and Exim should support all the
14651 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14652 names lose the leading &"SSL_OP_"& and are lower-cased.
14653
14654 Note that adjusting the options can have severe impact upon the security of
14655 SSL as used by Exim.  It is possible to disable safety checks and shoot
14656 yourself in the foot in various unpleasant ways.  This option should not be
14657 adjusted lightly.  An unrecognised item will be detected at startup, by
14658 invoking Exim with the &%-bV%& flag.
14659
14660 Historical note: prior to release 4.80, Exim defaulted this value to
14661 "+dont_insert_empty_fragments", which may still be needed for compatibility
14662 with some clients, but which lowers security by increasing exposure to
14663 some now infamous attacks.
14664
14665 An example:
14666 .code
14667 # Make both old MS and old Eudora happy:
14668 openssl_options = -all +microsoft_big_sslv3_buffer \
14669                        +dont_insert_empty_fragments
14670 .endd
14671
14672 Possible options may include:
14673 .ilist
14674 &`all`&
14675 .next
14676 &`allow_unsafe_legacy_renegotiation`&
14677 .next
14678 &`cipher_server_preference`&
14679 .next
14680 &`dont_insert_empty_fragments`&
14681 .next
14682 &`ephemeral_rsa`&
14683 .next
14684 &`legacy_server_connect`&
14685 .next
14686 &`microsoft_big_sslv3_buffer`&
14687 .next
14688 &`microsoft_sess_id_bug`&
14689 .next
14690 &`msie_sslv2_rsa_padding`&
14691 .next
14692 &`netscape_challenge_bug`&
14693 .next
14694 &`netscape_reuse_cipher_change_bug`&
14695 .next
14696 &`no_compression`&
14697 .next
14698 &`no_session_resumption_on_renegotiation`&
14699 .next
14700 &`no_sslv2`&
14701 .next
14702 &`no_sslv3`&
14703 .next
14704 &`no_ticket`&
14705 .next
14706 &`no_tlsv1`&
14707 .next
14708 &`no_tlsv1_1`&
14709 .next
14710 &`no_tlsv1_2`&
14711 .next
14712 &`single_dh_use`&
14713 .next
14714 &`single_ecdh_use`&
14715 .next
14716 &`ssleay_080_client_dh_bug`&
14717 .next
14718 &`sslref2_reuse_cert_type_bug`&
14719 .next
14720 &`tls_block_padding_bug`&
14721 .next
14722 &`tls_d5_bug`&
14723 .next
14724 &`tls_rollback_bug`&
14725 .endlist
14726
14727
14728 .option oracle_servers main "string list" unset
14729 .cindex "Oracle" "server list"
14730 This option provides a list of Oracle servers and associated connection data,
14731 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14732 The option is available only if Exim has been built with Oracle support.
14733
14734
14735 .option percent_hack_domains main "domain list&!!" unset
14736 .cindex "&""percent hack""&"
14737 .cindex "source routing" "in email address"
14738 .cindex "address" "source-routed"
14739 The &"percent hack"& is the convention whereby a local part containing a
14740 percent sign is re-interpreted as a new email address, with the percent
14741 replaced by @. This is sometimes called &"source routing"&, though that term is
14742 also applied to RFC 2822 addresses that begin with an @ character. If this
14743 option is set, Exim implements the percent facility for those domains listed,
14744 but no others. This happens before an incoming SMTP address is tested against
14745 an ACL.
14746
14747 &*Warning*&: The &"percent hack"& has often been abused by people who are
14748 trying to get round relaying restrictions. For this reason, it is best avoided
14749 if at all possible. Unfortunately, a number of less security-conscious MTAs
14750 implement it unconditionally. If you are running Exim on a gateway host, and
14751 routing mail through to internal MTAs without processing the local parts, it is
14752 a good idea to reject recipient addresses with percent characters in their
14753 local parts. Exim's default configuration does this.
14754
14755
14756 .option perl_at_start main boolean false
14757 This option is available only when Exim is built with an embedded Perl
14758 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14759
14760
14761 .option perl_startup main string unset
14762 This option is available only when Exim is built with an embedded Perl
14763 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14764
14765
14766 .option pgsql_servers main "string list" unset
14767 .cindex "PostgreSQL lookup type" "server list"
14768 This option provides a list of PostgreSQL servers and associated connection
14769 data, to be used in conjunction with &(pgsql)& lookups (see section
14770 &<<SECID72>>&). The option is available only if Exim has been built with
14771 PostgreSQL support.
14772
14773
14774 .option pid_file_path main string&!! "set at compile time"
14775 .cindex "daemon" "pid file path"
14776 .cindex "pid file, path for"
14777 This option sets the name of the file to which the Exim daemon writes its
14778 process id. The string is expanded, so it can contain, for example, references
14779 to the host name:
14780 .code
14781 pid_file_path = /var/log/$primary_hostname/exim.pid
14782 .endd
14783 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14784 spool directory.
14785 The value set by the option can be overridden by the &%-oP%& command line
14786 option. A pid file is not written if a &"non-standard"& daemon is run by means
14787 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14788
14789
14790 .option pipelining_advertise_hosts main "host list&!!" *
14791 .cindex "PIPELINING" "suppressing advertising"
14792 This option can be used to suppress the advertisement of the SMTP
14793 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14794 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14795 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14796 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14797 that clients will use it; &"out of order"& commands that are &"expected"& do
14798 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14799
14800
14801 .option preserve_message_logs main boolean false
14802 .cindex "message logs" "preserving"
14803 If this option is set, message log files are not deleted when messages are
14804 completed. Instead, they are moved to a sub-directory of the spool directory
14805 called &_msglog.OLD_&, where they remain available for statistical or debugging
14806 purposes. This is a dangerous option to set on systems with any appreciable
14807 volume of mail. Use with care!
14808
14809
14810 .option primary_hostname main string "see below"
14811 .cindex "name" "of local host"
14812 .cindex "host" "name of local"
14813 .cindex "local host" "name of"
14814 .vindex "&$primary_hostname$&"
14815 This specifies the name of the current host. It is used in the default EHLO or
14816 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14817 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14818 The value is also used by default in some SMTP response messages from an Exim
14819 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14820
14821 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14822 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14823 contains only one component, Exim passes it to &[gethostbyname()]& (or
14824 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14825 version. The variable &$primary_hostname$& contains the host name, whether set
14826 explicitly by this option, or defaulted.
14827
14828
14829 .option print_topbitchars main boolean false
14830 .cindex "printing characters"
14831 .cindex "8-bit characters"
14832 By default, Exim considers only those characters whose codes lie in the range
14833 32&--126 to be printing characters. In a number of circumstances (for example,
14834 when writing log entries) non-printing characters are converted into escape
14835 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14836 is set, code values of 128 and above are also considered to be printing
14837 characters.
14838
14839 This option also affects the header syntax checks performed by the
14840 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14841 the user's full name when constructing From: and Sender: addresses (as
14842 described in section &<<SECTconstr>>&). Setting this option can cause
14843 Exim to generate eight bit message headers that do not conform to the
14844 standards.
14845
14846
14847 .option process_log_path main string unset
14848 .cindex "process log path"
14849 .cindex "log" "process log"
14850 .cindex "&'exiwhat'&"
14851 This option sets the name of the file to which an Exim process writes its
14852 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14853 utility script. If this option is unset, the file called &_exim-process.info_&
14854 in Exim's spool directory is used. The ability to specify the name explicitly
14855 can be useful in environments where two different Exims are running, using
14856 different spool directories.
14857
14858
14859 .option prod_requires_admin main boolean true
14860 .oindex "&%-M%&"
14861 .oindex "&%-R%&"
14862 .oindex "&%-q%&"
14863 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14864 admin user unless &%prod_requires_admin%& is set false. See also
14865 &%queue_list_requires_admin%&.
14866
14867
14868 .option qualify_domain main string "see below"
14869 .cindex "domain" "for qualifying addresses"
14870 .cindex "address" "qualification"
14871 This option specifies the domain name that is added to any envelope sender
14872 addresses that do not have a domain qualification. It also applies to
14873 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14874 are accepted by default only for locally-generated messages. Qualification is
14875 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14876 locally-generated messages, unless the &%-bnq%& command line option is used.
14877
14878 Messages from external sources must always contain fully qualified addresses,
14879 unless the sending host matches &%sender_unqualified_hosts%& or
14880 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14881 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14882 necessary. Internally, Exim always works with fully qualified envelope
14883 addresses. If &%qualify_domain%& is not set, it defaults to the
14884 &%primary_hostname%& value.
14885
14886
14887 .option qualify_recipient main string "see below"
14888 This option allows you to specify a different domain for qualifying recipient
14889 addresses to the one that is used for senders. See &%qualify_domain%& above.
14890
14891
14892
14893 .option queue_domains main "domain list&!!" unset
14894 .cindex "domain" "specifying non-immediate delivery"
14895 .cindex "queueing incoming messages"
14896 .cindex "message" "queueing certain domains"
14897 This option lists domains for which immediate delivery is not required.
14898 A delivery process is started whenever a message is received, but only those
14899 domains that do not match are processed. All other deliveries wait until the
14900 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14901
14902
14903 .option queue_list_requires_admin main boolean true
14904 .oindex "&%-bp%&"
14905 The &%-bp%& command-line option, which lists the messages that are on the
14906 queue, requires the caller to be an admin user unless
14907 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14908
14909
14910 .option queue_only main boolean false
14911 .cindex "queueing incoming messages"
14912 .cindex "message" "queueing unconditionally"
14913 If &%queue_only%& is set, a delivery process is not automatically started
14914 whenever a message is received. Instead, the message waits on the queue for the
14915 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14916 delivered immediately when certain conditions (such as heavy load) occur.
14917
14918 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14919 and &%-odi%& command line options override &%queue_only%& unless
14920 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14921 &%queue_only_load%&, and &%smtp_accept_queue%&.
14922
14923
14924 .option queue_only_file main string unset
14925 .cindex "queueing incoming messages"
14926 .cindex "message" "queueing by file existence"
14927 This option can be set to a colon-separated list of absolute path names, each
14928 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14929 it tests for the existence of each listed path using a call to &[stat()]&. For
14930 each path that exists, the corresponding queueing option is set.
14931 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14932 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14933 .code
14934 queue_only_file = smtp/some/file
14935 .endd
14936 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14937 &_/some/file_& exists.
14938
14939
14940 .option queue_only_load main fixed-point unset
14941 .cindex "load average"
14942 .cindex "queueing incoming messages"
14943 .cindex "message" "queueing by load"
14944 If the system load average is higher than this value, incoming messages from
14945 all sources are queued, and no automatic deliveries are started. If this
14946 happens during local or remote SMTP input, all subsequent messages received on
14947 the same SMTP connection are queued by default, whatever happens to the load in
14948 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14949 false.
14950
14951 Deliveries will subsequently be performed by queue runner processes. This
14952 option has no effect on ancient operating systems on which Exim cannot
14953 determine the load average. See also &%deliver_queue_load_max%& and
14954 &%smtp_load_reserve%&.
14955
14956
14957 .option queue_only_load_latch main boolean true
14958 .cindex "load average" "re-evaluating per message"
14959 When this option is true (the default), once one message has been queued
14960 because the load average is higher than the value set by &%queue_only_load%&,
14961 all subsequent messages received on the same SMTP connection are also queued.
14962 This is a deliberate choice; even though the load average may fall below the
14963 threshold, it doesn't seem right to deliver later messages on the same
14964 connection when not delivering earlier ones. However, there are special
14965 circumstances such as very long-lived connections from scanning appliances
14966 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14967 should be set false. This causes the value of the load average to be
14968 re-evaluated for each message.
14969
14970
14971 .option queue_only_override main boolean true
14972 .cindex "queueing incoming messages"
14973 When this option is true, the &%-od%&&'x'& command line options override the
14974 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14975 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14976 to override; they are accepted, but ignored.
14977
14978
14979 .option queue_run_in_order main boolean false
14980 .cindex "queue runner" "processing messages in order"
14981 If this option is set, queue runs happen in order of message arrival instead of
14982 in an arbitrary order. For this to happen, a complete list of the entire queue
14983 must be set up before the deliveries start. When the queue is all held in a
14984 single directory (the default), a single list is created for both the ordered
14985 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14986 single list is not created when &%queue_run_in_order%& is false. In this case,
14987 the sub-directories are processed one at a time (in a random order), and this
14988 avoids setting up one huge list for the whole queue. Thus, setting
14989 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14990 when the queue is large, because of the extra work in setting up the single,
14991 large list. In most situations, &%queue_run_in_order%& should not be set.
14992
14993
14994
14995 .option queue_run_max main integer 5
14996 .cindex "queue runner" "maximum number of"
14997 This controls the maximum number of queue runner processes that an Exim daemon
14998 can run simultaneously. This does not mean that it starts them all at once,
14999 but rather that if the maximum number are still running when the time comes to
15000 start another one, it refrains from starting another one. This can happen with
15001 very large queues and/or very sluggish deliveries. This option does not,
15002 however, interlock with other processes, so additional queue runners can be
15003 started by other means, or by killing and restarting the daemon.
15004
15005 Setting this option to zero does not suppress queue runs; rather, it disables
15006 the limit, allowing any number of simultaneous queue runner processes to be
15007 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15008 the daemon's command line.
15009
15010 .option queue_smtp_domains main "domain list&!!" unset
15011 .cindex "queueing incoming messages"
15012 .cindex "message" "queueing remote deliveries"
15013 When this option is set, a delivery process is started whenever a message is
15014 received, routing is performed, and local deliveries take place.
15015 However, if any SMTP deliveries are required for domains that match
15016 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15017 message waits on the queue for the next queue run. Since routing of the message
15018 has taken place, Exim knows to which remote hosts it must be delivered, and so
15019 when the queue run happens, multiple messages for the same host are delivered
15020 over a single SMTP connection. The &%-odqs%& command line option causes all
15021 SMTP deliveries to be queued in this way, and is equivalent to setting
15022 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15023 &%queue_domains%&.
15024
15025
15026 .option receive_timeout main time 0s
15027 .cindex "timeout" "for non-SMTP input"
15028 This option sets the timeout for accepting a non-SMTP message, that is, the
15029 maximum time that Exim waits when reading a message on the standard input. If
15030 the value is zero, it will wait for ever. This setting is overridden by the
15031 &%-or%& command line option. The timeout for incoming SMTP messages is
15032 controlled by &%smtp_receive_timeout%&.
15033
15034 .option received_header_text main string&!! "see below"
15035 .cindex "customizing" "&'Received:'& header"
15036 .cindex "&'Received:'& header line" "customizing"
15037 This string defines the contents of the &'Received:'& message header that is
15038 added to each message, except for the timestamp, which is automatically added
15039 on at the end (preceded by a semicolon). The string is expanded each time it is
15040 used. If the expansion yields an empty string, no &'Received:'& header line is
15041 added to the message. Otherwise, the string should start with the text
15042 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15043 header lines. The default setting is:
15044
15045 .code
15046 received_header_text = Received: \
15047   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15048   {${if def:sender_ident \
15049   {from ${quote_local_part:$sender_ident} }}\
15050   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15051   by $primary_hostname \
15052   ${if def:received_protocol {with $received_protocol}} \
15053   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15054   (Exim $version_number)\n\t\
15055   ${if def:sender_address \
15056   {(envelope-from <$sender_address>)\n\t}}\
15057   id $message_exim_id\
15058   ${if def:received_for {\n\tfor $received_for}}
15059 .endd
15060
15061 The reference to the TLS cipher is omitted when Exim is built without TLS
15062 support. The use of conditional expansions ensures that this works for both
15063 locally generated messages and messages received from remote hosts, giving
15064 header lines such as the following:
15065 .code
15066 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15067 by marley.carol.example with esmtp (Exim 4.00)
15068 (envelope-from <bob@carol.example>)
15069 id 16IOWa-00019l-00
15070 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15071 Received: by scrooge.carol.example with local (Exim 4.00)
15072 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15073 .endd
15074 Until the body of the message has been received, the timestamp is the time when
15075 the message started to be received. Once the body has arrived, and all policy
15076 checks have taken place, the timestamp is updated to the time at which the
15077 message was accepted.
15078
15079
15080 .option received_headers_max main integer 30
15081 .cindex "loop" "prevention"
15082 .cindex "mail loop prevention"
15083 .cindex "&'Received:'& header line" "counting"
15084 When a message is to be delivered, the number of &'Received:'& headers is
15085 counted, and if it is greater than this parameter, a mail loop is assumed to
15086 have occurred, the delivery is abandoned, and an error message is generated.
15087 This applies to both local and remote deliveries.
15088
15089
15090 .option recipient_unqualified_hosts main "host list&!!" unset
15091 .cindex "unqualified addresses"
15092 .cindex "host" "unqualified addresses from"
15093 This option lists those hosts from which Exim is prepared to accept unqualified
15094 recipient addresses in message envelopes. The addresses are made fully
15095 qualified by the addition of the &%qualify_recipient%& value. This option also
15096 affects message header lines. Exim does not reject unqualified recipient
15097 addresses in headers, but it qualifies them only if the message came from a
15098 host that matches &%recipient_unqualified_hosts%&,
15099 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15100 option was not set.
15101
15102
15103 .option recipients_max main integer 0
15104 .cindex "limit" "number of recipients"
15105 .cindex "recipient" "maximum number"
15106 If this option is set greater than zero, it specifies the maximum number of
15107 original recipients for any message. Additional recipients that are generated
15108 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15109 all recipients over the limit; earlier recipients are delivered as normal.
15110 Non-SMTP messages with too many recipients are failed, and no deliveries are
15111 done.
15112
15113 .cindex "RCPT" "maximum number of incoming"
15114 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15115 RCPT commands in a single message.
15116
15117
15118 .option recipients_max_reject main boolean false
15119 If this option is set true, Exim rejects SMTP messages containing too many
15120 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15121 error to the eventual DATA command. Otherwise (the default) it gives a 452
15122 error to the surplus RCPT commands and accepts the message on behalf of the
15123 initial set of recipients. The remote server should then re-send the message
15124 for the remaining recipients at a later time.
15125
15126
15127 .option remote_max_parallel main integer 2
15128 .cindex "delivery" "parallelism for remote"
15129 This option controls parallel delivery of one message to a number of remote
15130 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15131 does all the remote deliveries for a message one by one. Otherwise, if a single
15132 message has to be delivered to more than one remote host, or if several copies
15133 have to be sent to the same remote host, up to &%remote_max_parallel%&
15134 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15135 deliveries are required, the maximum number of processes are started, and as
15136 each one finishes, another is begun. The order of starting processes is the
15137 same as if sequential delivery were being done, and can be controlled by the
15138 &%remote_sort_domains%& option. If parallel delivery takes place while running
15139 with debugging turned on, the debugging output from each delivery process is
15140 tagged with its process id.
15141
15142 This option controls only the maximum number of parallel deliveries for one
15143 message in one Exim delivery process. Because Exim has no central queue
15144 manager, there is no way of controlling the total number of simultaneous
15145 deliveries if the configuration allows a delivery attempt as soon as a message
15146 is received.
15147
15148 .cindex "number of deliveries"
15149 .cindex "delivery" "maximum number of"
15150 If you want to control the total number of deliveries on the system, you
15151 need to set the &%queue_only%& option. This ensures that all incoming messages
15152 are added to the queue without starting a delivery process. Then set up an Exim
15153 daemon to start queue runner processes at appropriate intervals (probably
15154 fairly often, for example, every minute), and limit the total number of queue
15155 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15156 delivers only one message at a time, the maximum number of deliveries that can
15157 then take place at once is &%queue_run_max%& multiplied by
15158 &%remote_max_parallel%&.
15159
15160 If it is purely remote deliveries you want to control, use
15161 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15162 doing the SMTP routing before queueing, so that several messages for the same
15163 host will eventually get delivered down the same connection.
15164
15165
15166 .option remote_sort_domains main "domain list&!!" unset
15167 .cindex "sorting remote deliveries"
15168 .cindex "delivery" "sorting remote"
15169 When there are a number of remote deliveries for a message, they are sorted by
15170 domain into the order given by this list. For example,
15171 .code
15172 remote_sort_domains = *.cam.ac.uk:*.uk
15173 .endd
15174 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15175 then to those in the &%uk%& domain, then to any others.
15176
15177
15178 .option retry_data_expire main time 7d
15179 .cindex "hints database" "data expiry"
15180 This option sets a &"use before"& time on retry information in Exim's hints
15181 database. Any older retry data is ignored. This means that, for example, once a
15182 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15183 past failures.
15184
15185
15186 .option retry_interval_max main time 24h
15187 .cindex "retry" "limit on interval"
15188 .cindex "limit" "on retry interval"
15189 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15190 intervals between delivery attempts for messages that cannot be delivered
15191 straight away. This option sets an overall limit to the length of time between
15192 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15193 the default value.
15194
15195
15196 .option return_path_remove main boolean true
15197 .cindex "&'Return-path:'& header line" "removing"
15198 RFC 2821, section 4.4, states that an SMTP server must insert a
15199 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15200 The &'Return-path:'& header preserves the sender address as received in the
15201 MAIL command. This description implies that this header should not be present
15202 in an incoming message. If &%return_path_remove%& is true, any existing
15203 &'Return-path:'& headers are removed from messages at the time they are
15204 received. Exim's transports have options for adding &'Return-path:'& headers at
15205 the time of delivery. They are normally used only for final local deliveries.
15206
15207
15208 .option return_size_limit main integer 100K
15209 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15210
15211
15212 .option rfc1413_hosts main "host list&!!" *
15213 .cindex "RFC 1413"
15214 .cindex "host" "for RFC 1413 calls"
15215 RFC 1413 identification calls are made to any client host which matches an item
15216 in the list.
15217
15218 .option rfc1413_query_timeout main time 5s
15219 .cindex "RFC 1413" "query timeout"
15220 .cindex "timeout" "for RFC 1413 call"
15221 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15222 no RFC 1413 calls are ever made.
15223
15224
15225 .option sender_unqualified_hosts main "host list&!!" unset
15226 .cindex "unqualified addresses"
15227 .cindex "host" "unqualified addresses from"
15228 This option lists those hosts from which Exim is prepared to accept unqualified
15229 sender addresses. The addresses are made fully qualified by the addition of
15230 &%qualify_domain%&. This option also affects message header lines. Exim does
15231 not reject unqualified addresses in headers that contain sender addresses, but
15232 it qualifies them only if the message came from a host that matches
15233 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15234 using TCP/IP), and the &%-bnq%& option was not set.
15235
15236
15237 .option smtp_accept_keepalive main boolean true
15238 .cindex "keepalive" "on incoming connection"
15239 This option controls the setting of the SO_KEEPALIVE option on incoming
15240 TCP/IP socket connections. When set, it causes the kernel to probe idle
15241 connections periodically, by sending packets with &"old"& sequence numbers. The
15242 other end of the connection should send an acknowledgment if the connection is
15243 still okay or a reset if the connection has been aborted. The reason for doing
15244 this is that it has the beneficial effect of freeing up certain types of
15245 connection that can get stuck when the remote host is disconnected without
15246 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15247 hours to detect unreachable hosts.
15248
15249
15250
15251 .option smtp_accept_max main integer 20
15252 .cindex "limit" "incoming SMTP connections"
15253 .cindex "SMTP" "incoming connection count"
15254 .cindex "inetd"
15255 This option specifies the maximum number of simultaneous incoming SMTP calls
15256 that Exim will accept. It applies only to the listening daemon; there is no
15257 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15258 value is set to zero, no limit is applied. However, it is required to be
15259 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15260 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15261
15262 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15263 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15264 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15265 and &%smtp_load_reserve%& are then checked before accepting the connection.
15266
15267
15268 .option smtp_accept_max_nonmail main integer 10
15269 .cindex "limit" "non-mail SMTP commands"
15270 .cindex "SMTP" "limiting non-mail commands"
15271 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15272 the connection if there are too many. This option defines &"too many"&. The
15273 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15274 client looping sending EHLO, for example. The check is applied only if the
15275 client host matches &%smtp_accept_max_nonmail_hosts%&.
15276
15277 When a new message is expected, one occurrence of RSET is not counted. This
15278 allows a client to send one RSET between messages (this is not necessary,
15279 but some clients do it). Exim also allows one uncounted occurrence of HELO
15280 or EHLO, and one occurrence of STARTTLS between messages. After
15281 starting up a TLS session, another EHLO is expected, and so it too is not
15282 counted. The first occurrence of AUTH in a connection, or immediately
15283 following STARTTLS is not counted. Otherwise, all commands other than
15284 MAIL, RCPT, DATA, and QUIT are counted.
15285
15286
15287 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15288 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15289 check by setting this option. The default value makes it apply to all hosts. By
15290 changing the value, you can exclude any badly-behaved hosts that you have to
15291 live with.
15292
15293
15294 . Allow this long option name to split; give it unsplit as a fifth argument
15295 . for the automatic .oindex that is generated by .option.
15296
15297 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15298          smtp_accept_max_per_connection
15299 .cindex "SMTP" "limiting incoming message count"
15300 .cindex "limit" "messages per SMTP connection"
15301 The value of this option limits the number of MAIL commands that Exim is
15302 prepared to accept over a single SMTP connection, whether or not each command
15303 results in the transfer of a message. After the limit is reached, a 421
15304 response is given to subsequent MAIL commands. This limit is a safety
15305 precaution against a client that goes mad (incidents of this type have been
15306 seen).
15307
15308
15309 .option smtp_accept_max_per_host main string&!! unset
15310 .cindex "limit" "SMTP connections from one host"
15311 .cindex "host" "limiting SMTP connections from"
15312 This option restricts the number of simultaneous IP connections from a single
15313 host (strictly, from a single IP address) to the Exim daemon. The option is
15314 expanded, to enable different limits to be applied to different hosts by
15315 reference to &$sender_host_address$&. Once the limit is reached, additional
15316 connection attempts from the same host are rejected with error code 421. This
15317 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15318 of zero imposes no limit. If this option is set greater than zero, it is
15319 required that &%smtp_accept_max%& be non-zero.
15320
15321 &*Warning*&: When setting this option you should not use any expansion
15322 constructions that take an appreciable amount of time. The expansion and test
15323 happen in the main daemon loop, in order to reject additional connections
15324 without forking additional processes (otherwise a denial-of-service attack
15325 could cause a vast number or processes to be created). While the daemon is
15326 doing this processing, it cannot accept any other incoming connections.
15327
15328
15329
15330 .option smtp_accept_queue main integer 0
15331 .cindex "SMTP" "incoming connection count"
15332 .cindex "queueing incoming messages"
15333 .cindex "message" "queueing by SMTP connection count"
15334 If the number of simultaneous incoming SMTP connections being handled via the
15335 listening daemon exceeds this value, messages received by SMTP are just placed
15336 on the queue; no delivery processes are started automatically. The count is
15337 fixed at the start of an SMTP connection. It cannot be updated in the
15338 subprocess that receives messages, and so the queueing or not queueing applies
15339 to all messages received in the same connection.
15340
15341 A value of zero implies no limit, and clearly any non-zero value is useful only
15342 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15343 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15344 various &%-od%&&'x'& command line options.
15345
15346
15347 . Allow this long option name to split; give it unsplit as a fifth argument
15348 . for the automatic .oindex that is generated by .option.
15349
15350 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15351          smtp_accept_queue_per_connection
15352 .cindex "queueing incoming messages"
15353 .cindex "message" "queueing by message count"
15354 This option limits the number of delivery processes that Exim starts
15355 automatically when receiving messages via SMTP, whether via the daemon or by
15356 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15357 and the number of messages received in a single SMTP session exceeds this
15358 number, subsequent messages are placed on the queue, but no delivery processes
15359 are started. This helps to limit the number of Exim processes when a server
15360 restarts after downtime and there is a lot of mail waiting for it on other
15361 systems. On large systems, the default should probably be increased, and on
15362 dial-in client systems it should probably be set to zero (that is, disabled).
15363
15364
15365 .option smtp_accept_reserve main integer 0
15366 .cindex "SMTP" "incoming call count"
15367 .cindex "host" "reserved"
15368 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15369 number of SMTP connections that are reserved for connections from the hosts
15370 that are specified in &%smtp_reserve_hosts%&. The value set in
15371 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15372 restricted to this number of connections; the option specifies a minimum number
15373 of connection slots for them, not a maximum. It is a guarantee that this group
15374 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15375 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15376 individual host.
15377
15378 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15379 set to 5, once there are 45 active connections (from any hosts), new
15380 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15381 provided the other criteria for acceptance are met.
15382
15383
15384 .option smtp_active_hostname main string&!! unset
15385 .cindex "host" "name in SMTP responses"
15386 .cindex "SMTP" "host name in responses"
15387 .vindex "&$primary_hostname$&"
15388 This option is provided for multi-homed servers that want to masquerade as
15389 several different hosts. At the start of an incoming SMTP connection, its value
15390 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15391 responses. For example, it is used as domain name in the response to an
15392 incoming HELO or EHLO command.
15393
15394 .vindex "&$smtp_active_hostname$&"
15395 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15396 is saved with any messages that are received. It is therefore available for use
15397 in routers and transports when the message is later delivered.
15398
15399 If this option is unset, or if its expansion is forced to fail, or if the
15400 expansion results in an empty string, the value of &$primary_hostname$& is
15401 used. Other expansion failures cause a message to be written to the main and
15402 panic logs, and the SMTP command receives a temporary error. Typically, the
15403 value of &%smtp_active_hostname%& depends on the incoming interface address.
15404 For example:
15405 .code
15406 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15407   {cox.mydomain}{box.mydomain}}
15408 .endd
15409
15410 Although &$smtp_active_hostname$& is primarily concerned with incoming
15411 messages, it is also used as the default for HELO commands in callout
15412 verification if there is no remote transport from which to obtain a
15413 &%helo_data%& value.
15414
15415 .option smtp_banner main string&!! "see below"
15416 .cindex "SMTP" "welcome banner"
15417 .cindex "banner for SMTP"
15418 .cindex "welcome banner for SMTP"
15419 .cindex "customizing" "SMTP banner"
15420 This string, which is expanded every time it is used, is output as the initial
15421 positive response to an SMTP connection. The default setting is:
15422 .code
15423 smtp_banner = $smtp_active_hostname ESMTP Exim \
15424   $version_number $tod_full
15425 .endd
15426 Failure to expand the string causes a panic error. If you want to create a
15427 multiline response to the initial SMTP connection, use &"\n"& in the string at
15428 appropriate points, but not at the end. Note that the 220 code is not included
15429 in this string. Exim adds it automatically (several times in the case of a
15430 multiline response).
15431
15432
15433 .option smtp_check_spool_space main boolean true
15434 .cindex "checking disk space"
15435 .cindex "disk space, checking"
15436 .cindex "spool directory" "checking space"
15437 When this option is set, if an incoming SMTP session encounters the SIZE
15438 option on a MAIL command, it checks that there is enough space in the
15439 spool directory's partition to accept a message of that size, while still
15440 leaving free the amount specified by &%check_spool_space%& (even if that value
15441 is zero). If there isn't enough space, a temporary error code is returned.
15442
15443
15444 .option smtp_connect_backlog main integer 20
15445 .cindex "connection backlog"
15446 .cindex "SMTP" "connection backlog"
15447 .cindex "backlog of connections"
15448 This option specifies a maximum number of waiting SMTP connections. Exim passes
15449 this value to the TCP/IP system when it sets up its listener. Once this number
15450 of connections are waiting for the daemon's attention, subsequent connection
15451 attempts are refused at the TCP/IP level. At least, that is what the manuals
15452 say; in some circumstances such connection attempts have been observed to time
15453 out instead. For large systems it is probably a good idea to increase the
15454 value (to 50, say). It also gives some protection against denial-of-service
15455 attacks by SYN flooding.
15456
15457
15458 .option smtp_enforce_sync main boolean true
15459 .cindex "SMTP" "synchronization checking"
15460 .cindex "synchronization checking in SMTP"
15461 The SMTP protocol specification requires the client to wait for a response from
15462 the server at certain points in the dialogue. Without PIPELINING these
15463 synchronization points are after every command; with PIPELINING they are
15464 fewer, but they still exist.
15465
15466 Some spamming sites send out a complete set of SMTP commands without waiting
15467 for any response. Exim protects against this by rejecting a message if the
15468 client has sent further input when it should not have. The error response &"554
15469 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15470 for this error cannot be perfect because of transmission delays (unexpected
15471 input may be on its way but not yet received when Exim checks). However, it
15472 does detect many instances.
15473
15474 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15475 If you want to disable the check selectively (for example, only for certain
15476 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15477 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15478
15479
15480
15481 .option smtp_etrn_command main string&!! unset
15482 .cindex "ETRN" "command to be run"
15483 .vindex "&$domain$&"
15484 If this option is set, the given command is run whenever an SMTP ETRN
15485 command is received from a host that is permitted to issue such commands (see
15486 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15487 are independently expanded. The expansion variable &$domain$& is set to the
15488 argument of the ETRN command, and no syntax checking is done on it. For
15489 example:
15490 .code
15491 smtp_etrn_command = /etc/etrn_command $domain \
15492                     $sender_host_address
15493 .endd
15494 A new process is created to run the command, but Exim does not wait for it to
15495 complete. Consequently, its status cannot be checked. If the command cannot be
15496 run, a line is written to the panic log, but the ETRN caller still receives
15497 a 250 success response. Exim is normally running under its own uid when
15498 receiving SMTP, so it is not possible for it to change the uid before running
15499 the command.
15500
15501
15502 .option smtp_etrn_serialize main boolean true
15503 .cindex "ETRN" "serializing"
15504 When this option is set, it prevents the simultaneous execution of more than
15505 one identical command as a result of ETRN in an SMTP connection. See
15506 section &<<SECTETRN>>& for details.
15507
15508
15509 .option smtp_load_reserve main fixed-point unset
15510 .cindex "load average"
15511 If the system load average ever gets higher than this, incoming SMTP calls are
15512 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15513 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15514 the load is over the limit. The option has no effect on ancient operating
15515 systems on which Exim cannot determine the load average. See also
15516 &%deliver_queue_load_max%& and &%queue_only_load%&.
15517
15518
15519
15520 .option smtp_max_synprot_errors main integer 3
15521 .cindex "SMTP" "limiting syntax and protocol errors"
15522 .cindex "limit" "SMTP syntax and protocol errors"
15523 Exim rejects SMTP commands that contain syntax or protocol errors. In
15524 particular, a syntactically invalid email address, as in this command:
15525 .code
15526 RCPT TO:<abc xyz@a.b.c>
15527 .endd
15528 causes immediate rejection of the command, before any other tests are done.
15529 (The ACL cannot be run if there is no valid address to set up for it.) An
15530 example of a protocol error is receiving RCPT before MAIL. If there are
15531 too many syntax or protocol errors in one SMTP session, the connection is
15532 dropped. The limit is set by this option.
15533
15534 .cindex "PIPELINING" "expected errors"
15535 When the PIPELINING extension to SMTP is in use, some protocol errors are
15536 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15537 Exim assumes that PIPELINING will be used if it advertises it (see
15538 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15539 not count towards the limit.
15540
15541
15542
15543 .option smtp_max_unknown_commands main integer 3
15544 .cindex "SMTP" "limiting unknown commands"
15545 .cindex "limit" "unknown SMTP commands"
15546 If there are too many unrecognized commands in an incoming SMTP session, an
15547 Exim server drops the connection. This is a defence against some kinds of abuse
15548 that subvert web
15549 clients
15550 into making connections to SMTP ports; in these circumstances, a number of
15551 non-SMTP command lines are sent first.
15552
15553
15554
15555 .option smtp_ratelimit_hosts main "host list&!!" unset
15556 .cindex "SMTP" "rate limiting"
15557 .cindex "limit" "rate of message arrival"
15558 .cindex "RCPT" "rate limiting"
15559 Some sites find it helpful to be able to limit the rate at which certain hosts
15560 can send them messages, and the rate at which an individual message can specify
15561 recipients.
15562
15563 Exim has two rate-limiting facilities. This section describes the older
15564 facility, which can limit rates within a single connection. The newer
15565 &%ratelimit%& ACL condition can limit rates across all connections. See section
15566 &<<SECTratelimiting>>& for details of the newer facility.
15567
15568 When a host matches &%smtp_ratelimit_hosts%&, the values of
15569 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15570 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15571 respectively. Each option, if set, must contain a set of four comma-separated
15572 values:
15573
15574 .ilist
15575 A threshold, before which there is no rate limiting.
15576 .next
15577 An initial time delay. Unlike other times in Exim, numbers with decimal
15578 fractional parts are allowed here.
15579 .next
15580 A factor by which to increase the delay each time.
15581 .next
15582 A maximum value for the delay. This should normally be less than 5 minutes,
15583 because after that time, the client is liable to timeout the SMTP command.
15584 .endlist
15585
15586 For example, these settings have been used successfully at the site which
15587 first suggested this feature, for controlling mail from their customers:
15588 .code
15589 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15590 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15591 .endd
15592 The first setting specifies delays that are applied to MAIL commands after
15593 two have been received over a single connection. The initial delay is 0.5
15594 seconds, increasing by a factor of 1.05 each time. The second setting applies
15595 delays to RCPT commands when more than four occur in a single message.
15596
15597
15598 .option smtp_ratelimit_mail main string unset
15599 See &%smtp_ratelimit_hosts%& above.
15600
15601
15602 .option smtp_ratelimit_rcpt main string unset
15603 See &%smtp_ratelimit_hosts%& above.
15604
15605
15606 .option smtp_receive_timeout main time 5m
15607 .cindex "timeout" "for SMTP input"
15608 .cindex "SMTP" "input timeout"
15609 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15610 input, including batch SMTP. If a line of input (either an SMTP command or a
15611 data line) is not received within this time, the SMTP connection is dropped and
15612 the message is abandoned.
15613 A line is written to the log containing one of the following messages:
15614 .code
15615 SMTP command timeout on connection from...
15616 SMTP data timeout on connection from...
15617 .endd
15618 The former means that Exim was expecting to read an SMTP command; the latter
15619 means that it was in the DATA phase, reading the contents of a message.
15620
15621
15622 .oindex "&%-os%&"
15623 The value set by this option can be overridden by the
15624 &%-os%& command-line option. A setting of zero time disables the timeout, but
15625 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15626 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15627 timeout is controlled by &%receive_timeout%& and &%-or%&.
15628
15629
15630 .option smtp_reserve_hosts main "host list&!!" unset
15631 This option defines hosts for which SMTP connections are reserved; see
15632 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15633
15634
15635 .option smtp_return_error_details main boolean false
15636 .cindex "SMTP" "details policy failures"
15637 .cindex "policy control" "rejection, returning details"
15638 In the default state, Exim uses bland messages such as
15639 &"Administrative prohibition"& when it rejects SMTP commands for policy
15640 reasons. Many sysadmins like this because it gives away little information
15641 to spammers. However, some other sysadmins who are applying strict checking
15642 policies want to give out much fuller information about failures. Setting
15643 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15644 example, instead of &"Administrative prohibition"&, it might give:
15645 .code
15646 550-Rejected after DATA: '>' missing at end of address:
15647 550 failing address in "From" header is: <user@dom.ain
15648 .endd
15649
15650 .option spamd_address main string "see below"
15651 This option is available when Exim is compiled with the content-scanning
15652 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15653 The default value is
15654 .code
15655 127.0.0.1 783
15656 .endd
15657 See section &<<SECTscanspamass>>& for more details.
15658
15659
15660
15661 .option split_spool_directory main boolean false
15662 .cindex "multiple spool directories"
15663 .cindex "spool directory" "split"
15664 .cindex "directories, multiple"
15665 If this option is set, it causes Exim to split its input directory into 62
15666 subdirectories, each with a single alphanumeric character as its name. The
15667 sixth character of the message id is used to allocate messages to
15668 subdirectories; this is the least significant base-62 digit of the time of
15669 arrival of the message.
15670
15671 Splitting up the spool in this way may provide better performance on systems
15672 where there are long mail queues, by reducing the number of files in any one
15673 directory. The msglog directory is also split up in a similar way to the input
15674 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15675 are still placed in the single directory &_msglog.OLD_&.
15676
15677 It is not necessary to take any special action for existing messages when
15678 changing &%split_spool_directory%&. Exim notices messages that are in the
15679 &"wrong"& place, and continues to process them. If the option is turned off
15680 after a period of being on, the subdirectories will eventually empty and be
15681 automatically deleted.
15682
15683 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15684 changes. Instead of creating a list of all messages in the queue, and then
15685 trying to deliver each one in turn, it constructs a list of those in one
15686 sub-directory and tries to deliver them, before moving on to the next
15687 sub-directory. The sub-directories are processed in a random order. This
15688 spreads out the scanning of the input directories, and uses less memory. It is
15689 particularly beneficial when there are lots of messages on the queue. However,
15690 if &%queue_run_in_order%& is set, none of this new processing happens. The
15691 entire queue has to be scanned and sorted before any deliveries can start.
15692
15693
15694 .option spool_directory main string&!! "set at compile time"
15695 .cindex "spool directory" "path to"
15696 This defines the directory in which Exim keeps its spool, that is, the messages
15697 it is waiting to deliver. The default value is taken from the compile-time
15698 configuration setting, if there is one. If not, this option must be set. The
15699 string is expanded, so it can contain, for example, a reference to
15700 &$primary_hostname$&.
15701
15702 If the spool directory name is fixed on your installation, it is recommended
15703 that you set it at build time rather than from this option, particularly if the
15704 log files are being written to the spool directory (see &%log_file_path%&).
15705 Otherwise log files cannot be used for errors that are detected early on, such
15706 as failures in the configuration file.
15707
15708 By using this option to override the compiled-in path, it is possible to run
15709 tests of Exim without using the standard spool.
15710
15711 .option sqlite_lock_timeout main time 5s
15712 .cindex "sqlite lookup type" "lock timeout"
15713 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15714 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15715
15716 .option strict_acl_vars main boolean false
15717 .cindex "&ACL;" "variables, handling unset"
15718 This option controls what happens if a syntactically valid but undefined ACL
15719 variable is referenced. If it is false (the default), an empty string
15720 is substituted; if it is true, an error is generated. See section
15721 &<<SECTaclvariables>>& for details of ACL variables.
15722
15723 .option strip_excess_angle_brackets main boolean false
15724 .cindex "angle brackets, excess"
15725 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15726 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15727 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15728 passed on to another MTA, the excess angle brackets are not passed on. If this
15729 option is not set, multiple pairs of angle brackets cause a syntax error.
15730
15731
15732 .option strip_trailing_dot main boolean false
15733 .cindex "trailing dot on domain"
15734 .cindex "dot" "trailing on domain"
15735 If this option is set, a trailing dot at the end of a domain in an address is
15736 ignored. If this is in the envelope and the message is passed on to another
15737 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15738 domain causes a syntax error.
15739 However, addresses in header lines are checked only when an ACL requests header
15740 syntax checking.
15741
15742
15743 .option syslog_duplication main boolean true
15744 .cindex "syslog" "duplicate log lines; suppressing"
15745 When Exim is logging to syslog, it writes the log lines for its three
15746 separate logs at different syslog priorities so that they can in principle
15747 be separated on the logging hosts. Some installations do not require this
15748 separation, and in those cases, the duplication of certain log lines is a
15749 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15750 particular log line is written to syslog. For lines that normally go to
15751 both the main log and the reject log, the reject log version (possibly
15752 containing message header lines) is written, at LOG_NOTICE priority.
15753 Lines that normally go to both the main and the panic log are written at
15754 the LOG_ALERT priority.
15755
15756
15757 .option syslog_facility main string unset
15758 .cindex "syslog" "facility; setting"
15759 This option sets the syslog &"facility"& name, used when Exim is logging to
15760 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15761 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15762 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15763 details of Exim's logging.
15764
15765
15766
15767 .option syslog_processname main string &`exim`&
15768 .cindex "syslog" "process name; setting"
15769 This option sets the syslog &"ident"& name, used when Exim is logging to
15770 syslog. The value must be no longer than 32 characters. See chapter
15771 &<<CHAPlog>>& for details of Exim's logging.
15772
15773
15774
15775 .option syslog_timestamp main boolean true
15776 .cindex "syslog" "timestamps"
15777 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15778 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15779 details of Exim's logging.
15780
15781
15782 .option system_filter main string&!! unset
15783 .cindex "filter" "system filter"
15784 .cindex "system filter" "specifying"
15785 .cindex "Sieve filter" "not available for system filter"
15786 This option specifies an Exim filter file that is applied to all messages at
15787 the start of each delivery attempt, before any routing is done. System filters
15788 must be Exim filters; they cannot be Sieve filters. If the system filter
15789 generates any deliveries to files or pipes, or any new mail messages, the
15790 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15791 which transports are to be used. Details of this facility are given in chapter
15792 &<<CHAPsystemfilter>>&.
15793
15794
15795 .option system_filter_directory_transport main string&!! unset
15796 .vindex "&$address_file$&"
15797 This sets the name of the transport driver that is to be used when the
15798 &%save%& command in a system message filter specifies a path ending in &"/"&,
15799 implying delivery of each message into a separate file in some directory.
15800 During the delivery, the variable &$address_file$& contains the path name.
15801
15802
15803 .option system_filter_file_transport main string&!! unset
15804 .cindex "file" "transport for system filter"
15805 This sets the name of the transport driver that is to be used when the &%save%&
15806 command in a system message filter specifies a path not ending in &"/"&. During
15807 the delivery, the variable &$address_file$& contains the path name.
15808
15809 .option system_filter_group main string unset
15810 .cindex "gid (group id)" "system filter"
15811 This option is used only when &%system_filter_user%& is also set. It sets the
15812 gid under which the system filter is run, overriding any gid that is associated
15813 with the user. The value may be numerical or symbolic.
15814
15815 .option system_filter_pipe_transport main string&!! unset
15816 .cindex "&(pipe)& transport" "for system filter"
15817 .vindex "&$address_pipe$&"
15818 This specifies the transport driver that is to be used when a &%pipe%& command
15819 is used in a system filter. During the delivery, the variable &$address_pipe$&
15820 contains the pipe command.
15821
15822
15823 .option system_filter_reply_transport main string&!! unset
15824 .cindex "&(autoreply)& transport" "for system filter"
15825 This specifies the transport driver that is to be used when a &%mail%& command
15826 is used in a system filter.
15827
15828
15829 .option system_filter_user main string unset
15830 .cindex "uid (user id)" "system filter"
15831 If this option is set to root, the system filter is run in the main Exim
15832 delivery process, as root.  Otherwise, the system filter runs in a separate
15833 process, as the given user, defaulting to the Exim run-time user.
15834 Unless the string consists entirely of digits, it
15835 is looked up in the password data. Failure to find the named user causes a
15836 configuration error. The gid is either taken from the password data, or
15837 specified by &%system_filter_group%&. When the uid is specified numerically,
15838 &%system_filter_group%& is required to be set.
15839
15840 If the system filter generates any pipe, file, or reply deliveries, the uid
15841 under which the filter is run is used when transporting them, unless a
15842 transport option overrides.
15843
15844
15845 .option tcp_nodelay main boolean true
15846 .cindex "daemon" "TCP_NODELAY on sockets"
15847 .cindex "Nagle algorithm"
15848 .cindex "TCP_NODELAY on listening sockets"
15849 If this option is set false, it stops the Exim daemon setting the
15850 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15851 turns off the &"Nagle algorithm"&, which is a way of improving network
15852 performance in interactive (character-by-character) situations. Turning it off
15853 should improve Exim's performance a bit, so that is what happens by default.
15854 However, it appears that some broken clients cannot cope, and time out. Hence
15855 this option. It affects only those sockets that are set up for listening by the
15856 daemon. Sockets created by the smtp transport for delivering mail always set
15857 TCP_NODELAY.
15858
15859
15860 .option timeout_frozen_after main time 0s
15861 .cindex "frozen messages" "timing out"
15862 .cindex "timeout" "frozen messages"
15863 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15864 message of any kind that has been on the queue for longer than the given time
15865 is automatically cancelled at the next queue run. If the frozen message is a
15866 bounce message, it is just discarded; otherwise, a bounce is sent to the
15867 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15868 If you want to timeout frozen bounce messages earlier than other kinds of
15869 frozen message, see &%ignore_bounce_errors_after%&.
15870
15871 &*Note:*& the default value of zero means no timeouts; with this setting,
15872 frozen messages remain on the queue forever (except for any frozen bounce
15873 messages that are released by &%ignore_bounce_errors_after%&).
15874
15875
15876 .option timezone main string unset
15877 .cindex "timezone, setting"
15878 The value of &%timezone%& is used to set the environment variable TZ while
15879 running Exim (if it is different on entry). This ensures that all timestamps
15880 created by Exim are in the required timezone. If you want all your timestamps
15881 to be in UTC (aka GMT) you should set
15882 .code
15883 timezone = UTC
15884 .endd
15885 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15886 or, if that is not set, from the value of the TZ environment variable when Exim
15887 is built. If &%timezone%& is set to the empty string, either at build or run
15888 time, any existing TZ variable is removed from the environment when Exim
15889 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15890 unfortunately not all, operating systems.
15891
15892
15893 .option tls_advertise_hosts main "host list&!!" unset
15894 .cindex "TLS" "advertising"
15895 .cindex "encryption" "on SMTP connection"
15896 .cindex "SMTP" "encrypted connection"
15897 When Exim is built with support for TLS encrypted connections, the availability
15898 of the STARTTLS command to set up an encrypted session is advertised in
15899 response to EHLO only to those client hosts that match this option. See
15900 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15901
15902
15903 .option tls_certificate main string&!! unset
15904 .cindex "TLS" "server certificate; location of"
15905 .cindex "certificate" "server, location of"
15906 The value of this option is expanded, and must then be the absolute path to a
15907 file which contains the server's certificates. The server's private key is also
15908 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15909 &<<CHAPTLS>>& for further details.
15910
15911 &*Note*&: The certificates defined by this option are used only when Exim is
15912 receiving incoming messages as a server. If you want to supply certificates for
15913 use when sending messages as a client, you must set the &%tls_certificate%&
15914 option in the relevant &(smtp)& transport.
15915
15916 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15917 if the OpenSSL build supports TLS extensions and the TLS client sends the
15918 Server Name Indication extension, then this option and others documented in
15919 &<<SECTtlssni>>& will be re-expanded.
15920
15921 .option tls_crl main string&!! unset
15922 .cindex "TLS" "server certificate revocation list"
15923 .cindex "certificate" "revocation list for server"
15924 This option specifies a certificate revocation list. The expanded value must
15925 be the name of a file that contains a CRL in PEM format.
15926
15927 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15928
15929
15930 .option tls_dh_max_bits main integer 2236
15931 .cindex "TLS" "D-H bit count"
15932 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15933 the chosen TLS library.  That value might prove to be too high for
15934 interoperability.  This option provides a maximum clamp on the value
15935 suggested, trading off security for interoperability.
15936
15937 The value must be at least 1024.
15938
15939 The value 2236 was chosen because, at time of adding the option, it was the
15940 hard-coded maximum value supported by the NSS cryptographic library, as used
15941 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15942
15943 If you prefer more security and are willing to break some clients, raise this
15944 number.
15945
15946 Note that the value passed to GnuTLS for *generating* a new prime may be a
15947 little less than this figure, because GnuTLS is inexact and may produce a
15948 larger prime than requested.
15949
15950
15951 .option tls_dhparam main string&!! unset
15952 .cindex "TLS" "D-H parameters for server"
15953 The value of this option is expanded and indicates the source of DH parameters
15954 to be used by Exim.
15955
15956 If it is a filename starting with a &`/`&, then it names a file from which DH
15957 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15958 PKCS#3 representation of the DH prime.  If the file does not exist, for
15959 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15960 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15961 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15962 and treated as though the &%tls_dhparam%& were set to "none".
15963
15964 If this option expands to the string "none", then no DH parameters will be
15965 loaded by Exim.
15966
15967 If this option expands to the string "historic" and Exim is using GnuTLS, then
15968 Exim will attempt to load a file from inside the spool directory.  If the file
15969 does not exist, Exim will attempt to create it.
15970 See section &<<SECTgnutlsparam>>& for further details.
15971
15972 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15973 a default DH prime; the default is the 2048 bit prime described in section
15974 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15975 in IKE is assigned number 23.
15976
15977 Otherwise, the option must expand to the name used by Exim for any of a number
15978 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15979 "ike" followed by the number used by IKE, of "default" which corresponds to
15980 "ike23".
15981
15982 The available primes are:
15983 &`ike1`&, &`ike2`&, &`ike5`&,
15984 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15985 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15986
15987 Some of these will be too small to be accepted by clients.
15988 Some may be too large to be accepted by clients.
15989
15990
15991 .option tls_on_connect_ports main "string list" unset
15992 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15993 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15994 set up without waiting for the client to issue a STARTTLS command. For
15995 further details, see section &<<SECTsupobssmt>>&.
15996
15997
15998
15999 .option tls_privatekey main string&!! unset
16000 .cindex "TLS" "server private key; location of"
16001 The value of this option is expanded, and must then be the absolute path to a
16002 file which contains the server's private key. If this option is unset, or if
16003 the expansion is forced to fail, or the result is an empty string, the private
16004 key is assumed to be in the same file as the server's certificates. See chapter
16005 &<<CHAPTLS>>& for further details.
16006
16007 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16008
16009
16010 .option tls_remember_esmtp main boolean false
16011 .cindex "TLS" "esmtp state; remembering"
16012 .cindex "TLS" "broken clients"
16013 If this option is set true, Exim violates the RFCs by remembering that it is in
16014 &"esmtp"& state after successfully negotiating a TLS session. This provides
16015 support for broken clients that fail to send a new EHLO after starting a
16016 TLS session.
16017
16018
16019 .option tls_require_ciphers main string&!! unset
16020 .cindex "TLS" "requiring specific ciphers"
16021 .cindex "cipher" "requiring specific"
16022 This option controls which ciphers can be used for incoming TLS connections.
16023 The &(smtp)& transport has an option of the same name for controlling outgoing
16024 connections. This option is expanded for each connection, so can be varied for
16025 different clients if required. The value of this option must be a list of
16026 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16027 in somewhat different ways. If GnuTLS is being used, the client controls the
16028 preference order of the available ciphers. Details are given in sections
16029 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16030
16031
16032 .option tls_try_verify_hosts main "host list&!!" unset
16033 .cindex "TLS" "client certificate verification"
16034 .cindex "certificate" "verification of client"
16035 See &%tls_verify_hosts%& below.
16036
16037
16038 .option tls_verify_certificates main string&!! unset
16039 .cindex "TLS" "client certificate verification"
16040 .cindex "certificate" "verification of client"
16041 The value of this option is expanded, and must then be the absolute path to
16042 a file containing permitted certificates for clients that
16043 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16044 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16045 directory containing certificate files. This does not work with GnuTLS; the
16046 option must be set to the name of a single file if you are using GnuTLS.
16047
16048 These certificates should be for the certificate authorities trusted, rather
16049 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16050 the value is a file then the certificates are sent by Exim as a server to
16051 connecting clients, defining the list of accepted certificate authorities.
16052 Thus the values defined should be considered public data.  To avoid this,
16053 use OpenSSL with a directory.
16054
16055 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16056
16057
16058 .option tls_verify_hosts main "host list&!!" unset
16059 .cindex "TLS" "client certificate verification"
16060 .cindex "certificate" "verification of client"
16061 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16062 certificates from clients. The expected certificates are defined by
16063 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16064 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16065 &%tls_verify_certificates%& is not set.
16066
16067 Any client that matches &%tls_verify_hosts%& is constrained by
16068 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16069 present one of the listed certificates. If it does not, the connection is
16070 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16071 the host to use TLS. It can still send SMTP commands through unencrypted
16072 connections. Forcing a client to use TLS has to be done separately using an
16073 ACL to reject inappropriate commands when the connection is not encrypted.
16074
16075 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16076 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16077 certificate and checks it against &%tls_verify_certificates%&, but does not
16078 abort the connection if there is no certificate or if it does not match. This
16079 state can be detected in an ACL, which makes it possible to implement policies
16080 such as &"accept for relay only if a verified certificate has been received,
16081 but accept for local delivery if encrypted, even without a verified
16082 certificate"&.
16083
16084 Client hosts that match neither of these lists are not asked to present
16085 certificates.
16086
16087
16088 .option trusted_groups main "string list&!!" unset
16089 .cindex "trusted groups"
16090 .cindex "groups" "trusted"
16091 This option is expanded just once, at the start of Exim's processing. If this
16092 option is set, any process that is running in one of the listed groups, or
16093 which has one of them as a supplementary group, is trusted. The groups can be
16094 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16095 details of what trusted callers are permitted to do. If neither
16096 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16097 are trusted.
16098
16099 .option trusted_users main "string list&!!" unset
16100 .cindex "trusted users"
16101 .cindex "user" "trusted"
16102 This option is expanded just once, at the start of Exim's processing. If this
16103 option is set, any process that is running as one of the listed users is
16104 trusted. The users can be specified numerically or by name. See section
16105 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16106 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16107 Exim user are trusted.
16108
16109 .option unknown_login main string&!! unset
16110 .cindex "uid (user id)" "unknown caller"
16111 .vindex "&$caller_uid$&"
16112 This is a specialized feature for use in unusual configurations. By default, if
16113 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16114 gives up. The &%unknown_login%& option can be used to set a login name to be
16115 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16116 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16117 is used for the user's real name (gecos field), unless this has been set by the
16118 &%-F%& option.
16119
16120 .option unknown_username main string unset
16121 See &%unknown_login%&.
16122
16123 .option untrusted_set_sender main "address list&!!" unset
16124 .cindex "trusted users"
16125 .cindex "sender" "setting by untrusted user"
16126 .cindex "untrusted user setting sender"
16127 .cindex "user" "untrusted setting sender"
16128 .cindex "envelope sender"
16129 When an untrusted user submits a message to Exim using the standard input, Exim
16130 normally creates an envelope sender address from the user's login and the
16131 default qualification domain. Data from the &%-f%& option (for setting envelope
16132 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16133 is used) is ignored.
16134
16135 However, untrusted users are permitted to set an empty envelope sender address,
16136 to declare that a message should never generate any bounces. For example:
16137 .code
16138 exim -f '<>' user@domain.example
16139 .endd
16140 .vindex "&$sender_ident$&"
16141 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16142 other envelope sender addresses in a controlled way. When it is set, untrusted
16143 users are allowed to set envelope sender addresses that match any of the
16144 patterns in the list. Like all address lists, the string is expanded. The
16145 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16146 users to setting senders that start with their login ids
16147 followed by a hyphen
16148 by a setting like this:
16149 .code
16150 untrusted_set_sender = ^$sender_ident-
16151 .endd
16152 If you want to allow untrusted users to set envelope sender addresses without
16153 restriction, you can use
16154 .code
16155 untrusted_set_sender = *
16156 .endd
16157 The &%untrusted_set_sender%& option applies to all forms of local input, but
16158 only to the setting of the envelope sender. It does not permit untrusted users
16159 to use the other options which trusted user can use to override message
16160 parameters. Furthermore, it does not stop Exim from removing an existing
16161 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16162 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16163 overriding these actions. The handling of the &'Sender:'& header is also
16164 described in section &<<SECTthesenhea>>&.
16165
16166 The log line for a message's arrival shows the envelope sender following
16167 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16168 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16169 envelope sender address, the user's login is shown in parentheses after the
16170 sender address.
16171
16172
16173 .option uucp_from_pattern main string "see below"
16174 .cindex "&""From""& line"
16175 .cindex "UUCP" "&""From""& line"
16176 Some applications that pass messages to an MTA via a command line interface use
16177 an initial line starting with &"From&~"& to pass the envelope sender. In
16178 particular, this is used by UUCP software. Exim recognizes such a line by means
16179 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16180 matches, the sender address is constructed by expanding the contents of
16181 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16182 default pattern recognizes lines in the following two forms:
16183 .code
16184 From ph10 Fri Jan  5 12:35 GMT 1996
16185 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16186 .endd
16187 The pattern can be seen by running
16188 .code
16189 exim -bP uucp_from_pattern
16190 .endd
16191 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16192 year in the second case. The first word after &"From&~"& is matched in the
16193 regular expression by a parenthesized subpattern. The default value for
16194 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16195 (&"ph10"& in the example above) as the message's sender. See also
16196 &%ignore_fromline_hosts%&.
16197
16198
16199 .option uucp_from_sender main string&!! &`$1`&
16200 See &%uucp_from_pattern%& above.
16201
16202
16203 .option warn_message_file main string unset
16204 .cindex "warning of delay" "customizing the message"
16205 .cindex "customizing" "warning message"
16206 This option defines a template file containing paragraphs of text to be used
16207 for constructing the warning message which is sent by Exim when a message has
16208 been on the queue for a specified amount of time, as specified by
16209 &%delay_warning%&. Details of the file's contents are given in chapter
16210 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16211
16212
16213 .option write_rejectlog main boolean true
16214 .cindex "reject log" "disabling"
16215 If this option is set false, Exim no longer writes anything to the reject log.
16216 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16217 .ecindex IIDconfima
16218 .ecindex IIDmaiconf
16219
16220
16221
16222
16223 . ////////////////////////////////////////////////////////////////////////////
16224 . ////////////////////////////////////////////////////////////////////////////
16225
16226 .chapter "Generic options for routers" "CHAProutergeneric"
16227 .scindex IIDgenoprou1 "options" "generic; for routers"
16228 .scindex IIDgenoprou2 "generic options" "router"
16229 This chapter describes the generic options that apply to all routers.
16230 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16231
16232 For a general description of how a router operates, see sections
16233 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16234 which the preconditions are tested. The order of expansion of the options that
16235 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16236 &%headers_remove%&, &%transport%&.
16237
16238
16239
16240 .option address_data routers string&!! unset
16241 .cindex "router" "data attached to address"
16242 The string is expanded just before the router is run, that is, after all the
16243 precondition tests have succeeded. If the expansion is forced to fail, the
16244 router declines, the value of &%address_data%& remains unchanged, and the
16245 &%more%& option controls what happens next. Other expansion failures cause
16246 delivery of the address to be deferred.
16247
16248 .vindex "&$address_data$&"
16249 When the expansion succeeds, the value is retained with the address, and can be
16250 accessed using the variable &$address_data$& in the current router, subsequent
16251 routers, and the eventual transport.
16252
16253 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16254 that runs a user's filter file, the contents of &$address_data$& are accessible
16255 in the filter. This is not normally a problem, because such data is usually
16256 either not confidential or it &"belongs"& to the current user, but if you do
16257 put confidential data into &$address_data$& you need to remember this point.
16258
16259 Even if the router declines or passes, the value of &$address_data$& remains
16260 with the address, though it can be changed by another &%address_data%& setting
16261 on a subsequent router. If a router generates child addresses, the value of
16262 &$address_data$& propagates to them. This also applies to the special kind of
16263 &"child"& that is generated by a router with the &%unseen%& option.
16264
16265 The idea of &%address_data%& is that you can use it to look up a lot of data
16266 for the address once, and then pick out parts of the data later. For example,
16267 you could use a single LDAP lookup to return a string of the form
16268 .code
16269 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16270 .endd
16271 In the transport you could pick out the mailbox by a setting such as
16272 .code
16273 file = ${extract{mailbox}{$address_data}}
16274 .endd
16275 This makes the configuration file less messy, and also reduces the number of
16276 lookups (though Exim does cache lookups).
16277
16278 .vindex "&$sender_address_data$&"
16279 .vindex "&$address_data$&"
16280 The &%address_data%& facility is also useful as a means of passing information
16281 from one router to another, and from a router to a transport. In addition, if
16282 &$address_data$& is set by a router when verifying a recipient address from an
16283 ACL, it remains available for use in the rest of the ACL statement. After
16284 verifying a sender, the value is transferred to &$sender_address_data$&.
16285
16286
16287
16288 .option address_test routers&!? boolean true
16289 .oindex "&%-bt%&"
16290 .cindex "router" "skipping when address testing"
16291 If this option is set false, the router is skipped when routing is being tested
16292 by means of the &%-bt%& command line option. This can be a convenience when
16293 your first router sends messages to an external scanner, because it saves you
16294 having to set the &"already scanned"& indicator when testing real address
16295 routing.
16296
16297
16298
16299 .option cannot_route_message routers string&!! unset
16300 .cindex "router" "customizing &""cannot route""& message"
16301 .cindex "customizing" "&""cannot route""& message"
16302 This option specifies a text message that is used when an address cannot be
16303 routed because Exim has run out of routers. The default message is
16304 &"Unrouteable address"&. This option is useful only on routers that have
16305 &%more%& set false, or on the very last router in a configuration, because the
16306 value that is used is taken from the last router that is considered. This
16307 includes a router that is skipped because its preconditions are not met, as
16308 well as a router that declines. For example, using the default configuration,
16309 you could put:
16310 .code
16311 cannot_route_message = Remote domain not found in DNS
16312 .endd
16313 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16314 and
16315 .code
16316 cannot_route_message = Unknown local user
16317 .endd
16318 on the final router that checks for local users. If string expansion fails for
16319 this option, the default message is used. Unless the expansion failure was
16320 explicitly forced, a message about the failure is written to the main and panic
16321 logs, in addition to the normal message about the routing failure.
16322
16323
16324 .option caseful_local_part routers boolean false
16325 .cindex "case of local parts"
16326 .cindex "router" "case of local parts"
16327 By default, routers handle the local parts of addresses in a case-insensitive
16328 manner, though the actual case is preserved for transmission with the message.
16329 If you want the case of letters to be significant in a router, you must set
16330 this option true. For individual router options that contain address or local
16331 part lists (for example, &%local_parts%&), case-sensitive matching can be
16332 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16333 more details.
16334
16335 .vindex "&$local_part$&"
16336 .vindex "&$original_local_part$&"
16337 .vindex "&$parent_local_part$&"
16338 The value of the &$local_part$& variable is forced to lower case while a
16339 router is running unless &%caseful_local_part%& is set. When a router assigns
16340 an address to a transport, the value of &$local_part$& when the transport runs
16341 is the same as it was in the router. Similarly, when a router generates child
16342 addresses by aliasing or forwarding, the values of &$original_local_part$&
16343 and &$parent_local_part$& are those that were used by the redirecting router.
16344
16345 This option applies to the processing of an address by a router. When a
16346 recipient address is being processed in an ACL, there is a separate &%control%&
16347 modifier that can be used to specify case-sensitive processing within the ACL
16348 (see section &<<SECTcontrols>>&).
16349
16350
16351
16352 .option check_local_user routers&!? boolean false
16353 .cindex "local user, checking in router"
16354 .cindex "router" "checking for local user"
16355 .cindex "&_/etc/passwd_&"
16356 .vindex "&$home$&"
16357 When this option is true, Exim checks that the local part of the recipient
16358 address (with affixes removed if relevant) is the name of an account on the
16359 local system. The check is done by calling the &[getpwnam()]& function rather
16360 than trying to read &_/etc/passwd_& directly. This means that other methods of
16361 holding password data (such as NIS) are supported. If the local part is a local
16362 user, &$home$& is set from the password data, and can be tested in other
16363 preconditions that are evaluated after this one (the order of evaluation is
16364 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16365 overridden by &%router_home_directory%&. If the local part is not a local user,
16366 the router is skipped.
16367
16368 If you want to check that the local part is either the name of a local user
16369 or matches something else, you cannot combine &%check_local_user%& with a
16370 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16371 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16372 setting to achieve this. For example:
16373 .code
16374 local_parts = passwd;$local_part : lsearch;/etc/other/users
16375 .endd
16376 Note, however, that the side effects of &%check_local_user%& (such as setting
16377 up a home directory) do not occur when a &(passwd)& lookup is used in a
16378 &%local_parts%& (or any other) precondition.
16379
16380
16381
16382 .option condition routers&!? string&!! unset
16383 .cindex "router" "customized precondition"
16384 This option specifies a general precondition test that has to succeed for the
16385 router to be called. The &%condition%& option is the last precondition to be
16386 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16387 result is a forced failure, or an empty string, or one of the strings &"0"& or
16388 &"no"& or &"false"& (checked without regard to the case of the letters), the
16389 router is skipped, and the address is offered to the next one.
16390
16391 If the result is any other value, the router is run (as this is the last
16392 precondition to be evaluated, all the other preconditions must be true).
16393
16394 This option is unusual in that multiple &%condition%& options may be present.
16395 All &%condition%& options must succeed.
16396
16397 The &%condition%& option provides a means of applying custom conditions to the
16398 running of routers. Note that in the case of a simple conditional expansion,
16399 the default expansion values are exactly what is wanted. For example:
16400 .code
16401 condition = ${if >{$message_age}{600}}
16402 .endd
16403 Because of the default behaviour of the string expansion, this is equivalent to
16404 .code
16405 condition = ${if >{$message_age}{600}{true}{}}
16406 .endd
16407
16408 A multiple condition example, which succeeds:
16409 .code
16410 condition = ${if >{$message_age}{600}}
16411 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16412 condition = foobar
16413 .endd
16414
16415 If the expansion fails (other than forced failure) delivery is deferred. Some
16416 of the other precondition options are common special cases that could in fact
16417 be specified using &%condition%&.
16418
16419
16420 .option debug_print routers string&!! unset
16421 .cindex "testing" "variables in drivers"
16422 If this option is set and debugging is enabled (see the &%-d%& command line
16423 option), the string is expanded and included in the debugging output.
16424 If expansion of the string fails, the error message is written to the debugging
16425 output, and Exim carries on processing.
16426 This option is provided to help with checking out the values of variables and
16427 so on when debugging router configurations. For example, if a &%condition%&
16428 option appears not to be working, &%debug_print%& can be used to output the
16429 variables it references. The output happens after checks for &%domains%&,
16430 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16431 are tested. A newline is added to the text if it does not end with one.
16432
16433
16434
16435 .option disable_logging routers boolean false
16436 If this option is set true, nothing is logged for any routing errors
16437 or for any deliveries caused by this router. You should not set this option
16438 unless you really, really know what you are doing. See also the generic
16439 transport option of the same name.
16440
16441
16442 .option domains routers&!? "domain list&!!" unset
16443 .cindex "router" "restricting to specific domains"
16444 .vindex "&$domain_data$&"
16445 If this option is set, the router is skipped unless the current domain matches
16446 the list. If the match is achieved by means of a file lookup, the data that the
16447 lookup returned for the domain is placed in &$domain_data$& for use in string
16448 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16449 a list of the order in which preconditions are evaluated.
16450
16451
16452
16453 .option driver routers string unset
16454 This option must always be set. It specifies which of the available routers is
16455 to be used.
16456
16457
16458
16459 .option errors_to routers string&!! unset
16460 .cindex "envelope sender"
16461 .cindex "router" "changing address for errors"
16462 If a router successfully handles an address, it may assign the address to a
16463 transport for delivery or it may generate child addresses. In both cases, if
16464 there is a delivery problem during later processing, the resulting bounce
16465 message is sent to the address that results from expanding this string,
16466 provided that the address verifies successfully. The &%errors_to%& option is
16467 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16468
16469 The &%errors_to%& setting associated with an address can be overridden if it
16470 subsequently passes through other routers that have their own &%errors_to%&
16471 settings, or if the message is delivered by a transport with a &%return_path%&
16472 setting.
16473
16474 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16475 the expansion fails to verify, the errors address associated with the incoming
16476 address is used. At top level, this is the envelope sender. A non-forced
16477 expansion failure causes delivery to be deferred.
16478
16479 If an address for which &%errors_to%& has been set ends up being delivered over
16480 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16481 any bounces that are generated by other MTAs on the delivery route are also
16482 sent there. You can set &%errors_to%& to the empty string by either of these
16483 settings:
16484 .code
16485 errors_to =
16486 errors_to = ""
16487 .endd
16488 An expansion item that yields an empty string has the same effect. If you do
16489 this, a locally detected delivery error for addresses processed by this router
16490 no longer gives rise to a bounce message; the error is discarded. If the
16491 address is delivered to a remote host, the return path is set to &`<>`&, unless
16492 overridden by the &%return_path%& option on the transport.
16493
16494 .vindex "&$address_data$&"
16495 If for some reason you want to discard local errors, but use a non-empty
16496 MAIL command for remote delivery, you can preserve the original return
16497 path in &$address_data$& in the router, and reinstate it in the transport by
16498 setting &%return_path%&.
16499
16500 The most common use of &%errors_to%& is to direct mailing list bounces to the
16501 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16502 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16503
16504
16505
16506 .option expn routers&!? boolean true
16507 .cindex "address" "testing"
16508 .cindex "testing" "addresses"
16509 .cindex "EXPN" "router skipping"
16510 .cindex "router" "skipping for EXPN"
16511 If this option is turned off, the router is skipped when testing an address
16512 as a result of processing an SMTP EXPN command. You might, for example,
16513 want to turn it off on a router for users' &_.forward_& files, while leaving it
16514 on for the system alias file.
16515 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16516 are evaluated.
16517
16518 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16519 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16520 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16521
16522
16523
16524 .option fail_verify routers boolean false
16525 .cindex "router" "forcing verification failure"
16526 Setting this option has the effect of setting both &%fail_verify_sender%& and
16527 &%fail_verify_recipient%& to the same value.
16528
16529
16530
16531 .option fail_verify_recipient routers boolean false
16532 If this option is true and an address is accepted by this router when
16533 verifying a recipient, verification fails.
16534
16535
16536
16537 .option fail_verify_sender routers boolean false
16538 If this option is true and an address is accepted by this router when
16539 verifying a sender, verification fails.
16540
16541
16542
16543 .option fallback_hosts routers "string list" unset
16544 .cindex "router" "fallback hosts"
16545 .cindex "fallback" "hosts specified on router"
16546 String expansion is not applied to this option. The argument must be a
16547 colon-separated list of host names or IP addresses. The list separator can be
16548 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16549 each name or address. In fact, the format of each item is exactly the same as
16550 defined for the list of hosts in a &(manualroute)& router (see section
16551 &<<SECTformatonehostitem>>&).
16552
16553 If a router queues an address for a remote transport, this host list is
16554 associated with the address, and used instead of the transport's fallback host
16555 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16556 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16557 transport for further details.
16558
16559
16560 .option group routers string&!! "see below"
16561 .cindex "gid (group id)" "local delivery"
16562 .cindex "local transports" "uid and gid"
16563 .cindex "transport" "local"
16564 .cindex "router" "setting group"
16565 When a router queues an address for a transport, and the transport does not
16566 specify a group, the group given here is used when running the delivery
16567 process.
16568 The group may be specified numerically or by name. If expansion fails, the
16569 error is logged and delivery is deferred.
16570 The default is unset, unless &%check_local_user%& is set, when the default
16571 is taken from the password information. See also &%initgroups%& and &%user%&
16572 and the discussion in chapter &<<CHAPenvironment>>&.
16573
16574
16575
16576 .option headers_add routers string&!! unset
16577 .cindex "header lines" "adding"
16578 .cindex "router" "adding header lines"
16579 This option specifies a string of text that is expanded at routing time, and
16580 associated with any addresses that are accepted by the router. However, this
16581 option has no effect when an address is just being verified. The way in which
16582 the text is used to add header lines at transport time is described in section
16583 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16584 message is in the process of being transported. This means that references to
16585 header lines in string expansions in the transport's configuration do not
16586 &"see"& the added header lines.
16587
16588 The &%headers_add%& option is expanded after &%errors_to%&, but before
16589 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16590 the expansion is forced to fail, the option has no effect. Other expansion
16591 failures are treated as configuration errors.
16592
16593 Unlike most options, &%headers_add%& can be specified multiple times
16594 for a router; all listed headers are added.
16595
16596 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16597 router that has the &%one_time%& option set.
16598
16599 .cindex "duplicate addresses"
16600 .oindex "&%unseen%&"
16601 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16602 additions are deleted when the address is passed on to subsequent routers.
16603 For a &%redirect%& router, if a generated address is the same as the incoming
16604 address, this can lead to duplicate addresses with different header
16605 modifications. Exim does not do duplicate deliveries (except, in certain
16606 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16607 which of the duplicates is discarded, so this ambiguous situation should be
16608 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16609
16610
16611
16612 .option headers_remove routers string&!! unset
16613 .cindex "header lines" "removing"
16614 .cindex "router" "removing header lines"
16615 This option specifies a string of text that is expanded at routing time, and
16616 associated with any addresses that are accepted by the router. However, this
16617 option has no effect when an address is just being verified. The way in which
16618 the text is used to remove header lines at transport time is described in
16619 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16620 the message is in the process of being transported. This means that references
16621 to header lines in string expansions in the transport's configuration still
16622 &"see"& the original header lines.
16623
16624 The &%headers_remove%& option is expanded after &%errors_to%& and
16625 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16626 the option has no effect. Other expansion failures are treated as configuration
16627 errors.
16628
16629 Unlike most options, &%headers_remove%& can be specified multiple times
16630 for a router; all listed headers are removed.
16631
16632 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16633 router that has the &%one_time%& option set.
16634
16635 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16636 removal requests are deleted when the address is passed on to subsequent
16637 routers, and this can lead to problems with duplicates -- see the similar
16638 warning for &%headers_add%& above.
16639
16640
16641 .option ignore_target_hosts routers "host list&!!" unset
16642 .cindex "IP address" "discarding"
16643 .cindex "router" "discarding IP addresses"
16644 Although this option is a host list, it should normally contain IP address
16645 entries rather than names. If any host that is looked up by the router has an
16646 IP address that matches an item in this list, Exim behaves as if that IP
16647 address did not exist. This option allows you to cope with rogue DNS entries
16648 like
16649 .code
16650 remote.domain.example.  A  127.0.0.1
16651 .endd
16652 by setting
16653 .code
16654 ignore_target_hosts = 127.0.0.1
16655 .endd
16656 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16657 discarded in this way, the router declines. In a conventional configuration, an
16658 attempt to mail to such a domain would normally provoke the &"unrouteable
16659 domain"& error, and an attempt to verify an address in the domain would fail.
16660 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16661 router declines if presented with one of the listed addresses.
16662
16663 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16664 means of the first or the second of the following settings, respectively:
16665 .code
16666 ignore_target_hosts = 0.0.0.0/0
16667 ignore_target_hosts = <; 0::0/0
16668 .endd
16669 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16670 in the second line matches all IPv6 addresses.
16671
16672 This option may also be useful for ignoring link-local and site-local IPv6
16673 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16674 is expanded before use as a list, it is possible to make it dependent on the
16675 domain that is being routed.
16676
16677 .vindex "&$host_address$&"
16678 During its expansion, &$host_address$& is set to the IP address that is being
16679 checked.
16680
16681 .option initgroups routers boolean false
16682 .cindex "additional groups"
16683 .cindex "groups" "additional"
16684 .cindex "local transports" "uid and gid"
16685 .cindex "transport" "local"
16686 If the router queues an address for a transport, and this option is true, and
16687 the uid supplied by the router is not overridden by the transport, the
16688 &[initgroups()]& function is called when running the transport to ensure that
16689 any additional groups associated with the uid are set up. See also &%group%&
16690 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16691
16692
16693
16694 .option local_part_prefix routers&!? "string list" unset
16695 .cindex "router" "prefix for local part"
16696 .cindex "prefix" "for local part, used in router"
16697 If this option is set, the router is skipped unless the local part starts with
16698 one of the given strings, or &%local_part_prefix_optional%& is true. See
16699 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16700 evaluated.
16701
16702 The list is scanned from left to right, and the first prefix that matches is
16703 used. A limited form of wildcard is available; if the prefix begins with an
16704 asterisk, it matches the longest possible sequence of arbitrary characters at
16705 the start of the local part. An asterisk should therefore always be followed by
16706 some character that does not occur in normal local parts.
16707 .cindex "multiple mailboxes"
16708 .cindex "mailbox" "multiple"
16709 Wildcarding can be used to set up multiple user mailboxes, as described in
16710 section &<<SECTmulbox>>&.
16711
16712 .vindex "&$local_part$&"
16713 .vindex "&$local_part_prefix$&"
16714 During the testing of the &%local_parts%& option, and while the router is
16715 running, the prefix is removed from the local part, and is available in the
16716 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16717 the router accepts the address, this remains true during subsequent delivery by
16718 a transport. In particular, the local part that is transmitted in the RCPT
16719 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16720 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16721 the relevant transport.
16722
16723 When an address is being verified, &%local_part_prefix%& affects only the
16724 behaviour of the router. If the callout feature of verification is in use, this
16725 means that the full address, including the prefix, will be used during the
16726 callout.
16727
16728 The prefix facility is commonly used to handle local parts of the form
16729 &%owner-something%&. Another common use is to support local parts of the form
16730 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16731 to tell a user their forwarding is broken &-- by placing a router like this one
16732 immediately before the router that handles &_.forward_& files:
16733 .code
16734 real_localuser:
16735   driver = accept
16736   local_part_prefix = real-
16737   check_local_user
16738   transport = local_delivery
16739 .endd
16740 For security, it would probably be a good idea to restrict the use of this
16741 router to locally-generated messages, using a condition such as this:
16742 .code
16743   condition = ${if match {$sender_host_address}\
16744                          {\N^(|127\.0\.0\.1)$\N}}
16745 .endd
16746
16747 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16748 both conditions must be met if not optional. Care must be taken if wildcards
16749 are used in both a prefix and a suffix on the same router. Different
16750 separator characters must be used to avoid ambiguity.
16751
16752
16753 .option local_part_prefix_optional routers boolean false
16754 See &%local_part_prefix%& above.
16755
16756
16757
16758 .option local_part_suffix routers&!? "string list" unset
16759 .cindex "router" "suffix for local part"
16760 .cindex "suffix for local part" "used in router"
16761 This option operates in the same way as &%local_part_prefix%&, except that the
16762 local part must end (rather than start) with the given string, the
16763 &%local_part_suffix_optional%& option determines whether the suffix is
16764 mandatory, and the wildcard * character, if present, must be the last
16765 character of the suffix. This option facility is commonly used to handle local
16766 parts of the form &%something-request%& and multiple user mailboxes of the form
16767 &%username-foo%&.
16768
16769
16770 .option local_part_suffix_optional routers boolean false
16771 See &%local_part_suffix%& above.
16772
16773
16774
16775 .option local_parts routers&!? "local part list&!!" unset
16776 .cindex "router" "restricting to specific local parts"
16777 .cindex "local part" "checking in router"
16778 The router is run only if the local part of the address matches the list.
16779 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16780 are evaluated, and
16781 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16782 string is expanded, it is possible to make it depend on the domain, for
16783 example:
16784 .code
16785 local_parts = dbm;/usr/local/specials/$domain
16786 .endd
16787 .vindex "&$local_part_data$&"
16788 If the match is achieved by a lookup, the data that the lookup returned
16789 for the local part is placed in the variable &$local_part_data$& for use in
16790 expansions of the router's private options. You might use this option, for
16791 example, if you have a large number of local virtual domains, and you want to
16792 send all postmaster mail to the same place without having to set up an alias in
16793 each virtual domain:
16794 .code
16795 postmaster:
16796   driver = redirect
16797   local_parts = postmaster
16798   data = postmaster@real.domain.example
16799 .endd
16800
16801
16802 .option log_as_local routers boolean "see below"
16803 .cindex "log" "delivery line"
16804 .cindex "delivery" "log line format"
16805 Exim has two logging styles for delivery, the idea being to make local
16806 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16807 recipient address is given just as the local part, without a domain. The use of
16808 this style is controlled by this option. It defaults to true for the &(accept)&
16809 router, and false for all the others. This option applies only when a
16810 router assigns an address to a transport. It has no effect on routers that
16811 redirect addresses.
16812
16813
16814
16815 .option more routers boolean&!! true
16816 The result of string expansion for this option must be a valid boolean value,
16817 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16818 result causes an error, and delivery is deferred. If the expansion is forced to
16819 fail, the default value for the option (true) is used. Other failures cause
16820 delivery to be deferred.
16821
16822 If this option is set false, and the router declines to handle the address, no
16823 further routers are tried, routing fails, and the address is bounced.
16824 .oindex "&%self%&"
16825 However, if the router explicitly passes an address to the following router by
16826 means of the setting
16827 .code
16828 self = pass
16829 .endd
16830 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16831 does not affect the behaviour if one of the precondition tests fails. In that
16832 case, the address is always passed to the next router.
16833
16834 Note that &%address_data%& is not considered to be a precondition. If its
16835 expansion is forced to fail, the router declines, and the value of &%more%&
16836 controls what happens next.
16837
16838
16839 .option pass_on_timeout routers boolean false
16840 .cindex "timeout" "of router"
16841 .cindex "router" "timeout"
16842 If a router times out during a host lookup, it normally causes deferral of the
16843 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16844 router, overriding &%no_more%&. This may be helpful for systems that are
16845 intermittently connected to the Internet, or those that want to pass to a smart
16846 host any messages that cannot immediately be delivered.
16847
16848 There are occasional other temporary errors that can occur while doing DNS
16849 lookups. They are treated in the same way as a timeout, and this option
16850 applies to all of them.
16851
16852
16853
16854 .option pass_router routers string unset
16855 .cindex "router" "go to after &""pass""&"
16856 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16857 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16858 routing to continue, and overriding a false setting of &%more%&. When one of
16859 these routers returns &"pass"&, the address is normally handed on to the next
16860 router in sequence. This can be changed by setting &%pass_router%& to the name
16861 of another router. However (unlike &%redirect_router%&) the named router must
16862 be below the current router, to avoid loops. Note that this option applies only
16863 to the special case of &"pass"&. It does not apply when a router returns
16864 &"decline"& because it cannot handle an address.
16865
16866
16867
16868 .option redirect_router routers string unset
16869 .cindex "router" "start at after redirection"
16870 Sometimes an administrator knows that it is pointless to reprocess addresses
16871 generated from alias or forward files with the same router again. For
16872 example, if an alias file translates real names into login ids there is no
16873 point searching the alias file a second time, especially if it is a large file.
16874
16875 The &%redirect_router%& option can be set to the name of any router instance.
16876 It causes the routing of any generated addresses to start at the named router
16877 instead of at the first router. This option has no effect if the router in
16878 which it is set does not generate new addresses.
16879
16880
16881
16882 .option require_files routers&!? "string list&!!" unset
16883 .cindex "file" "requiring for router"
16884 .cindex "router" "requiring file existence"
16885 This option provides a general mechanism for predicating the running of a
16886 router on the existence or non-existence of certain files or directories.
16887 Before running a router, as one of its precondition tests, Exim works its way
16888 through the &%require_files%& list, expanding each item separately.
16889
16890 Because the list is split before expansion, any colons in expansion items must
16891 be doubled, or the facility for using a different list separator must be used.
16892 If any expansion is forced to fail, the item is ignored. Other expansion
16893 failures cause routing of the address to be deferred.
16894
16895 If any expanded string is empty, it is ignored. Otherwise, except as described
16896 below, each string must be a fully qualified file path, optionally preceded by
16897 &"!"&. The paths are passed to the &[stat()]& function to test for the
16898 existence of the files or directories. The router is skipped if any paths not
16899 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16900
16901 .cindex "NFS"
16902 If &[stat()]& cannot determine whether a file exists or not, delivery of
16903 the message is deferred. This can happen when NFS-mounted filesystems are
16904 unavailable.
16905
16906 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16907 options, so you cannot use it to check for the existence of a file in which to
16908 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16909 full list of the order in which preconditions are evaluated.) However, as
16910 these options are all expanded, you can use the &%exists%& expansion condition
16911 to make such tests. The &%require_files%& option is intended for checking files
16912 that the router may be going to use internally, or which are needed by a
16913 transport (for example &_.procmailrc_&).
16914
16915 During delivery, the &[stat()]& function is run as root, but there is a
16916 facility for some checking of the accessibility of a file by another user.
16917 This is not a proper permissions check, but just a &"rough"& check that
16918 operates as follows:
16919
16920 If an item in a &%require_files%& list does not contain any forward slash
16921 characters, it is taken to be the user (and optional group, separated by a
16922 comma) to be checked for subsequent files in the list. If no group is specified
16923 but the user is specified symbolically, the gid associated with the uid is
16924 used. For example:
16925 .code
16926 require_files = mail:/some/file
16927 require_files = $local_part:$home/.procmailrc
16928 .endd
16929 If a user or group name in a &%require_files%& list does not exist, the
16930 &%require_files%& condition fails.
16931
16932 Exim performs the check by scanning along the components of the file path, and
16933 checking the access for the given uid and gid. It checks for &"x"& access on
16934 directories, and &"r"& access on the final file. Note that this means that file
16935 access control lists, if the operating system has them, are ignored.
16936
16937 &*Warning 1*&: When the router is being run to verify addresses for an
16938 incoming SMTP message, Exim is not running as root, but under its own uid. This
16939 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16940 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16941 user is not permitted to read one of the directories on the file's path.
16942
16943 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16944 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16945 without root access. In this case, if a check for access by a particular user
16946 is requested, Exim creates a subprocess that runs as that user, and tries the
16947 check again in that process.
16948
16949 The default action for handling an unresolved EACCES is to consider it to
16950 be caused by a configuration error, and routing is deferred because the
16951 existence or non-existence of the file cannot be determined. However, in some
16952 circumstances it may be desirable to treat this condition as if the file did
16953 not exist. If the file name (or the exclamation mark that precedes the file
16954 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16955 as if the file did not exist. For example:
16956 .code
16957 require_files = +/some/file
16958 .endd
16959 If the router is not an essential part of verification (for example, it
16960 handles users' &_.forward_& files), another solution is to set the &%verify%&
16961 option false so that the router is skipped when verifying.
16962
16963
16964
16965 .option retry_use_local_part routers boolean "see below"
16966 .cindex "hints database" "retry keys"
16967 .cindex "local part" "in retry keys"
16968 When a delivery suffers a temporary routing failure, a retry record is created
16969 in Exim's hints database. For addresses whose routing depends only on the
16970 domain, the key for the retry record should not involve the local part, but for
16971 other addresses, both the domain and the local part should be included.
16972 Usually, remote routing is of the former kind, and local routing is of the
16973 latter kind.
16974
16975 This option controls whether the local part is used to form the key for retry
16976 hints for addresses that suffer temporary errors while being handled by this
16977 router. The default value is true for any router that has &%check_local_user%&
16978 set, and false otherwise. Note that this option does not apply to hints keys
16979 for transport delays; they are controlled by a generic transport option of the
16980 same name.
16981
16982 The setting of &%retry_use_local_part%& applies only to the router on which it
16983 appears. If the router generates child addresses, they are routed
16984 independently; this setting does not become attached to them.
16985
16986
16987
16988 .option router_home_directory routers string&!! unset
16989 .cindex "router" "home directory for"
16990 .cindex "home directory" "for router"
16991 .vindex "&$home$&"
16992 This option sets a home directory for use while the router is running. (Compare
16993 &%transport_home_directory%&, which sets a home directory for later
16994 transporting.) In particular, if used on a &(redirect)& router, this option
16995 sets a value for &$home$& while a filter is running. The value is expanded;
16996 forced expansion failure causes the option to be ignored &-- other failures
16997 cause the router to defer.
16998
16999 Expansion of &%router_home_directory%& happens immediately after the
17000 &%check_local_user%& test (if configured), before any further expansions take
17001 place.
17002 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17003 are evaluated.)
17004 While the router is running, &%router_home_directory%& overrides the value of
17005 &$home$& that came from &%check_local_user%&.
17006
17007 When a router accepts an address and assigns it to a local transport (including
17008 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17009 delivery), the home directory setting for the transport is taken from the first
17010 of these values that is set:
17011
17012 .ilist
17013 The &%home_directory%& option on the transport;
17014 .next
17015 The &%transport_home_directory%& option on the router;
17016 .next
17017 The password data if &%check_local_user%& is set on the router;
17018 .next
17019 The &%router_home_directory%& option on the router.
17020 .endlist
17021
17022 In other words, &%router_home_directory%& overrides the password data for the
17023 router, but not for the transport.
17024
17025
17026
17027 .option self routers string freeze
17028 .cindex "MX record" "pointing to local host"
17029 .cindex "local host" "MX pointing to"
17030 This option applies to those routers that use a recipient address to find a
17031 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17032 and &(manualroute)& routers.
17033 Certain configurations of the &(queryprogram)& router can also specify a list
17034 of remote hosts.
17035 Usually such routers are configured to send the message to a remote host via an
17036 &(smtp)& transport. The &%self%& option specifies what happens when the first
17037 host on the list turns out to be the local host.
17038 The way in which Exim checks for the local host is described in section
17039 &<<SECTreclocipadd>>&.
17040
17041 Normally this situation indicates either an error in Exim's configuration (for
17042 example, the router should be configured not to process this domain), or an
17043 error in the DNS (for example, the MX should not point to this host). For this
17044 reason, the default action is to log the incident, defer the address, and
17045 freeze the message. The following alternatives are provided for use in special
17046 cases:
17047
17048 .vlist
17049 .vitem &%defer%&
17050 Delivery of the message is tried again later, but the message is not frozen.
17051
17052 .vitem "&%reroute%&: <&'domain'&>"
17053 The domain is changed to the given domain, and the address is passed back to
17054 be reprocessed by the routers. No rewriting of headers takes place. This
17055 behaviour is essentially a redirection.
17056
17057 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17058 The domain is changed to the given domain, and the address is passed back to be
17059 reprocessed by the routers. Any headers that contain the original domain are
17060 rewritten.
17061
17062 .vitem &%pass%&
17063 .oindex "&%more%&"
17064 .vindex "&$self_hostname$&"
17065 The router passes the address to the next router, or to the router named in the
17066 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17067 subsequent routing and delivery, the variable &$self_hostname$& contains the
17068 name of the local host that the router encountered. This can be used to
17069 distinguish between different cases for hosts with multiple names. The
17070 combination
17071 .code
17072 self = pass
17073 no_more
17074 .endd
17075 ensures that only those addresses that routed to the local host are passed on.
17076 Without &%no_more%&, addresses that were declined for other reasons would also
17077 be passed to the next router.
17078
17079 .vitem &%fail%&
17080 Delivery fails and an error report is generated.
17081
17082 .vitem &%send%&
17083 .cindex "local host" "sending to"
17084 The anomaly is ignored and the address is queued for the transport. This
17085 setting should be used with extreme caution. For an &(smtp)& transport, it
17086 makes sense only in cases where the program that is listening on the SMTP port
17087 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17088 different configuration file that handles the domain in another way.
17089 .endlist
17090
17091
17092
17093 .option senders routers&!? "address list&!!" unset
17094 .cindex "router" "checking senders"
17095 If this option is set, the router is skipped unless the message's sender
17096 address matches something on the list.
17097 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17098 are evaluated.
17099
17100 There are issues concerning verification when the running of routers is
17101 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17102 setting, it sets the sender to the null string. When using the &%-bt%& option
17103 to check a configuration file, it is necessary also to use the &%-f%& option to
17104 set an appropriate sender. For incoming mail, the sender is unset when
17105 verifying the sender, but is available when verifying any recipients. If the
17106 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17107 matters.
17108
17109
17110 .option translate_ip_address routers string&!! unset
17111 .cindex "IP address" "translating"
17112 .cindex "packet radio"
17113 .cindex "router" "IP address translation"
17114 There exist some rare networking situations (for example, packet radio) where
17115 it is helpful to be able to translate IP addresses generated by normal routing
17116 mechanisms into other IP addresses, thus performing a kind of manual IP
17117 routing. This should be done only if the normal IP routing of the TCP/IP stack
17118 is inadequate or broken. Because this is an extremely uncommon requirement, the
17119 code to support this option is not included in the Exim binary unless
17120 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17121
17122 .vindex "&$host_address$&"
17123 The &%translate_ip_address%& string is expanded for every IP address generated
17124 by the router, with the generated address set in &$host_address$&. If the
17125 expansion is forced to fail, no action is taken.
17126 For any other expansion error, delivery of the message is deferred.
17127 If the result of the expansion is an IP address, that replaces the original
17128 address; otherwise the result is assumed to be a host name &-- this is looked
17129 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17130 produce one or more replacement IP addresses. For example, to subvert all IP
17131 addresses in some specific networks, this could be added to a router:
17132 .code
17133 translate_ip_address = \
17134   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17135     {$value}fail}}
17136 .endd
17137 The file would contain lines like
17138 .code
17139 10.2.3.128/26    some.host
17140 10.8.4.34/26     10.44.8.15
17141 .endd
17142 You should not make use of this facility unless you really understand what you
17143 are doing.
17144
17145
17146
17147 .option transport routers string&!! unset
17148 This option specifies the transport to be used when a router accepts an address
17149 and sets it up for delivery. A transport is never needed if a router is used
17150 only for verification. The value of the option is expanded at routing time,
17151 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17152 and result must be the name of one of the configured transports. If it is not,
17153 delivery is deferred.
17154
17155 The &%transport%& option is not used by the &(redirect)& router, but it does
17156 have some private options that set up transports for pipe and file deliveries
17157 (see chapter &<<CHAPredirect>>&).
17158
17159
17160
17161 .option transport_current_directory routers string&!! unset
17162 .cindex "current directory for local transport"
17163 This option associates a current directory with any address that is routed
17164 to a local transport. This can happen either because a transport is
17165 explicitly configured for the router, or because it generates a delivery to a
17166 file or a pipe. During the delivery process (that is, at transport time), this
17167 option string is expanded and is set as the current directory, unless
17168 overridden by a setting on the transport.
17169 If the expansion fails for any reason, including forced failure, an error is
17170 logged, and delivery is deferred.
17171 See chapter &<<CHAPenvironment>>& for details of the local delivery
17172 environment.
17173
17174
17175
17176
17177 .option transport_home_directory routers string&!! "see below"
17178 .cindex "home directory" "for local transport"
17179 This option associates a home directory with any address that is routed to a
17180 local transport. This can happen either because a transport is explicitly
17181 configured for the router, or because it generates a delivery to a file or a
17182 pipe. During the delivery process (that is, at transport time), the option
17183 string is expanded and is set as the home directory, unless overridden by a
17184 setting of &%home_directory%& on the transport.
17185 If the expansion fails for any reason, including forced failure, an error is
17186 logged, and delivery is deferred.
17187
17188 If the transport does not specify a home directory, and
17189 &%transport_home_directory%& is not set for the router, the home directory for
17190 the transport is taken from the password data if &%check_local_user%& is set for
17191 the router. Otherwise it is taken from &%router_home_directory%& if that option
17192 is set; if not, no home directory is set for the transport.
17193
17194 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17195 environment.
17196
17197
17198
17199
17200 .option unseen routers boolean&!! false
17201 .cindex "router" "carrying on after success"
17202 The result of string expansion for this option must be a valid boolean value,
17203 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17204 result causes an error, and delivery is deferred. If the expansion is forced to
17205 fail, the default value for the option (false) is used. Other failures cause
17206 delivery to be deferred.
17207
17208 When this option is set true, routing does not cease if the router accepts the
17209 address. Instead, a copy of the incoming address is passed to the next router,
17210 overriding a false setting of &%more%&. There is little point in setting
17211 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17212 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17213 sometimes true and sometimes false).
17214
17215 .cindex "copy of message (&%unseen%& option)"
17216 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17217 qualifier in filter files. It can be used to cause copies of messages to be
17218 delivered to some other destination, while also carrying out a normal delivery.
17219 In effect, the current address is made into a &"parent"& that has two children
17220 &-- one that is delivered as specified by this router, and a clone that goes on
17221 to be routed further. For this reason, &%unseen%& may not be combined with the
17222 &%one_time%& option in a &(redirect)& router.
17223
17224 &*Warning*&: Header lines added to the address (or specified for removal) by
17225 this router or by previous routers affect the &"unseen"& copy of the message
17226 only. The clone that continues to be processed by further routers starts with
17227 no added headers and none specified for removal. For a &%redirect%& router, if
17228 a generated address is the same as the incoming address, this can lead to
17229 duplicate addresses with different header modifications. Exim does not do
17230 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17231 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17232 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17233 &%redirect%& router may be of help.
17234
17235 Unlike the handling of header modifications, any data that was set by the
17236 &%address_data%& option in the current or previous routers &'is'& passed on to
17237 subsequent routers.
17238
17239
17240 .option user routers string&!! "see below"
17241 .cindex "uid (user id)" "local delivery"
17242 .cindex "local transports" "uid and gid"
17243 .cindex "transport" "local"
17244 .cindex "router" "user for filter processing"
17245 .cindex "filter" "user for processing"
17246 When a router queues an address for a transport, and the transport does not
17247 specify a user, the user given here is used when running the delivery process.
17248 The user may be specified numerically or by name. If expansion fails, the
17249 error is logged and delivery is deferred.
17250 This user is also used by the &(redirect)& router when running a filter file.
17251 The default is unset, except when &%check_local_user%& is set. In this case,
17252 the default is taken from the password information. If the user is specified as
17253 a name, and &%group%& is not set, the group associated with the user is used.
17254 See also &%initgroups%& and &%group%& and the discussion in chapter
17255 &<<CHAPenvironment>>&.
17256
17257
17258
17259 .option verify routers&!? boolean true
17260 Setting this option has the effect of setting &%verify_sender%& and
17261 &%verify_recipient%& to the same value.
17262
17263
17264 .option verify_only routers&!? boolean false
17265 .cindex "EXPN" "with &%verify_only%&"
17266 .oindex "&%-bv%&"
17267 .cindex "router" "used only when verifying"
17268 If this option is set, the router is used only when verifying an address,
17269 delivering in cutthrough mode or
17270 testing with the &%-bv%& option, not when actually doing a delivery, testing
17271 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17272 restricted to verifying only senders or recipients by means of
17273 &%verify_sender%& and &%verify_recipient%&.
17274
17275 &*Warning*&: When the router is being run to verify addresses for an incoming
17276 SMTP message, Exim is not running as root, but under its own uid. If the router
17277 accesses any files, you need to make sure that they are accessible to the Exim
17278 user or group.
17279
17280
17281 .option verify_recipient routers&!? boolean true
17282 If this option is false, the router is skipped when verifying recipient
17283 addresses,
17284 delivering in cutthrough mode
17285 or testing recipient verification using &%-bv%&.
17286 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17287 are evaluated.
17288
17289
17290 .option verify_sender routers&!? boolean true
17291 If this option is false, the router is skipped when verifying sender addresses
17292 or testing sender verification using &%-bvs%&.
17293 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17294 are evaluated.
17295 .ecindex IIDgenoprou1
17296 .ecindex IIDgenoprou2
17297
17298
17299
17300
17301
17302
17303 . ////////////////////////////////////////////////////////////////////////////
17304 . ////////////////////////////////////////////////////////////////////////////
17305
17306 .chapter "The accept router" "CHID4"
17307 .cindex "&(accept)& router"
17308 .cindex "routers" "&(accept)&"
17309 The &(accept)& router has no private options of its own. Unless it is being
17310 used purely for verification (see &%verify_only%&) a transport is required to
17311 be defined by the generic &%transport%& option. If the preconditions that are
17312 specified by generic options are met, the router accepts the address and queues
17313 it for the given transport. The most common use of this router is for setting
17314 up deliveries to local mailboxes. For example:
17315 .code
17316 localusers:
17317   driver = accept
17318   domains = mydomain.example
17319   check_local_user
17320   transport = local_delivery
17321 .endd
17322 The &%domains%& condition in this example checks the domain of the address, and
17323 &%check_local_user%& checks that the local part is the login of a local user.
17324 When both preconditions are met, the &(accept)& router runs, and queues the
17325 address for the &(local_delivery)& transport.
17326
17327
17328
17329
17330
17331
17332 . ////////////////////////////////////////////////////////////////////////////
17333 . ////////////////////////////////////////////////////////////////////////////
17334
17335 .chapter "The dnslookup router" "CHAPdnslookup"
17336 .scindex IIDdnsrou1 "&(dnslookup)& router"
17337 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17338 The &(dnslookup)& router looks up the hosts that handle mail for the
17339 recipient's domain in the DNS. A transport must always be set for this router,
17340 unless &%verify_only%& is set.
17341
17342 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17343 SRV records. If none are found, or if SRV support is not configured,
17344 MX records are looked up. If no MX records exist, address records are sought.
17345 However, &%mx_domains%& can be set to disable the direct use of address
17346 records.
17347
17348 MX records of equal priority are sorted by Exim into a random order. Exim then
17349 looks for address records for the host names obtained from MX or SRV records.
17350 When a host has more than one IP address, they are sorted into a random order,
17351 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17352 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17353 generic option, the router declines.
17354
17355 Unless they have the highest priority (lowest MX value), MX records that point
17356 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17357 are discarded, together with any other MX records of equal or lower priority.
17358
17359 .cindex "MX record" "pointing to local host"
17360 .cindex "local host" "MX pointing to"
17361 .oindex "&%self%&" "in &(dnslookup)& router"
17362 If the host pointed to by the highest priority MX record, or looked up as an
17363 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17364 happens is controlled by the generic &%self%& option.
17365
17366
17367 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17368 There have been problems with DNS servers when SRV records are looked up.
17369 Some mis-behaving servers return a DNS error or timeout when a non-existent
17370 SRV record is sought. Similar problems have in the past been reported for
17371 MX records. The global &%dns_again_means_nonexist%& option can help with this
17372 problem, but it is heavy-handed because it is a global option.
17373
17374 For this reason, there are two options, &%srv_fail_domains%& and
17375 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17376 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17377 an attempt to look up an SRV or MX record causes one of these results, and the
17378 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17379 such record"&. In the case of an SRV lookup, this means that the router
17380 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17381 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17382 case routing fails.
17383
17384
17385 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17386 .cindex "&(dnslookup)& router" "declines"
17387 There are a few cases where a &(dnslookup)& router will decline to accept
17388 an address; if such a router is expected to handle "all remaining non-local
17389 domains", then it is important to set &%no_more%&.
17390
17391 Reasons for a &(dnslookup)& router to decline currently include:
17392 .ilist
17393 The domain does not exist in DNS
17394 .next
17395 The domain exists but the MX record's host part is just "."; this is a common
17396 convention (borrowed from SRV) used to indicate that there is no such service
17397 for this domain and to not fall back to trying A/AAAA records.
17398 .next
17399 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17400 .next
17401 MX record points to a non-existent host.
17402 .next
17403 MX record points to an IP address and the main section option
17404 &%allow_mx_to_ip%& is not set.
17405 .next
17406 MX records exist and point to valid hosts, but all hosts resolve only to
17407 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17408 .next
17409 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17410 &%dns_check_names_pattern%& for handling one variant of this)
17411 .next
17412 &%check_secondary_mx%& is set on this router but the local host can
17413 not be found in the MX records (see below)
17414 .endlist
17415
17416
17417
17418
17419 .section "Private options for dnslookup" "SECID118"
17420 .cindex "options" "&(dnslookup)& router"
17421 The private options for the &(dnslookup)& router are as follows:
17422
17423 .option check_secondary_mx dnslookup boolean false
17424 .cindex "MX record" "checking for secondary"
17425 If this option is set, the router declines unless the local host is found in
17426 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17427 process domains for which the local host is a secondary mail exchanger
17428 differently to other domains. The way in which Exim decides whether a host is
17429 the local host is described in section &<<SECTreclocipadd>>&.
17430
17431
17432 .option check_srv dnslookup string&!! unset
17433 .cindex "SRV record" "enabling use of"
17434 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17435 addition to MX and address records. The support is disabled by default. To
17436 enable SRV support, set the &%check_srv%& option to the name of the service
17437 required. For example,
17438 .code
17439 check_srv = smtp
17440 .endd
17441 looks for SRV records that refer to the normal smtp service. The option is
17442 expanded, so the service name can vary from message to message or address
17443 to address. This might be helpful if SRV records are being used for a
17444 submission service. If the expansion is forced to fail, the &%check_srv%&
17445 option is ignored, and the router proceeds to look for MX records in the
17446 normal way.
17447
17448 When the expansion succeeds, the router searches first for SRV records for
17449 the given service (it assumes TCP protocol). A single SRV record with a
17450 host name that consists of just a single dot indicates &"no such service for
17451 this domain"&; if this is encountered, the router declines. If other kinds of
17452 SRV record are found, they are used to construct a host list for delivery
17453 according to the rules of RFC 2782. MX records are not sought in this case.
17454
17455 When no SRV records are found, MX records (and address records) are sought in
17456 the traditional way. In other words, SRV records take precedence over MX
17457 records, just as MX records take precedence over address records. Note that
17458 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17459 defined it. It is apparently believed that MX records are sufficient for email
17460 and that SRV records should not be used for this purpose. However, SRV records
17461 have an additional &"weight"& feature which some people might find useful when
17462 trying to split an SMTP load between hosts of different power.
17463
17464 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17465 when there is a DNS lookup error.
17466
17467
17468
17469 .option mx_domains dnslookup "domain list&!!" unset
17470 .cindex "MX record" "required to exist"
17471 .cindex "SRV record" "required to exist"
17472 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17473 record in order to be recognized. (The name of this option could be improved.)
17474 For example, if all the mail hosts in &'fict.example'& are known to have MX
17475 records, except for those in &'discworld.fict.example'&, you could use this
17476 setting:
17477 .code
17478 mx_domains = ! *.discworld.fict.example : *.fict.example
17479 .endd
17480 This specifies that messages addressed to a domain that matches the list but
17481 has no MX record should be bounced immediately instead of being routed using
17482 the address record.
17483
17484
17485 .option mx_fail_domains dnslookup "domain list&!!" unset
17486 If the DNS lookup for MX records for one of the domains in this list causes a
17487 DNS lookup error, Exim behaves as if no MX records were found. See section
17488 &<<SECTprowitdnsloo>>& for more discussion.
17489
17490
17491
17492
17493 .option qualify_single dnslookup boolean true
17494 .cindex "DNS" "resolver options"
17495 .cindex "DNS" "qualifying single-component names"
17496 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17497 lookups. Typically, but not standardly, this causes the resolver to qualify
17498 single-component names with the default domain. For example, on a machine
17499 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17500 &'thesaurus.ref.example'& inside the resolver. For details of what your
17501 resolver actually does, consult your man pages for &'resolver'& and
17502 &'resolv.conf'&.
17503
17504
17505
17506 .option rewrite_headers dnslookup boolean true
17507 .cindex "rewriting" "header lines"
17508 .cindex "header lines" "rewriting"
17509 If the domain name in the address that is being processed is not fully
17510 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17511 an address is specified as &'dormouse@teaparty'&, the domain might be
17512 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17513 occur as a result of setting the &%widen_domains%& option. If
17514 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17515 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17516 header lines of the message are rewritten with the full domain name.
17517
17518 This option should be turned off only when it is known that no message is
17519 ever going to be sent outside an environment where the abbreviation makes
17520 sense.
17521
17522 When an MX record is looked up in the DNS and matches a wildcard record, name
17523 servers normally return a record containing the name that has been looked up,
17524 making it impossible to detect whether a wildcard was present or not. However,
17525 some name servers have recently been seen to return the wildcard entry. If the
17526 name returned by a DNS lookup begins with an asterisk, it is not used for
17527 header rewriting.
17528
17529
17530 .option same_domain_copy_routing dnslookup boolean false
17531 .cindex "address" "copying routing"
17532 Addresses with the same domain are normally routed by the &(dnslookup)& router
17533 to the same list of hosts. However, this cannot be presumed, because the router
17534 options and preconditions may refer to the local part of the address. By
17535 default, therefore, Exim routes each address in a message independently. DNS
17536 servers run caches, so repeated DNS lookups are not normally expensive, and in
17537 any case, personal messages rarely have more than a few recipients.
17538
17539 If you are running mailing lists with large numbers of subscribers at the same
17540 domain, and you are using a &(dnslookup)& router which is independent of the
17541 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17542 lookups for identical domains in one message. In this case, when &(dnslookup)&
17543 routes an address to a remote transport, any other unrouted addresses in the
17544 message that have the same domain are automatically given the same routing
17545 without processing them independently,
17546 provided the following conditions are met:
17547
17548 .ilist
17549 No router that processed the address specified &%headers_add%& or
17550 &%headers_remove%&.
17551 .next
17552 The router did not change the address in any way, for example, by &"widening"&
17553 the domain.
17554 .endlist
17555
17556
17557
17558
17559 .option search_parents dnslookup boolean false
17560 .cindex "DNS" "resolver options"
17561 When this option is true, the resolver option RES_DNSRCH is set for DNS
17562 lookups. This is different from the &%qualify_single%& option in that it
17563 applies to domains containing dots. Typically, but not standardly, it causes
17564 the resolver to search for the name in the current domain and in parent
17565 domains. For example, on a machine in the &'fict.example'& domain, if looking
17566 up &'teaparty.wonderland'& failed, the resolver would try
17567 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17568 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17569
17570 Setting this option true can cause problems in domains that have a wildcard MX
17571 record, because any domain that does not have its own MX record matches the
17572 local wildcard.
17573
17574
17575
17576 .option srv_fail_domains dnslookup "domain list&!!" unset
17577 If the DNS lookup for SRV records for one of the domains in this list causes a
17578 DNS lookup error, Exim behaves as if no SRV records were found. See section
17579 &<<SECTprowitdnsloo>>& for more discussion.
17580
17581
17582
17583
17584 .option widen_domains dnslookup "string list" unset
17585 .cindex "domain" "partial; widening"
17586 If a DNS lookup fails and this option is set, each of its strings in turn is
17587 added onto the end of the domain, and the lookup is tried again. For example,
17588 if
17589 .code
17590 widen_domains = fict.example:ref.example
17591 .endd
17592 is set and a lookup of &'klingon.dictionary'& fails,
17593 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17594 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17595 and &%search_parents%& options can cause some widening to be undertaken inside
17596 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17597 when verifying, unless &%rewrite_headers%& is false (not the default).
17598
17599
17600 .section "Effect of qualify_single and search_parents" "SECID119"
17601 When a domain from an envelope recipient is changed by the resolver as a result
17602 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17603 corresponding address in the message's header lines unless &%rewrite_headers%&
17604 is set false. Exim then re-routes the address, using the full domain.
17605
17606 These two options affect only the DNS lookup that takes place inside the router
17607 for the domain of the address that is being routed. They do not affect lookups
17608 such as that implied by
17609 .code
17610 domains = @mx_any
17611 .endd
17612 that may happen while processing a router precondition before the router is
17613 entered. No widening ever takes place for these lookups.
17614 .ecindex IIDdnsrou1
17615 .ecindex IIDdnsrou2
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625 . ////////////////////////////////////////////////////////////////////////////
17626 . ////////////////////////////////////////////////////////////////////////////
17627
17628 .chapter "The ipliteral router" "CHID5"
17629 .cindex "&(ipliteral)& router"
17630 .cindex "domain literal" "routing"
17631 .cindex "routers" "&(ipliteral)&"
17632 This router has no private options. Unless it is being used purely for
17633 verification (see &%verify_only%&) a transport is required to be defined by the
17634 generic &%transport%& option. The router accepts the address if its domain part
17635 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17636 router handles the address
17637 .code
17638 root@[192.168.1.1]
17639 .endd
17640 by setting up delivery to the host with that IP address. IPv4 domain literals
17641 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17642 are similar, but the address is preceded by &`ipv6:`&. For example:
17643 .code
17644 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17645 .endd
17646 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17647 grounds that sooner or later somebody will try it.
17648
17649 .oindex "&%self%&" "in &(ipliteral)& router"
17650 If the IP address matches something in &%ignore_target_hosts%&, the router
17651 declines. If an IP literal turns out to refer to the local host, the generic
17652 &%self%& option determines what happens.
17653
17654 The RFCs require support for domain literals; however, their use is
17655 controversial in today's Internet. If you want to use this router, you must
17656 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17657 Exim will not recognize the domain literal syntax in addresses.
17658
17659
17660
17661 . ////////////////////////////////////////////////////////////////////////////
17662 . ////////////////////////////////////////////////////////////////////////////
17663
17664 .chapter "The iplookup router" "CHID6"
17665 .cindex "&(iplookup)& router"
17666 .cindex "routers" "&(iplookup)&"
17667 The &(iplookup)& router was written to fulfil a specific requirement in
17668 Cambridge University (which in fact no longer exists). For this reason, it is
17669 not included in the binary of Exim by default. If you want to include it, you
17670 must set
17671 .code
17672 ROUTER_IPLOOKUP=yes
17673 .endd
17674 in your &_Local/Makefile_& configuration file.
17675
17676 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17677 connection to one or more specific hosts. The host can then return the same or
17678 a different address &-- in effect rewriting the recipient address in the
17679 message's envelope. The new address is then passed on to subsequent routers. If
17680 this process fails, the address can be passed on to other routers, or delivery
17681 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17682 must not be specified for it.
17683
17684 .cindex "options" "&(iplookup)& router"
17685 .option hosts iplookup string unset
17686 This option must be supplied. Its value is a colon-separated list of host
17687 names. The hosts are looked up using &[gethostbyname()]&
17688 (or &[getipnodebyname()]& when available)
17689 and are tried in order until one responds to the query. If none respond, what
17690 happens is controlled by &%optional%&.
17691
17692
17693 .option optional iplookup boolean false
17694 If &%optional%& is true, if no response is obtained from any host, the address
17695 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17696 delivery to the address is deferred.
17697
17698
17699 .option port iplookup integer 0
17700 .cindex "port" "&(iplookup)& router"
17701 This option must be supplied. It specifies the port number for the TCP or UDP
17702 call.
17703
17704
17705 .option protocol iplookup string udp
17706 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17707 protocols is to be used.
17708
17709
17710 .option query iplookup string&!! "see below"
17711 This defines the content of the query that is sent to the remote hosts. The
17712 default value is:
17713 .code
17714 $local_part@$domain $local_part@$domain
17715 .endd
17716 The repetition serves as a way of checking that a response is to the correct
17717 query in the default case (see &%response_pattern%& below).
17718
17719
17720 .option reroute iplookup string&!! unset
17721 If this option is not set, the rerouted address is precisely the byte string
17722 returned by the remote host, up to the first white space, if any. If set, the
17723 string is expanded to form the rerouted address. It can include parts matched
17724 in the response by &%response_pattern%& by means of numeric variables such as
17725 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17726 whether or not a pattern is in use. In all cases, the rerouted address must end
17727 up in the form &'local_part@domain'&.
17728
17729
17730 .option response_pattern iplookup string unset
17731 This option can be set to a regular expression that is applied to the string
17732 returned from the remote host. If the pattern does not match the response, the
17733 router declines. If &%response_pattern%& is not set, no checking of the
17734 response is done, unless the query was defaulted, in which case there is a
17735 check that the text returned after the first white space is the original
17736 address. This checks that the answer that has been received is in response to
17737 the correct question. For example, if the response is just a new domain, the
17738 following could be used:
17739 .code
17740 response_pattern = ^([^@]+)$
17741 reroute = $local_part@$1
17742 .endd
17743
17744 .option timeout iplookup time 5s
17745 This specifies the amount of time to wait for a response from the remote
17746 machine. The same timeout is used for the &[connect()]& function for a TCP
17747 call. It does not apply to UDP.
17748
17749
17750
17751
17752 . ////////////////////////////////////////////////////////////////////////////
17753 . ////////////////////////////////////////////////////////////////////////////
17754
17755 .chapter "The manualroute router" "CHID7"
17756 .scindex IIDmanrou1 "&(manualroute)& router"
17757 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17758 .cindex "domain" "manually routing"
17759 The &(manualroute)& router is so-called because it provides a way of manually
17760 routing an address according to its domain. It is mainly used when you want to
17761 route addresses to remote hosts according to your own rules, bypassing the
17762 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17763 route to local transports, a facility that may be useful if you want to save
17764 messages for dial-in hosts in local files.
17765
17766 The &(manualroute)& router compares a list of domain patterns with the domain
17767 it is trying to route. If there is no match, the router declines. Each pattern
17768 has associated with it a list of hosts and some other optional data, which may
17769 include a transport. The combination of a pattern and its data is called a
17770 &"routing rule"&. For patterns that do not have an associated transport, the
17771 generic &%transport%& option must specify a transport, unless the router is
17772 being used purely for verification (see &%verify_only%&).
17773
17774 .vindex "&$host$&"
17775 In the case of verification, matching the domain pattern is sufficient for the
17776 router to accept the address. When actually routing an address for delivery,
17777 an address that matches a domain pattern is queued for the associated
17778 transport. If the transport is not a local one, a host list must be associated
17779 with the pattern; IP addresses are looked up for the hosts, and these are
17780 passed to the transport along with the mail address. For local transports, a
17781 host list is optional. If it is present, it is passed in &$host$& as a single
17782 text string.
17783
17784 The list of routing rules can be provided as an inline string in
17785 &%route_list%&, or the data can be obtained by looking up the domain in a file
17786 or database by setting &%route_data%&. Only one of these settings may appear in
17787 any one instance of &(manualroute)&. The format of routing rules is described
17788 below, following the list of private options.
17789
17790
17791 .section "Private options for manualroute" "SECTprioptman"
17792
17793 .cindex "options" "&(manualroute)& router"
17794 The private options for the &(manualroute)& router are as follows:
17795
17796 .option host_all_ignored manualroute string defer
17797 See &%host_find_failed%&.
17798
17799 .option host_find_failed manualroute string freeze
17800 This option controls what happens when &(manualroute)& tries to find an IP
17801 address for a host, and the host does not exist. The option can be set to one
17802 of the following values:
17803 .code
17804 decline
17805 defer
17806 fail
17807 freeze
17808 ignore
17809 pass
17810 .endd
17811 The default (&"freeze"&) assumes that this state is a serious configuration
17812 error. The difference between &"pass"& and &"decline"& is that the former
17813 forces the address to be passed to the next router (or the router defined by
17814 &%pass_router%&),
17815 .oindex "&%more%&"
17816 overriding &%no_more%&, whereas the latter passes the address to the next
17817 router only if &%more%& is true.
17818
17819 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17820 cannot be found. If all the hosts in the list are ignored, the behaviour is
17821 controlled by the &%host_all_ignored%& option. This takes the same values
17822 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17823
17824 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17825 state; if a host lookup gets a temporary error, delivery is deferred unless the
17826 generic &%pass_on_timeout%& option is set.
17827
17828
17829 .option hosts_randomize manualroute boolean false
17830 .cindex "randomized host list"
17831 .cindex "host" "list of; randomized"
17832 If this option is set, the order of the items in a host list in a routing rule
17833 is randomized each time the list is used, unless an option in the routing rule
17834 overrides (see below). Randomizing the order of a host list can be used to do
17835 crude load sharing. However, if more than one mail address is routed by the
17836 same router to the same host list, the host lists are considered to be the same
17837 (even though they may be randomized into different orders) for the purpose of
17838 deciding whether to batch the deliveries into a single SMTP transaction.
17839
17840 When &%hosts_randomize%& is true, a host list may be split
17841 into groups whose order is separately randomized. This makes it possible to
17842 set up MX-like behaviour. The boundaries between groups are indicated by an
17843 item that is just &`+`& in the host list. For example:
17844 .code
17845 route_list = * host1:host2:host3:+:host4:host5
17846 .endd
17847 The order of the first three hosts and the order of the last two hosts is
17848 randomized for each use, but the first three always end up before the last two.
17849 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17850 randomized host list is passed to an &(smtp)& transport that also has
17851 &%hosts_randomize set%&, the list is not re-randomized.
17852
17853
17854 .option route_data manualroute string&!! unset
17855 If this option is set, it must expand to yield the data part of a routing rule.
17856 Typically, the expansion string includes a lookup based on the domain. For
17857 example:
17858 .code
17859 route_data = ${lookup{$domain}dbm{/etc/routes}}
17860 .endd
17861 If the expansion is forced to fail, or the result is an empty string, the
17862 router declines. Other kinds of expansion failure cause delivery to be
17863 deferred.
17864
17865
17866 .option route_list manualroute "string list" unset
17867 This string is a list of routing rules, in the form defined below. Note that,
17868 unlike most string lists, the items are separated by semicolons. This is so
17869 that they may contain colon-separated host lists.
17870
17871
17872 .option same_domain_copy_routing manualroute boolean false
17873 .cindex "address" "copying routing"
17874 Addresses with the same domain are normally routed by the &(manualroute)&
17875 router to the same list of hosts. However, this cannot be presumed, because the
17876 router options and preconditions may refer to the local part of the address. By
17877 default, therefore, Exim routes each address in a message independently. DNS
17878 servers run caches, so repeated DNS lookups are not normally expensive, and in
17879 any case, personal messages rarely have more than a few recipients.
17880
17881 If you are running mailing lists with large numbers of subscribers at the same
17882 domain, and you are using a &(manualroute)& router which is independent of the
17883 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17884 lookups for identical domains in one message. In this case, when
17885 &(manualroute)& routes an address to a remote transport, any other unrouted
17886 addresses in the message that have the same domain are automatically given the
17887 same routing without processing them independently. However, this is only done
17888 if &%headers_add%& and &%headers_remove%& are unset.
17889
17890
17891
17892
17893 .section "Routing rules in route_list" "SECID120"
17894 The value of &%route_list%& is a string consisting of a sequence of routing
17895 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17896 entered as two semicolons. Alternatively, the list separator can be changed as
17897 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17898 Empty rules are ignored. The format of each rule is
17899 .display
17900 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17901 .endd
17902 The following example contains two rules, each with a simple domain pattern and
17903 no options:
17904 .code
17905 route_list = \
17906   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17907   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17908 .endd
17909 The three parts of a rule are separated by white space. The pattern and the
17910 list of hosts can be enclosed in quotes if necessary, and if they are, the
17911 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17912 single domain pattern, which is the only mandatory item in the rule. The
17913 pattern is in the same format as one item in a domain list (see section
17914 &<<SECTdomainlist>>&),
17915 except that it may not be the name of an interpolated file.
17916 That is, it may be wildcarded, or a regular expression, or a file or database
17917 lookup (with semicolons doubled, because of the use of semicolon as a separator
17918 in a &%route_list%&).
17919
17920 The rules in &%route_list%& are searched in order until one of the patterns
17921 matches the domain that is being routed. The list of hosts and then options are
17922 then used as described below. If there is no match, the router declines. When
17923 &%route_list%& is set, &%route_data%& must not be set.
17924
17925
17926
17927 .section "Routing rules in route_data" "SECID121"
17928 The use of &%route_list%& is convenient when there are only a small number of
17929 routing rules. For larger numbers, it is easier to use a file or database to
17930 hold the routing information, and use the &%route_data%& option instead.
17931 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17932 Most commonly, &%route_data%& is set as a string that contains an
17933 expansion lookup. For example, suppose we place two routing rules in a file
17934 like this:
17935 .code
17936 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17937 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17938 .endd
17939 This data can be accessed by setting
17940 .code
17941 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17942 .endd
17943 Failure of the lookup results in an empty string, causing the router to
17944 decline. However, you do not have to use a lookup in &%route_data%&. The only
17945 requirement is that the result of expanding the string is a list of hosts,
17946 possibly followed by options, separated by white space. The list of hosts must
17947 be enclosed in quotes if it contains white space.
17948
17949
17950
17951
17952 .section "Format of the list of hosts" "SECID122"
17953 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17954 always separately expanded before use. If the expansion fails, the router
17955 declines. The result of the expansion must be a colon-separated list of names
17956 and/or IP addresses, optionally also including ports. The format of each item
17957 in the list is described in the next section. The list separator can be changed
17958 as described in section &<<SECTlistconstruct>>&.
17959
17960 If the list of hosts was obtained from a &%route_list%& item, the following
17961 variables are set during its expansion:
17962
17963 .ilist
17964 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17965 If the domain was matched against a regular expression, the numeric variables
17966 &$1$&, &$2$&, etc. may be set. For example:
17967 .code
17968 route_list = ^domain(\d+)   host-$1.text.example
17969 .endd
17970 .next
17971 &$0$& is always set to the entire domain.
17972 .next
17973 &$1$& is also set when partial matching is done in a file lookup.
17974
17975 .next
17976 .vindex "&$value$&"
17977 If the pattern that matched the domain was a lookup item, the data that was
17978 looked up is available in the expansion variable &$value$&. For example:
17979 .code
17980 route_list = lsearch;;/some/file.routes  $value
17981 .endd
17982 .endlist
17983
17984 Note the doubling of the semicolon in the pattern that is necessary because
17985 semicolon is the default route list separator.
17986
17987
17988
17989 .section "Format of one host item" "SECTformatonehostitem"
17990 Each item in the list of hosts is either a host name or an IP address,
17991 optionally with an attached port number. When no port is given, an IP address
17992 is not enclosed in brackets. When a port is specified, it overrides the port
17993 specification on the transport. The port is separated from the name or address
17994 by a colon. This leads to some complications:
17995
17996 .ilist
17997 Because colon is the default separator for the list of hosts, either
17998 the colon that specifies a port must be doubled, or the list separator must
17999 be changed. The following two examples have the same effect:
18000 .code
18001 route_list = * "host1.tld::1225 : host2.tld::1226"
18002 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18003 .endd
18004 .next
18005 When IPv6 addresses are involved, it gets worse, because they contain
18006 colons of their own. To make this case easier, it is permitted to
18007 enclose an IP address (either v4 or v6) in square brackets if a port
18008 number follows. For example:
18009 .code
18010 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18011 .endd
18012 .endlist
18013
18014 .section "How the list of hosts is used" "SECThostshowused"
18015 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18016 the hosts is tried, in the order specified, when carrying out the SMTP
18017 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18018 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18019 transport.
18020
18021 Hosts may be listed by name or by IP address. An unadorned name in the list of
18022 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18023 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18024 records in the DNS. For example:
18025 .code
18026 route_list = *  x.y.z:p.q.r/MX:e.f.g
18027 .endd
18028 If this feature is used with a port specifier, the port must come last. For
18029 example:
18030 .code
18031 route_list = *  dom1.tld/mx::1225
18032 .endd
18033 If the &%hosts_randomize%& option is set, the order of the items in the list is
18034 randomized before any lookups are done. Exim then scans the list; for any name
18035 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18036 be an interface on the local host and the item is not the first in the list,
18037 Exim discards it and any subsequent items. If it is the first item, what
18038 happens is controlled by the
18039 .oindex "&%self%&" "in &(manualroute)& router"
18040 &%self%& option of the router.
18041
18042 A name on the list that is followed by &`/MX`& is replaced with the list of
18043 hosts obtained by looking up MX records for the name. This is always a DNS
18044 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18045 below) are not relevant here. The order of these hosts is determined by the
18046 preference values in the MX records, according to the usual rules. Because
18047 randomizing happens before the MX lookup, it does not affect the order that is
18048 defined by MX preferences.
18049
18050 If the local host is present in the sublist obtained from MX records, but is
18051 not the most preferred host in that list, it and any equally or less
18052 preferred hosts are removed before the sublist is inserted into the main list.
18053
18054 If the local host is the most preferred host in the MX list, what happens
18055 depends on where in the original list of hosts the &`/MX`& item appears. If it
18056 is not the first item (that is, there are previous hosts in the main list),
18057 Exim discards this name and any subsequent items in the main list.
18058
18059 If the MX item is first in the list of hosts, and the local host is the
18060 most preferred host, what happens is controlled by the &%self%& option of the
18061 router.
18062
18063 DNS failures when lookup up the MX records are treated in the same way as DNS
18064 failures when looking up IP addresses: &%pass_on_timeout%& and
18065 &%host_find_failed%& are used when relevant.
18066
18067 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18068 whether obtained from an MX lookup or not.
18069
18070
18071
18072 .section "How the options are used" "SECThowoptused"
18073 The options are a sequence of words; in practice no more than three are ever
18074 present. One of the words can be the name of a transport; this overrides the
18075 &%transport%& option on the router for this particular routing rule only. The
18076 other words (if present) control randomization of the list of hosts on a
18077 per-rule basis, and how the IP addresses of the hosts are to be found when
18078 routing to a remote transport. These options are as follows:
18079
18080 .ilist
18081 &%randomize%&: randomize the order of the hosts in this list, overriding the
18082 setting of &%hosts_randomize%& for this routing rule only.
18083 .next
18084 &%no_randomize%&: do not randomize the order of the hosts in this list,
18085 overriding the setting of &%hosts_randomize%& for this routing rule only.
18086 .next
18087 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18088 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18089 also look in &_/etc/hosts_& or other sources of information.
18090 .next
18091 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18092 no address records are found. If there is a temporary DNS error (such as a
18093 timeout), delivery is deferred.
18094 .endlist
18095
18096 For example:
18097 .code
18098 route_list = domain1  host1:host2:host3  randomize bydns;\
18099              domain2  host4:host5
18100 .endd
18101 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18102 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18103 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18104 or &[gethostbyname()]&, and the result of the lookup is the result of that
18105 call.
18106
18107 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18108 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18109 instead of TRY_AGAIN. That is why the default action is to try a DNS
18110 lookup first. Only if that gives a definite &"no such host"& is the local
18111 function called.
18112
18113
18114
18115 If no IP address for a host can be found, what happens is controlled by the
18116 &%host_find_failed%& option.
18117
18118 .vindex "&$host$&"
18119 When an address is routed to a local transport, IP addresses are not looked up.
18120 The host list is passed to the transport in the &$host$& variable.
18121
18122
18123
18124 .section "Manualroute examples" "SECID123"
18125 In some of the examples that follow, the presence of the &%remote_smtp%&
18126 transport, as defined in the default configuration file, is assumed:
18127
18128 .ilist
18129 .cindex "smart host" "example router"
18130 The &(manualroute)& router can be used to forward all external mail to a
18131 &'smart host'&. If you have set up, in the main part of the configuration, a
18132 named domain list that contains your local domains, for example:
18133 .code
18134 domainlist local_domains = my.domain.example
18135 .endd
18136 You can arrange for all other domains to be routed to a smart host by making
18137 your first router something like this:
18138 .code
18139 smart_route:
18140   driver = manualroute
18141   domains = !+local_domains
18142   transport = remote_smtp
18143   route_list = * smarthost.ref.example
18144 .endd
18145 This causes all non-local addresses to be sent to the single host
18146 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18147 they are tried in order
18148 (but you can use &%hosts_randomize%& to vary the order each time).
18149 Another way of configuring the same thing is this:
18150 .code
18151 smart_route:
18152   driver = manualroute
18153   transport = remote_smtp
18154   route_list = !+local_domains  smarthost.ref.example
18155 .endd
18156 There is no difference in behaviour between these two routers as they stand.
18157 However, they behave differently if &%no_more%& is added to them. In the first
18158 example, the router is skipped if the domain does not match the &%domains%&
18159 precondition; the following router is always tried. If the router runs, it
18160 always matches the domain and so can never decline. Therefore, &%no_more%&
18161 would have no effect. In the second case, the router is never skipped; it
18162 always runs. However, if it doesn't match the domain, it declines. In this case
18163 &%no_more%& would prevent subsequent routers from running.
18164
18165 .next
18166 .cindex "mail hub example"
18167 A &'mail hub'& is a host which receives mail for a number of domains via MX
18168 records in the DNS and delivers it via its own private routing mechanism. Often
18169 the final destinations are behind a firewall, with the mail hub being the one
18170 machine that can connect to machines both inside and outside the firewall. The
18171 &(manualroute)& router is usually used on a mail hub to route incoming messages
18172 to the correct hosts. For a small number of domains, the routing can be inline,
18173 using the &%route_list%& option, but for a larger number a file or database
18174 lookup is easier to manage.
18175
18176 If the domain names are in fact the names of the machines to which the mail is
18177 to be sent by the mail hub, the configuration can be quite simple. For
18178 example:
18179 .code
18180 hub_route:
18181   driver = manualroute
18182   transport = remote_smtp
18183   route_list = *.rhodes.tvs.example  $domain
18184 .endd
18185 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18186 whose names are the same as the mail domains. A similar approach can be taken
18187 if the host name can be obtained from the domain name by a string manipulation
18188 that the expansion facilities can handle. Otherwise, a lookup based on the
18189 domain can be used to find the host:
18190 .code
18191 through_firewall:
18192   driver = manualroute
18193   transport = remote_smtp
18194   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18195 .endd
18196 The result of the lookup must be the name or IP address of the host (or
18197 hosts) to which the address is to be routed. If the lookup fails, the route
18198 data is empty, causing the router to decline. The address then passes to the
18199 next router.
18200
18201 .next
18202 .cindex "batched SMTP output example"
18203 .cindex "SMTP" "batched outgoing; example"
18204 You can use &(manualroute)& to deliver messages to pipes or files in batched
18205 SMTP format for onward transportation by some other means. This is one way of
18206 storing mail for a dial-up host when it is not connected. The route list entry
18207 can be as simple as a single domain name in a configuration like this:
18208 .code
18209 save_in_file:
18210   driver = manualroute
18211   transport = batchsmtp_appendfile
18212   route_list = saved.domain.example
18213 .endd
18214 though often a pattern is used to pick up more than one domain. If there are
18215 several domains or groups of domains with different transport requirements,
18216 different transports can be listed in the routing information:
18217 .code
18218 save_in_file:
18219   driver = manualroute
18220   route_list = \
18221     *.saved.domain1.example  $domain  batch_appendfile; \
18222     *.saved.domain2.example  \
18223       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18224       batch_pipe
18225 .endd
18226 .vindex "&$domain$&"
18227 .vindex "&$host$&"
18228 The first of these just passes the domain in the &$host$& variable, which
18229 doesn't achieve much (since it is also in &$domain$&), but the second does a
18230 file lookup to find a value to pass, causing the router to decline to handle
18231 the address if the lookup fails.
18232
18233 .next
18234 .cindex "UUCP" "example of router for"
18235 Routing mail directly to UUCP software is a specific case of the use of
18236 &(manualroute)& in a gateway to another mail environment. This is an example of
18237 one way it can be done:
18238 .code
18239 # Transport
18240 uucp:
18241   driver = pipe
18242   user = nobody
18243   command = /usr/local/bin/uux -r - \
18244     ${substr_-5:$host}!rmail ${local_part}
18245   return_fail_output = true
18246
18247 # Router
18248 uucphost:
18249   transport = uucp
18250   driver = manualroute
18251   route_data = \
18252     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18253 .endd
18254 The file &_/usr/local/exim/uucphosts_& contains entries like
18255 .code
18256 darksite.ethereal.example:           darksite.UUCP
18257 .endd
18258 It can be set up more simply without adding and removing &".UUCP"& but this way
18259 makes clear the distinction between the domain name
18260 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18261 .endlist
18262 .ecindex IIDmanrou1
18263 .ecindex IIDmanrou2
18264
18265
18266
18267
18268
18269
18270
18271
18272 . ////////////////////////////////////////////////////////////////////////////
18273 . ////////////////////////////////////////////////////////////////////////////
18274
18275 .chapter "The queryprogram router" "CHAPdriverlast"
18276 .scindex IIDquerou1 "&(queryprogram)& router"
18277 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18278 .cindex "routing" "by external program"
18279 The &(queryprogram)& router routes an address by running an external command
18280 and acting on its output. This is an expensive way to route, and is intended
18281 mainly for use in lightly-loaded systems, or for performing experiments.
18282 However, if it is possible to use the precondition options (&%domains%&,
18283 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18284 be used in special cases, even on a busy host. There are the following private
18285 options:
18286 .cindex "options" "&(queryprogram)& router"
18287
18288 .option command queryprogram string&!! unset
18289 This option must be set. It specifies the command that is to be run. The
18290 command is split up into a command name and arguments, and then each is
18291 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18292 &<<CHAPpipetransport>>&).
18293
18294
18295 .option command_group queryprogram string unset
18296 .cindex "gid (group id)" "in &(queryprogram)& router"
18297 This option specifies a gid to be set when running the command while routing an
18298 address for deliver. It must be set if &%command_user%& specifies a numerical
18299 uid. If it begins with a digit, it is interpreted as the numerical value of the
18300 gid. Otherwise it is looked up using &[getgrnam()]&.
18301
18302
18303 .option command_user queryprogram string unset
18304 .cindex "uid (user id)" "for &(queryprogram)&"
18305 This option must be set. It specifies the uid which is set when running the
18306 command while routing an address for delivery. If the value begins with a digit,
18307 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18308 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18309 not set, a value for the gid also.
18310
18311 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18312 root, which it does during a normal delivery in a conventional configuration.
18313 However, when an address is being verified during message reception, Exim is
18314 usually running as the Exim user, not as root. If the &(queryprogram)& router
18315 is called from a non-root process, Exim cannot change uid or gid before running
18316 the command. In this circumstance the command runs under the current uid and
18317 gid.
18318
18319
18320 .option current_directory queryprogram string /
18321 This option specifies an absolute path which is made the current directory
18322 before running the command.
18323
18324
18325 .option timeout queryprogram time 1h
18326 If the command does not complete within the timeout period, its process group
18327 is killed and the message is frozen. A value of zero time specifies no
18328 timeout.
18329
18330
18331 The standard output of the command is connected to a pipe, which is read when
18332 the command terminates. It should consist of a single line of output,
18333 containing up to five fields, separated by white space. The maximum length of
18334 the line is 1023 characters. Longer lines are silently truncated. The first
18335 field is one of the following words (case-insensitive):
18336
18337 .ilist
18338 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18339 below).
18340 .next
18341 &'Decline'&: the router declines; pass the address to the next router, unless
18342 &%no_more%& is set.
18343 .next
18344 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18345 subsequent text on the line is an error message. If the router is run as part
18346 of address verification during an incoming SMTP message, the message is
18347 included in the SMTP response.
18348 .next
18349 &'Defer'&: routing could not be completed at this time; try again later. Any
18350 subsequent text on the line is an error message which is logged. It is not
18351 included in any SMTP response.
18352 .next
18353 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18354 .next
18355 &'Pass'&: pass the address to the next router (or the router specified by
18356 &%pass_router%&), overriding &%no_more%&.
18357 .next
18358 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18359 new addresses, which are routed independently, starting with the first router,
18360 or the router specified by &%redirect_router%&, if set.
18361 .endlist
18362
18363 When the first word is &'accept'&, the remainder of the line consists of a
18364 number of keyed data values, as follows (split into two lines here, to fit on
18365 the page):
18366 .code
18367 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18368 LOOKUP=byname|bydns DATA=<text>
18369 .endd
18370 The data items can be given in any order, and all are optional. If no transport
18371 is included, the transport specified by the generic &%transport%& option is
18372 used. The list of hosts and the lookup type are needed only if the transport is
18373 an &(smtp)& transport that does not itself supply a list of hosts.
18374
18375 The format of the list of hosts is the same as for the &(manualroute)& router.
18376 As well as host names and IP addresses with optional port numbers, as described
18377 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18378 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18379 (see section &<<SECThostshowused>>&).
18380
18381 If the lookup type is not specified, Exim behaves as follows when trying to
18382 find an IP address for each host: First, a DNS lookup is done. If this yields
18383 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18384 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18385 result of the lookup is the result of that call.
18386
18387 .vindex "&$address_data$&"
18388 If the DATA field is set, its value is placed in the &$address_data$&
18389 variable. For example, this return line
18390 .code
18391 accept hosts=x1.y.example:x2.y.example data="rule1"
18392 .endd
18393 routes the address to the default transport, passing a list of two hosts. When
18394 the transport runs, the string &"rule1"& is in &$address_data$&.
18395 .ecindex IIDquerou1
18396 .ecindex IIDquerou2
18397
18398
18399
18400
18401 . ////////////////////////////////////////////////////////////////////////////
18402 . ////////////////////////////////////////////////////////////////////////////
18403
18404 .chapter "The redirect router" "CHAPredirect"
18405 .scindex IIDredrou1 "&(redirect)& router"
18406 .scindex IIDredrou2 "routers" "&(redirect)&"
18407 .cindex "alias file" "in a &(redirect)& router"
18408 .cindex "address redirection" "&(redirect)& router"
18409 The &(redirect)& router handles several kinds of address redirection. Its most
18410 common uses are for resolving local part aliases from a central alias file
18411 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18412 files, but it has many other potential uses. The incoming address can be
18413 redirected in several different ways:
18414
18415 .ilist
18416 It can be replaced by one or more new addresses which are themselves routed
18417 independently.
18418 .next
18419 It can be routed to be delivered to a given file or directory.
18420 .next
18421 It can be routed to be delivered to a specified pipe command.
18422 .next
18423 It can cause an automatic reply to be generated.
18424 .next
18425 It can be forced to fail, optionally with a custom error message.
18426 .next
18427 It can be temporarily deferred, optionally with a custom message.
18428 .next
18429 It can be discarded.
18430 .endlist
18431
18432 The generic &%transport%& option must not be set for &(redirect)& routers.
18433 However, there are some private options which define transports for delivery to
18434 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18435 &%pipe_transport%& and &%reply_transport%& descriptions below.
18436
18437
18438
18439 .section "Redirection data" "SECID124"
18440 The router operates by interpreting a text string which it obtains either by
18441 expanding the contents of the &%data%& option, or by reading the entire
18442 contents of a file whose name is given in the &%file%& option. These two
18443 options are mutually exclusive. The first is commonly used for handling system
18444 aliases, in a configuration like this:
18445 .code
18446 system_aliases:
18447   driver = redirect
18448   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18449 .endd
18450 If the lookup fails, the expanded string in this example is empty. When the
18451 expansion of &%data%& results in an empty string, the router declines. A forced
18452 expansion failure also causes the router to decline; other expansion failures
18453 cause delivery to be deferred.
18454
18455 A configuration using &%file%& is commonly used for handling users'
18456 &_.forward_& files, like this:
18457 .code
18458 userforward:
18459   driver = redirect
18460   check_local_user
18461   file = $home/.forward
18462   no_verify
18463 .endd
18464 If the file does not exist, or causes no action to be taken (for example, it is
18465 empty or consists only of comments), the router declines. &*Warning*&: This
18466 is not the case when the file contains syntactically valid items that happen to
18467 yield empty addresses, for example, items containing only RFC 2822 address
18468 comments.
18469
18470
18471
18472 .section "Forward files and address verification" "SECID125"
18473 .cindex "address redirection" "while verifying"
18474 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18475 &_.forward_& files, as in the example above. There are two reasons for this:
18476
18477 .ilist
18478 When Exim is receiving an incoming SMTP message from a remote host, it is
18479 running under the Exim uid, not as root. Exim is unable to change uid to read
18480 the file as the user, and it may not be able to read it as the Exim user. So in
18481 practice the router may not be able to operate.
18482 .next
18483 However, even when the router can operate, the existence of a &_.forward_& file
18484 is unimportant when verifying an address. What should be checked is whether the
18485 local part is a valid user name or not. Cutting out the redirection processing
18486 saves some resources.
18487 .endlist
18488
18489
18490
18491
18492
18493
18494 .section "Interpreting redirection data" "SECID126"
18495 .cindex "Sieve filter" "specifying in redirection data"
18496 .cindex "filter" "specifying in redirection data"
18497 The contents of the data string, whether obtained from &%data%& or &%file%&,
18498 can be interpreted in two different ways:
18499
18500 .ilist
18501 If the &%allow_filter%& option is set true, and the data begins with the text
18502 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18503 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18504 respectively. Details of the syntax and semantics of filter files are described
18505 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18506 document is intended for use by end users.
18507 .next
18508 Otherwise, the data must be a comma-separated list of redirection items, as
18509 described in the next section.
18510 .endlist
18511
18512 When a message is redirected to a file (a &"mail folder"&), the file name given
18513 in a non-filter redirection list must always be an absolute path. A filter may
18514 generate a relative path &-- how this is handled depends on the transport's
18515 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18516 for the &(appendfile)& transport.
18517
18518
18519
18520 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18521 .cindex "address redirection" "non-filter list items"
18522 When the redirection data is not an Exim or Sieve filter, for example, if it
18523 comes from a conventional alias or forward file, it consists of a list of
18524 addresses, file names, pipe commands, or certain special items (see section
18525 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18526 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18527 depending on their default values. The items in the list are separated by
18528 commas or newlines.
18529 If a comma is required in an item, the entire item must be enclosed in double
18530 quotes.
18531
18532 Lines starting with a # character are comments, and are ignored, and # may
18533 also appear following a comma, in which case everything between the # and the
18534 next newline character is ignored.
18535
18536 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18537 double quotes are retained because some forms of mail address require their use
18538 (but never to enclose the entire address). In the following description,
18539 &"item"& refers to what remains after any surrounding double quotes have been
18540 removed.
18541
18542 .vindex "&$local_part$&"
18543 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18544 and the expansion contains a reference to &$local_part$&, you should make use
18545 of the &%quote_local_part%& expansion operator, in case the local part contains
18546 special characters. For example, to redirect all mail for the domain
18547 &'obsolete.example'&, retaining the existing local part, you could use this
18548 setting:
18549 .code
18550 data = ${quote_local_part:$local_part}@newdomain.example
18551 .endd
18552
18553
18554 .section "Redirecting to a local mailbox" "SECTredlocmai"
18555 .cindex "routing" "loops in"
18556 .cindex "loop" "while routing, avoidance of"
18557 .cindex "address redirection" "to local mailbox"
18558 A redirection item may safely be the same as the address currently under
18559 consideration. This does not cause a routing loop, because a router is
18560 automatically skipped if any ancestor of the address that is being processed
18561 is the same as the current address and was processed by the current router.
18562 Such an address is therefore passed to the following routers, so it is handled
18563 as if there were no redirection. When making this loop-avoidance test, the
18564 complete local part, including any prefix or suffix, is used.
18565
18566 .cindex "address redirection" "local part without domain"
18567 Specifying the same local part without a domain is a common usage in personal
18568 filter files when the user wants to have messages delivered to the local
18569 mailbox and also forwarded elsewhere. For example, the user whose login is
18570 &'cleo'& might have a &_.forward_& file containing this:
18571 .code
18572 cleo, cleopatra@egypt.example
18573 .endd
18574 .cindex "backslash in alias file"
18575 .cindex "alias file" "backslash in"
18576 For compatibility with other MTAs, such unqualified local parts may be
18577 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18578 it does make a difference if more than one domain is being handled
18579 synonymously.
18580
18581 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18582 2822 address that does not include a domain, the item is qualified using the
18583 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18584 addresses are qualified using the value in &%qualify_recipient%&, but you can
18585 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18586
18587 Care must be taken if there are alias names for local users.
18588 Consider an MTA handling a single local domain where the system alias file
18589 contains:
18590 .code
18591 Sam.Reman: spqr
18592 .endd
18593 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18594 messages in the local mailbox, and also forward copies elsewhere. He creates
18595 this forward file:
18596 .code
18597 Sam.Reman, spqr@reme.elsewhere.example
18598 .endd
18599 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18600 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18601 second time round, because it has previously routed it,
18602 and the following routers presumably cannot handle the alias. The forward file
18603 should really contain
18604 .code
18605 spqr, spqr@reme.elsewhere.example
18606 .endd
18607 but because this is such a common error, the &%check_ancestor%& option (see
18608 below) exists to provide a way to get round it. This is normally set on a
18609 &(redirect)& router that is handling users' &_.forward_& files.
18610
18611
18612
18613 .section "Special items in redirection lists" "SECTspecitredli"
18614 In addition to addresses, the following types of item may appear in redirection
18615 lists (that is, in non-filter redirection data):
18616
18617 .ilist
18618 .cindex "pipe" "in redirection list"
18619 .cindex "address redirection" "to pipe"
18620 An item is treated as a pipe command if it begins with &"|"& and does not parse
18621 as a valid RFC 2822 address that includes a domain. A transport for running the
18622 command must be specified by the &%pipe_transport%& option.
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 Single or double quotes can be used for enclosing the individual arguments of
18627 the pipe command; no interpretation of escapes is done for single quotes. If
18628 the command contains a comma character, it is necessary to put the whole item
18629 in double quotes, for example:
18630 .code
18631 "|/some/command ready,steady,go"
18632 .endd
18633 since items in redirection lists are terminated by commas. Do not, however,
18634 quote just the command. An item such as
18635 .code
18636 |"/some/command ready,steady,go"
18637 .endd
18638 is interpreted as a pipe with a rather strange command name, and no arguments.
18639
18640 .new
18641 Note that the above example assumes that the text comes from a lookup source
18642 of some sort, so that the quotes are part of the data.  If composing a
18643 redirect router with a &%data%& option directly specifying this command, the
18644 quotes will be used by the configuration parser to define the extent of one
18645 string, but will not be passed down into the redirect router itself.  There
18646 are two main approaches to get around this: escape quotes to be part of the
18647 data itself, or avoid using this mechanism and instead create a custom
18648 transport with the &%command%& option set and reference that transport from
18649 an &%accept%& router.
18650 .wen
18651
18652 .next
18653 .cindex "file" "in redirection list"
18654 .cindex "address redirection" "to file"
18655 An item is interpreted as a path name if it begins with &"/"& and does not
18656 parse as a valid RFC 2822 address that includes a domain. For example,
18657 .code
18658 /home/world/minbari
18659 .endd
18660 is treated as a file name, but
18661 .code
18662 /s=molari/o=babylon/@x400gate.way
18663 .endd
18664 is treated as an address. For a file name, a transport must be specified using
18665 the &%file_transport%& option. However, if the generated path name ends with a
18666 forward slash character, it is interpreted as a directory name rather than a
18667 file name, and &%directory_transport%& is used instead.
18668
18669 Normally, either the router or the transport specifies a user and a group under
18670 which to run the delivery. The default is to use the Exim user and group.
18671
18672 .cindex "&_/dev/null_&"
18673 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18674 bypassed at a high level, and the log entry shows &"**bypassed**"&
18675 instead of a transport name. In this case the user and group are not used.
18676
18677 .next
18678 .cindex "included address list"
18679 .cindex "address redirection" "included external list"
18680 If an item is of the form
18681 .code
18682 :include:<path name>
18683 .endd
18684 a list of further items is taken from the given file and included at that
18685 point. &*Note*&: Such a file can not be a filter file; it is just an
18686 out-of-line addition to the list. The items in the included list are separated
18687 by commas or newlines and are not subject to expansion. If this is the first
18688 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18689 the alias name. This example is incorrect:
18690 .code
18691 list1    :include:/opt/lists/list1
18692 .endd
18693 It must be given as
18694 .code
18695 list1:   :include:/opt/lists/list1
18696 .endd
18697 .next
18698 .cindex "address redirection" "to black hole"
18699 Sometimes you want to throw away mail to a particular local part. Making the
18700 &%data%& option expand to an empty string does not work, because that causes
18701 the router to decline. Instead, the alias item
18702 .cindex "black hole"
18703 .cindex "abandoning mail"
18704 &':blackhole:'& can be used. It does what its name implies. No delivery is
18705 done, and no error message is generated. This has the same effect as specifing
18706 &_/dev/null_& as a destination, but it can be independently disabled.
18707
18708 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18709 delivery is done for the original local part, even if other redirection items
18710 are present. If you are generating a multi-item list (for example, by reading a
18711 database) and need the ability to provide a no-op item, you must use
18712 &_/dev/null_&.
18713
18714 .next
18715 .cindex "delivery" "forcing failure"
18716 .cindex "delivery" "forcing deferral"
18717 .cindex "failing delivery" "forcing"
18718 .cindex "deferred delivery, forcing"
18719 .cindex "customizing" "failure message"
18720 An attempt to deliver a particular address can be deferred or forced to fail by
18721 redirection items of the form
18722 .code
18723 :defer:
18724 :fail:
18725 .endd
18726 respectively. When a redirection list contains such an item, it applies
18727 to the entire redirection; any other items in the list are ignored. Any
18728 text following &':fail:'& or &':defer:'& is placed in the error text
18729 associated with the failure. For example, an alias file might contain:
18730 .code
18731 X.Employee:  :fail: Gone away, no forwarding address
18732 .endd
18733 In the case of an address that is being verified from an ACL or as the subject
18734 of a
18735 .cindex "VRFY" "error text, display of"
18736 VRFY command, the text is included in the SMTP error response by
18737 default.
18738 .cindex "EXPN" "error text, display of"
18739 The text is not included in the response to an EXPN command. In non-SMTP cases
18740 the text is included in the error message that Exim generates.
18741
18742 .cindex "SMTP" "error codes"
18743 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18744 &':fail:'&. However, if the message starts with three digits followed by a
18745 space, optionally followed by an extended code of the form &'n.n.n'&, also
18746 followed by a space, and the very first digit is the same as the default error
18747 code, the code from the message is used instead. If the very first digit is
18748 incorrect, a panic error is logged, and the default code is used. You can
18749 suppress the use of the supplied code in a redirect router by setting the
18750 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18751 ignored.
18752
18753 .vindex "&$acl_verify_message$&"
18754 In an ACL, an explicitly provided message overrides the default, but the
18755 default message is available in the variable &$acl_verify_message$& and can
18756 therefore be included in a custom message if this is desired.
18757
18758 Normally the error text is the rest of the redirection list &-- a comma does
18759 not terminate it &-- but a newline does act as a terminator. Newlines are not
18760 normally present in alias expansions. In &(lsearch)& lookups they are removed
18761 as part of the continuation process, but they may exist in other kinds of
18762 lookup and in &':include:'& files.
18763
18764 During routing for message delivery (as opposed to verification), a redirection
18765 containing &':fail:'& causes an immediate failure of the incoming address,
18766 whereas &':defer:'& causes the message to remain on the queue so that a
18767 subsequent delivery attempt can happen at a later time. If an address is
18768 deferred for too long, it will ultimately fail, because the normal retry
18769 rules still apply.
18770
18771 .next
18772 .cindex "alias file" "exception to default"
18773 Sometimes it is useful to use a single-key search type with a default (see
18774 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18775 for exceptions to the default. These can be handled by aliasing them to
18776 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18777 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18778 results in an empty redirection list has the same effect.
18779 .endlist
18780
18781
18782 .section "Duplicate addresses" "SECTdupaddr"
18783 .cindex "duplicate addresses"
18784 .cindex "address duplicate, discarding"
18785 .cindex "pipe" "duplicated"
18786 Exim removes duplicate addresses from the list to which it is delivering, so as
18787 to deliver just one copy to each address. This does not apply to deliveries
18788 routed to pipes by different immediate parent addresses, but an indirect
18789 aliasing scheme of the type
18790 .code
18791 pipe:       |/some/command $local_part
18792 localpart1: pipe
18793 localpart2: pipe
18794 .endd
18795 does not work with a message that is addressed to both local parts, because
18796 when the second is aliased to the intermediate local part &"pipe"& it gets
18797 discarded as being the same as a previously handled address. However, a scheme
18798 such as
18799 .code
18800 localpart1: |/some/command $local_part
18801 localpart2: |/some/command $local_part
18802 .endd
18803 does result in two different pipe deliveries, because the immediate parents of
18804 the pipes are distinct.
18805
18806
18807
18808 .section "Repeated redirection expansion" "SECID128"
18809 .cindex "repeated redirection expansion"
18810 .cindex "address redirection" "repeated for each delivery attempt"
18811 When a message cannot be delivered to all of its recipients immediately,
18812 leading to two or more delivery attempts, redirection expansion is carried out
18813 afresh each time for those addresses whose children were not all previously
18814 delivered. If redirection is being used as a mailing list, this can lead to new
18815 members of the list receiving copies of old messages. The &%one_time%& option
18816 can be used to avoid this.
18817
18818
18819 .section "Errors in redirection lists" "SECID129"
18820 .cindex "address redirection" "errors"
18821 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18822 error is skipped, and an entry is written to the main log. This may be useful
18823 for mailing lists that are automatically managed. Otherwise, if an error is
18824 detected while generating the list of new addresses, the original address is
18825 deferred. See also &%syntax_errors_to%&.
18826
18827
18828
18829 .section "Private options for the redirect router" "SECID130"
18830
18831 .cindex "options" "&(redirect)& router"
18832 The private options for the &(redirect)& router are as follows:
18833
18834
18835 .option allow_defer redirect boolean false
18836 Setting this option allows the use of &':defer:'& in non-filter redirection
18837 data, or the &%defer%& command in an Exim filter file.
18838
18839
18840 .option allow_fail redirect boolean false
18841 .cindex "failing delivery" "from filter"
18842 If this option is true, the &':fail:'& item can be used in a redirection list,
18843 and the &%fail%& command may be used in an Exim filter file.
18844
18845
18846 .option allow_filter redirect boolean false
18847 .cindex "filter" "enabling use of"
18848 .cindex "Sieve filter" "enabling use of"
18849 Setting this option allows Exim to interpret redirection data that starts with
18850 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18851 are some features of Exim filter files that some administrators may wish to
18852 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18853
18854 It is also possible to lock out Exim filters or Sieve filters while allowing
18855 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18856
18857
18858 The filter is run using the uid and gid set by the generic &%user%& and
18859 &%group%& options. These take their defaults from the password data if
18860 &%check_local_user%& is set, so in the normal case of users' personal filter
18861 files, the filter is run as the relevant user. When &%allow_filter%& is set
18862 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18863
18864
18865
18866 .option allow_freeze redirect boolean false
18867 .cindex "freezing messages" "allowing in filter"
18868 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18869 This command is more normally encountered in system filters, and is disabled by
18870 default for redirection filters because it isn't something you usually want to
18871 let ordinary users do.
18872
18873
18874
18875 .option check_ancestor redirect boolean false
18876 This option is concerned with handling generated addresses that are the same
18877 as some address in the list of redirection ancestors of the current address.
18878 Although it is turned off by default in the code, it is set in the default
18879 configuration file for handling users' &_.forward_& files. It is recommended
18880 for this use of the &(redirect)& router.
18881
18882 When &%check_ancestor%& is set, if a generated address (including the domain)
18883 is the same as any ancestor of the current address, it is replaced by a copy of
18884 the current address. This helps in the case where local part A is aliased to B,
18885 and B has a &_.forward_& file pointing back to A. For example, within a single
18886 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18887 &_&~jb/.forward_& contains:
18888 .code
18889 \Joe.Bloggs, <other item(s)>
18890 .endd
18891 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18892 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18893 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18894 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18895 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18896 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18897 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18898 original address. See also the &%repeat_use%& option below.
18899
18900
18901 .option check_group redirect boolean "see below"
18902 When the &%file%& option is used, the group owner of the file is checked only
18903 when this option is set. The permitted groups are those listed in the
18904 &%owngroups%& option, together with the user's default group if
18905 &%check_local_user%& is set. If the file has the wrong group, routing is
18906 deferred. The default setting for this option is true if &%check_local_user%&
18907 is set and the &%modemask%& option permits the group write bit, or if the
18908 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18909
18910
18911
18912 .option check_owner redirect boolean "see below"
18913 When the &%file%& option is used, the owner of the file is checked only when
18914 this option is set. If &%check_local_user%& is set, the local user is
18915 permitted; otherwise the owner must be one of those listed in the &%owners%&
18916 option. The default value for this option is true if &%check_local_user%& or
18917 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18918
18919
18920 .option data redirect string&!! unset
18921 This option is mutually exclusive with &%file%&. One or other of them must be
18922 set, but not both. The contents of &%data%& are expanded, and then used as the
18923 list of forwarding items, or as a set of filtering instructions. If the
18924 expansion is forced to fail, or the result is an empty string or a string that
18925 has no effect (consists entirely of comments), the router declines.
18926
18927 When filtering instructions are used, the string must begin with &"#Exim
18928 filter"&, and all comments in the string, including this initial one, must be
18929 terminated with newline characters. For example:
18930 .code
18931 data = #Exim filter\n\
18932        if $h_to: contains Exim then save $home/mail/exim endif
18933 .endd
18934 If you are reading the data from a database where newlines cannot be included,
18935 you can use the &${sg}$& expansion item to turn the escape string of your
18936 choice into a newline.
18937
18938
18939 .option directory_transport redirect string&!! unset
18940 A &(redirect)& router sets up a direct delivery to a directory when a path name
18941 ending with a slash is specified as a new &"address"&. The transport used is
18942 specified by this option, which, after expansion, must be the name of a
18943 configured transport. This should normally be an &(appendfile)& transport.
18944
18945
18946 .option file redirect string&!! unset
18947 This option specifies the name of a file that contains the redirection data. It
18948 is mutually exclusive with the &%data%& option. The string is expanded before
18949 use; if the expansion is forced to fail, the router declines. Other expansion
18950 failures cause delivery to be deferred. The result of a successful expansion
18951 must be an absolute path. The entire file is read and used as the redirection
18952 data. If the data is an empty string or a string that has no effect (consists
18953 entirely of comments), the router declines.
18954
18955 .cindex "NFS" "checking for file existence"
18956 If the attempt to open the file fails with a &"does not exist"& error, Exim
18957 runs a check on the containing directory,
18958 unless &%ignore_enotdir%& is true (see below).
18959 If the directory does not appear to exist, delivery is deferred. This can
18960 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18961 is a mount problem. If the containing directory does exist, but the file does
18962 not, the router declines.
18963
18964
18965 .option file_transport redirect string&!! unset
18966 .vindex "&$address_file$&"
18967 A &(redirect)& router sets up a direct delivery to a file when a path name not
18968 ending in a slash is specified as a new &"address"&. The transport used is
18969 specified by this option, which, after expansion, must be the name of a
18970 configured transport. This should normally be an &(appendfile)& transport. When
18971 it is running, the file name is in &$address_file$&.
18972
18973
18974 .option filter_prepend_home redirect boolean true
18975 When this option is true, if a &(save)& command in an Exim filter specifies a
18976 relative path, and &$home$& is defined, it is automatically prepended to the
18977 relative path. If this option is set false, this action does not happen. The
18978 relative path is then passed to the transport unmodified.
18979
18980
18981 .option forbid_blackhole redirect boolean false
18982 If this option is true, the &':blackhole:'& item may not appear in a
18983 redirection list.
18984
18985
18986 .option forbid_exim_filter redirect boolean false
18987 If this option is set true, only Sieve filters are permitted when
18988 &%allow_filter%& is true.
18989
18990
18991
18992
18993 .option forbid_file redirect boolean false
18994 .cindex "delivery" "to file; forbidding"
18995 .cindex "Sieve filter" "forbidding delivery to a file"
18996 .cindex "Sieve filter" "&""keep""& facility; disabling"
18997 If this option is true, this router may not generate a new address that
18998 specifies delivery to a local file or directory, either from a filter or from a
18999 conventional forward file. This option is forced to be true if &%one_time%& is
19000 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19001 locks out the Sieve's &"keep"& facility.
19002
19003
19004 .option forbid_filter_dlfunc redirect boolean false
19005 .cindex "filter" "locking out certain features"
19006 If this option is true, string expansions in Exim filters are not allowed to
19007 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19008 functions.
19009
19010 .option forbid_filter_existstest redirect boolean false
19011 .cindex "expansion" "statting a file"
19012 If this option is true, string expansions in Exim filters are not allowed to
19013 make use of the &%exists%& condition or the &%stat%& expansion item.
19014
19015 .option forbid_filter_logwrite redirect boolean false
19016 If this option is true, use of the logging facility in Exim filters is not
19017 permitted. Logging is in any case available only if the filter is being run
19018 under some unprivileged uid (which is normally the case for ordinary users'
19019 &_.forward_& files).
19020
19021
19022 .option forbid_filter_lookup redirect boolean false
19023 If this option is true, string expansions in Exim filter files are not allowed
19024 to make use of &%lookup%& items.
19025
19026
19027 .option forbid_filter_perl redirect boolean false
19028 This option has an effect only if Exim is built with embedded Perl support. If
19029 it is true, string expansions in Exim filter files are not allowed to make use
19030 of the embedded Perl support.
19031
19032
19033 .option forbid_filter_readfile redirect boolean false
19034 If this option is true, string expansions in Exim filter files are not allowed
19035 to make use of &%readfile%& items.
19036
19037
19038 .option forbid_filter_readsocket redirect boolean false
19039 If this option is true, string expansions in Exim filter files are not allowed
19040 to make use of &%readsocket%& items.
19041
19042
19043 .option forbid_filter_reply redirect boolean false
19044 If this option is true, this router may not generate an automatic reply
19045 message. Automatic replies can be generated only from Exim or Sieve filter
19046 files, not from traditional forward files. This option is forced to be true if
19047 &%one_time%& is set.
19048
19049
19050 .option forbid_filter_run redirect boolean false
19051 If this option is true, string expansions in Exim filter files are not allowed
19052 to make use of &%run%& items.
19053
19054
19055 .option forbid_include redirect boolean false
19056 If this option is true, items of the form
19057 .code
19058 :include:<path name>
19059 .endd
19060 are not permitted in non-filter redirection lists.
19061
19062
19063 .option forbid_pipe redirect boolean false
19064 .cindex "delivery" "to pipe; forbidding"
19065 If this option is true, this router may not generate a new address which
19066 specifies delivery to a pipe, either from an Exim filter or from a conventional
19067 forward file. This option is forced to be true if &%one_time%& is set.
19068
19069
19070 .option forbid_sieve_filter redirect boolean false
19071 If this option is set true, only Exim filters are permitted when
19072 &%allow_filter%& is true.
19073
19074
19075 .cindex "SMTP" "error codes"
19076 .option forbid_smtp_code redirect boolean false
19077 If this option is set true, any SMTP error codes that are present at the start
19078 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19079 the default codes (451 and 550, respectively) are always used.
19080
19081
19082
19083
19084 .option hide_child_in_errmsg redirect boolean false
19085 .cindex "bounce message" "redirection details; suppressing"
19086 If this option is true, it prevents Exim from quoting a child address if it
19087 generates a bounce or delay message for it. Instead it says &"an address
19088 generated from <&'the top level address'&>"&. Of course, this applies only to
19089 bounces generated locally. If a message is forwarded to another host, &'its'&
19090 bounce may well quote the generated address.
19091
19092
19093 .option ignore_eacces redirect boolean false
19094 .cindex "EACCES"
19095 If this option is set and an attempt to open a redirection file yields the
19096 EACCES error (permission denied), the &(redirect)& router behaves as if the
19097 file did not exist.
19098
19099
19100 .option ignore_enotdir redirect boolean false
19101 .cindex "ENOTDIR"
19102 If this option is set and an attempt to open a redirection file yields the
19103 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19104 router behaves as if the file did not exist.
19105
19106 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19107 router that has the &%file%& option set discovers that the file does not exist
19108 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19109 against unmounted NFS directories. If the parent can not be statted, delivery
19110 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19111 is set, because that option tells Exim to ignore &"something on the path is not
19112 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19113 that some operating systems give ENOENT where others give ENOTDIR.
19114
19115
19116
19117 .option include_directory redirect string unset
19118 If this option is set, the path names of any &':include:'& items in a
19119 redirection list must start with this directory.
19120
19121
19122 .option modemask redirect "octal integer" 022
19123 This specifies mode bits which must not be set for a file specified by the
19124 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19125
19126
19127 .option one_time redirect boolean false
19128 .cindex "one-time aliasing/forwarding expansion"
19129 .cindex "alias file" "one-time expansion"
19130 .cindex "forward file" "one-time expansion"
19131 .cindex "mailing lists" "one-time expansion"
19132 .cindex "address redirection" "one-time expansion"
19133 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19134 files each time it tries to deliver a message causes a problem when one or more
19135 of the generated addresses fails be delivered at the first attempt. The problem
19136 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19137 but of what happens when the redirection list changes during the time that the
19138 message is on Exim's queue. This is particularly true in the case of mailing
19139 lists, where new subscribers might receive copies of messages that were posted
19140 before they subscribed.
19141
19142 If &%one_time%& is set and any addresses generated by the router fail to
19143 deliver at the first attempt, the failing addresses are added to the message as
19144 &"top level"& addresses, and the parent address that generated them is marked
19145 &"delivered"&. Thus, redirection does not happen again at the next delivery
19146 attempt.
19147
19148 &*Warning 1*&: Any header line addition or removal that is specified by this
19149 router would be lost if delivery did not succeed at the first attempt. For this
19150 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19151 permitted when &%one_time%& is set.
19152
19153 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19154 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19155 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19156
19157 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19158 &%one_time%&.
19159
19160 The original top-level address is remembered with each of the generated
19161 addresses, and is output in any log messages. However, any intermediate parent
19162 addresses are not recorded. This makes a difference to the log only if
19163 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19164 typically be used for mailing lists, where there is normally just one level of
19165 expansion.
19166
19167
19168 .option owners redirect "string list" unset
19169 .cindex "ownership" "alias file"
19170 .cindex "ownership" "forward file"
19171 .cindex "alias file" "ownership"
19172 .cindex "forward file" "ownership"
19173 This specifies a list of permitted owners for the file specified by &%file%&.
19174 This list is in addition to the local user when &%check_local_user%& is set.
19175 See &%check_owner%& above.
19176
19177
19178 .option owngroups redirect "string list" unset
19179 This specifies a list of permitted groups for the file specified by &%file%&.
19180 The list is in addition to the local user's primary group when
19181 &%check_local_user%& is set. See &%check_group%& above.
19182
19183
19184 .option pipe_transport redirect string&!! unset
19185 .vindex "&$address_pipe$&"
19186 A &(redirect)& router sets up a direct delivery to a pipe when a string
19187 starting with a vertical bar character is specified as a new &"address"&. The
19188 transport used is specified by this option, which, after expansion, must be the
19189 name of a configured transport. This should normally be a &(pipe)& transport.
19190 When the transport is run, the pipe command is in &$address_pipe$&.
19191
19192
19193 .option qualify_domain redirect string&!! unset
19194 .vindex "&$qualify_recipient$&"
19195 If this option is set, and an unqualified address (one without a domain) is
19196 generated, and that address would normally be qualified by the global setting
19197 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19198 expanding this string. If the expansion fails, the router declines. If you want
19199 to revert to the default, you can have the expansion generate
19200 &$qualify_recipient$&.
19201
19202 This option applies to all unqualified addresses generated by Exim filters,
19203 but for traditional &_.forward_& files, it applies only to addresses that are
19204 not preceded by a backslash. Sieve filters cannot generate unqualified
19205 addresses.
19206
19207 .option qualify_preserve_domain redirect boolean false
19208 .cindex "domain" "in redirection; preserving"
19209 .cindex "preserving domain in redirection"
19210 .cindex "address redirection" "domain; preserving"
19211 If this option is set, the router's local &%qualify_domain%& option must not be
19212 set (a configuration error occurs if it is). If an unqualified address (one
19213 without a domain) is generated, it is qualified with the domain of the parent
19214 address (the immediately preceding ancestor) instead of the global
19215 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19216 this applies whether or not the address is preceded by a backslash.
19217
19218
19219 .option repeat_use redirect boolean true
19220 If this option is set false, the router is skipped for a child address that has
19221 any ancestor that was routed by this router. This test happens before any of
19222 the other preconditions are tested. Exim's default anti-looping rules skip
19223 only when the ancestor is the same as the current address. See also
19224 &%check_ancestor%& above and the generic &%redirect_router%& option.
19225
19226
19227 .option reply_transport redirect string&!! unset
19228 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19229 &%vacation%& command is used in a filter file. The transport used is specified
19230 by this option, which, after expansion, must be the name of a configured
19231 transport. This should normally be an &(autoreply)& transport. Other transports
19232 are unlikely to do anything sensible or useful.
19233
19234
19235 .option rewrite redirect boolean true
19236 .cindex "address redirection" "disabling rewriting"
19237 If this option is set false, addresses generated by the router are not
19238 subject to address rewriting. Otherwise, they are treated like new addresses
19239 and are rewritten according to the global rewriting rules.
19240
19241
19242 .option sieve_subaddress redirect string&!! unset
19243 The value of this option is passed to a Sieve filter to specify the
19244 :subaddress part of an address.
19245
19246 .option sieve_useraddress redirect string&!! unset
19247 The value of this option is passed to a Sieve filter to specify the :user part
19248 of an address. However, if it is unset, the entire original local part
19249 (including any prefix or suffix) is used for :user.
19250
19251
19252 .option sieve_vacation_directory redirect string&!! unset
19253 .cindex "Sieve filter" "vacation directory"
19254 To enable the &"vacation"& extension for Sieve filters, you must set
19255 &%sieve_vacation_directory%& to the directory where vacation databases are held
19256 (do not put anything else in that directory), and ensure that the
19257 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19258 needs their own directory; Exim will create it if necessary.
19259
19260
19261
19262 .option skip_syntax_errors redirect boolean false
19263 .cindex "forward file" "broken"
19264 .cindex "address redirection" "broken files"
19265 .cindex "alias file" "broken"
19266 .cindex "broken alias or forward files"
19267 .cindex "ignoring faulty addresses"
19268 .cindex "skipping faulty addresses"
19269 .cindex "error" "skipping bad syntax"
19270 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19271 non-filter redirection data are skipped, and each failing address is logged. If
19272 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19273 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19274 are expanded and placed at the head of the error message generated by
19275 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19276 be the same address as the generic &%errors_to%& option. The
19277 &%skip_syntax_errors%& option is often used when handling mailing lists.
19278
19279 If all the addresses in a redirection list are skipped because of syntax
19280 errors, the router declines to handle the original address, and it is passed to
19281 the following routers.
19282
19283 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19284 error in the filter causes filtering to be abandoned without any action being
19285 taken. The incident is logged, and the router declines to handle the address,
19286 so it is passed to the following routers.
19287
19288 .cindex "Sieve filter" "syntax errors in"
19289 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19290 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19291 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19292
19293 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19294 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19295 option, used with an address that does not get redirected, can be used to
19296 notify users of these errors, by means of a router like this:
19297 .code
19298 userforward:
19299   driver = redirect
19300   allow_filter
19301   check_local_user
19302   file = $home/.forward
19303   file_transport = address_file
19304   pipe_transport = address_pipe
19305   reply_transport = address_reply
19306   no_verify
19307   skip_syntax_errors
19308   syntax_errors_to = real-$local_part@$domain
19309   syntax_errors_text = \
19310    This is an automatically generated message. An error has\n\
19311    been found in your .forward file. Details of the error are\n\
19312    reported below. While this error persists, you will receive\n\
19313    a copy of this message for every message that is addressed\n\
19314    to you. If your .forward file is a filter file, or if it is\n\
19315    a non-filter file containing no valid forwarding addresses,\n\
19316    a copy of each incoming message will be put in your normal\n\
19317    mailbox. If a non-filter file contains at least one valid\n\
19318    forwarding address, forwarding to the valid addresses will\n\
19319    happen, and those will be the only deliveries that occur.
19320 .endd
19321 You also need a router to ensure that local addresses that are prefixed by
19322 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19323 put this immediately before the &(userforward)& router:
19324 .code
19325 real_localuser:
19326   driver = accept
19327   check_local_user
19328   local_part_prefix = real-
19329   transport = local_delivery
19330 .endd
19331 For security, it would probably be a good idea to restrict the use of this
19332 router to locally-generated messages, using a condition such as this:
19333 .code
19334   condition = ${if match {$sender_host_address}\
19335                          {\N^(|127\.0\.0\.1)$\N}}
19336 .endd
19337
19338
19339 .option syntax_errors_text redirect string&!! unset
19340 See &%skip_syntax_errors%& above.
19341
19342
19343 .option syntax_errors_to redirect string unset
19344 See &%skip_syntax_errors%& above.
19345 .ecindex IIDredrou1
19346 .ecindex IIDredrou2
19347
19348
19349
19350
19351
19352
19353 . ////////////////////////////////////////////////////////////////////////////
19354 . ////////////////////////////////////////////////////////////////////////////
19355
19356 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19357          "Environment for local transports"
19358 .scindex IIDenvlotra1 "local transports" "environment for"
19359 .scindex IIDenvlotra2 "environment for local transports"
19360 .scindex IIDenvlotra3 "transport" "local; environment for"
19361 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19362 transport can be thought of as similar to a pipe.) Exim always runs transports
19363 in subprocesses, under specified uids and gids. Typical deliveries to local
19364 mailboxes run under the uid and gid of the local user.
19365
19366 Exim also sets a specific current directory while running the transport; for
19367 some transports a home directory setting is also relevant. The &(pipe)&
19368 transport is the only one that sets up environment variables; see section
19369 &<<SECTpipeenv>>& for details.
19370
19371 The values used for the uid, gid, and the directories may come from several
19372 different places. In many cases, the router that handles the address associates
19373 settings with that address as a result of its &%check_local_user%&, &%group%&,
19374 or &%user%& options. However, values may also be given in the transport's own
19375 configuration, and these override anything that comes from the router.
19376
19377
19378
19379 .section "Concurrent deliveries" "SECID131"
19380 .cindex "concurrent deliveries"
19381 .cindex "simultaneous deliveries"
19382 If two different messages for the same local recipient arrive more or less
19383 simultaneously, the two delivery processes are likely to run concurrently. When
19384 the &(appendfile)& transport is used to write to a file, Exim applies locking
19385 rules to stop concurrent processes from writing to the same file at the same
19386 time.
19387
19388 However, when you use a &(pipe)& transport, it is up to you to arrange any
19389 locking that is needed. Here is a silly example:
19390 .code
19391 my_transport:
19392   driver = pipe
19393   command = /bin/sh -c 'cat >>/some/file'
19394 .endd
19395 This is supposed to write the message at the end of the file. However, if two
19396 messages arrive at the same time, the file will be scrambled. You can use the
19397 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19398 file using the same algorithm that Exim itself uses.
19399
19400
19401
19402
19403 .section "Uids and gids" "SECTenvuidgid"
19404 .cindex "local transports" "uid and gid"
19405 .cindex "transport" "local; uid and gid"
19406 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19407 overrides any group that the router set in the address, even if &%user%& is not
19408 set for the transport. This makes it possible, for example, to run local mail
19409 delivery under the uid of the recipient (set by the router), but in a special
19410 group (set by the transport). For example:
19411 .code
19412 # Routers ...
19413 # User/group are set by check_local_user in this router
19414 local_users:
19415   driver = accept
19416   check_local_user
19417   transport = group_delivery
19418
19419 # Transports ...
19420 # This transport overrides the group
19421 group_delivery:
19422   driver = appendfile
19423   file = /var/spool/mail/$local_part
19424   group = mail
19425 .endd
19426 If &%user%& is set for a transport, its value overrides what is set in the
19427 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19428 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19429 set.
19430
19431 .oindex "&%initgroups%&"
19432 When the uid is taken from the transport's configuration, the &[initgroups()]&
19433 function is called for the groups associated with that uid if the
19434 &%initgroups%& option is set for the transport. When the uid is not specified
19435 by the transport, but is associated with the address by a router, the option
19436 for calling &[initgroups()]& is taken from the router configuration.
19437
19438 .cindex "&(pipe)& transport" "uid for"
19439 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19440 is set and &%user%& is not set, the uid of the process that called Exim to
19441 receive the message is used, and if &%group%& is not set, the corresponding
19442 original gid is also used.
19443
19444 This is the detailed preference order for obtaining a gid; the first of the
19445 following that is set is used:
19446
19447 .ilist
19448 A &%group%& setting of the transport;
19449 .next
19450 A &%group%& setting of the router;
19451 .next
19452 A gid associated with a user setting of the router, either as a result of
19453 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19454 .next
19455 The group associated with a non-numeric &%user%& setting of the transport;
19456 .next
19457 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19458 the uid is the creator's uid;
19459 .next
19460 The Exim gid if the Exim uid is being used as a default.
19461 .endlist
19462
19463 If, for example, the user is specified numerically on the router and there are
19464 no group settings, no gid is available. In this situation, an error occurs.
19465 This is different for the uid, for which there always is an ultimate default.
19466 The first of the following that is set is used:
19467
19468 .ilist
19469 A &%user%& setting of the transport;
19470 .next
19471 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19472 .next
19473 A &%user%& setting of the router;
19474 .next
19475 A &%check_local_user%& setting of the router;
19476 .next
19477 The Exim uid.
19478 .endlist
19479
19480 Of course, an error will still occur if the uid that is chosen is on the
19481 &%never_users%& list.
19482
19483
19484
19485
19486
19487 .section "Current and home directories" "SECID132"
19488 .cindex "current directory for local transport"
19489 .cindex "home directory" "for local transport"
19490 .cindex "transport" "local; home directory for"
19491 .cindex "transport" "local; current directory for"
19492 Routers may set current and home directories for local transports by means of
19493 the &%transport_current_directory%& and &%transport_home_directory%& options.
19494 However, if the transport's &%current_directory%& or &%home_directory%& options
19495 are set, they override the router's values. In detail, the home directory
19496 for a local transport is taken from the first of these values that is set:
19497
19498 .ilist
19499 The &%home_directory%& option on the transport;
19500 .next
19501 The &%transport_home_directory%& option on the router;
19502 .next
19503 The password data if &%check_local_user%& is set on the router;
19504 .next
19505 The &%router_home_directory%& option on the router.
19506 .endlist
19507
19508 The current directory is taken from the first of these values that is set:
19509
19510 .ilist
19511 The &%current_directory%& option on the transport;
19512 .next
19513 The &%transport_current_directory%& option on the router.
19514 .endlist
19515
19516
19517 If neither the router nor the transport sets a current directory, Exim uses the
19518 value of the home directory, if it is set. Otherwise it sets the current
19519 directory to &_/_& before running a local transport.
19520
19521
19522
19523 .section "Expansion variables derived from the address" "SECID133"
19524 .vindex "&$domain$&"
19525 .vindex "&$local_part$&"
19526 .vindex "&$original_domain$&"
19527 Normally a local delivery is handling a single address, and in that case the
19528 variables such as &$domain$& and &$local_part$& are set during local
19529 deliveries. However, in some circumstances more than one address may be handled
19530 at once (for example, while writing batch SMTP for onward transmission by some
19531 other means). In this case, the variables associated with the local part are
19532 never set, &$domain$& is set only if all the addresses have the same domain,
19533 and &$original_domain$& is never set.
19534 .ecindex IIDenvlotra1
19535 .ecindex IIDenvlotra2
19536 .ecindex IIDenvlotra3
19537
19538
19539
19540
19541
19542
19543
19544 . ////////////////////////////////////////////////////////////////////////////
19545 . ////////////////////////////////////////////////////////////////////////////
19546
19547 .chapter "Generic options for transports" "CHAPtransportgeneric"
19548 .scindex IIDgenoptra1 "generic options" "transport"
19549 .scindex IIDgenoptra2 "options" "generic; for transports"
19550 .scindex IIDgenoptra3 "transport" "generic options for"
19551 The following generic options apply to all transports:
19552
19553
19554 .option body_only transports boolean false
19555 .cindex "transport" "body only"
19556 .cindex "message" "transporting body only"
19557 .cindex "body of message" "transporting"
19558 If this option is set, the message's headers are not transported. It is
19559 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19560 or &(pipe)& transports, the settings of &%message_prefix%& and
19561 &%message_suffix%& should be checked, because this option does not
19562 automatically suppress them.
19563
19564
19565 .option current_directory transports string&!! unset
19566 .cindex "transport" "current directory for"
19567 This specifies the current directory that is to be set while running the
19568 transport, overriding any value that may have been set by the router.
19569 If the expansion fails for any reason, including forced failure, an error is
19570 logged, and delivery is deferred.
19571
19572
19573 .option disable_logging transports boolean false
19574 If this option is set true, nothing is logged for any
19575 deliveries by the transport or for any
19576 transport errors. You should not set this option unless you really, really know
19577 what you are doing.
19578
19579
19580 .option debug_print transports string&!! unset
19581 .cindex "testing" "variables in drivers"
19582 If this option is set and debugging is enabled (see the &%-d%& command line
19583 option), the string is expanded and included in the debugging output when the
19584 transport is run.
19585 If expansion of the string fails, the error message is written to the debugging
19586 output, and Exim carries on processing.
19587 This facility is provided to help with checking out the values of variables and
19588 so on when debugging driver configurations. For example, if a &%headers_add%&
19589 option is not working properly, &%debug_print%& could be used to output the
19590 variables it references. A newline is added to the text if it does not end with
19591 one.
19592
19593
19594 .option delivery_date_add transports boolean false
19595 .cindex "&'Delivery-date:'& header line"
19596 If this option is true, a &'Delivery-date:'& header is added to the message.
19597 This gives the actual time the delivery was made. As this is not a standard
19598 header, Exim has a configuration option (&%delivery_date_remove%&) which
19599 requests its removal from incoming messages, so that delivered messages can
19600 safely be resent to other recipients.
19601
19602
19603 .option driver transports string unset
19604 This specifies which of the available transport drivers is to be used.
19605 There is no default, and this option must be set for every transport.
19606
19607
19608 .option envelope_to_add transports boolean false
19609 .cindex "&'Envelope-to:'& header line"
19610 If this option is true, an &'Envelope-to:'& header is added to the message.
19611 This gives the original address(es) in the incoming envelope that caused this
19612 delivery to happen. More than one address may be present if the transport is
19613 configured to handle several addresses at once, or if more than one original
19614 address was redirected to the same final address. As this is not a standard
19615 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19616 its removal from incoming messages, so that delivered messages can safely be
19617 resent to other recipients.
19618
19619
19620 .option group transports string&!! "Exim group"
19621 .cindex "transport" "group; specifying"
19622 This option specifies a gid for running the transport process, overriding any
19623 value that the router supplies, and also overriding any value associated with
19624 &%user%& (see below).
19625
19626
19627 .option headers_add transports string&!! unset
19628 .cindex "header lines" "adding in transport"
19629 .cindex "transport" "header lines; adding"
19630 This option specifies a string of text that is expanded and added to the header
19631 portion of a message as it is transported, as described in section
19632 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19633 routers. If the result of the expansion is an empty string, or if the expansion
19634 is forced to fail, no action is taken. Other expansion failures are treated as
19635 errors and cause the delivery to be deferred.
19636
19637 Unlike most options, &%headers_add%& can be specified multiple times
19638 for a transport; all listed headers are added.
19639
19640
19641
19642 .option headers_only transports boolean false
19643 .cindex "transport" "header lines only"
19644 .cindex "message" "transporting headers only"
19645 .cindex "header lines" "transporting"
19646 If this option is set, the message's body is not transported. It is mutually
19647 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19648 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19649 checked, since this option does not automatically suppress them.
19650
19651
19652 .option headers_remove transports string&!! unset
19653 .cindex "header lines" "removing"
19654 .cindex "transport" "header lines; removing"
19655 This option specifies a string that is expanded into a list of header names;
19656 these headers are omitted from the message as it is transported, as described
19657 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19658 routers. If the result of the expansion is an empty string, or if the expansion
19659 is forced to fail, no action is taken. Other expansion failures are treated as
19660 errors and cause the delivery to be deferred.
19661
19662 Unlike most options, &%headers_remove%& can be specified multiple times
19663 for a router; all listed headers are added.
19664
19665
19666
19667 .option headers_rewrite transports string unset
19668 .cindex "transport" "header lines; rewriting"
19669 .cindex "rewriting" "at transport time"
19670 This option allows addresses in header lines to be rewritten at transport time,
19671 that is, as the message is being copied to its destination. The contents of the
19672 option are a colon-separated list of rewriting rules. Each rule is in exactly
19673 the same form as one of the general rewriting rules that are applied when a
19674 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19675 example,
19676 .code
19677 headers_rewrite = a@b c@d f : \
19678                   x@y w@z
19679 .endd
19680 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19681 &'w@z'& in all address-bearing header lines. The rules are applied to the
19682 header lines just before they are written out at transport time, so they affect
19683 only those copies of the message that pass through the transport. However, only
19684 the message's original header lines, and any that were added by a system
19685 filter, are rewritten. If a router or transport adds header lines, they are not
19686 affected by this option. These rewriting rules are &'not'& applied to the
19687 envelope. You can change the return path using &%return_path%&, but you cannot
19688 change envelope recipients at this time.
19689
19690
19691 .option home_directory transports string&!! unset
19692 .cindex "transport" "home directory for"
19693 .vindex "&$home$&"
19694 This option specifies a home directory setting for a local transport,
19695 overriding any value that may be set by the router. The home directory is
19696 placed in &$home$& while expanding the transport's private options. It is also
19697 used as the current directory if no current directory is set by the
19698 &%current_directory%& option on the transport or the
19699 &%transport_current_directory%& option on the router. If the expansion fails
19700 for any reason, including forced failure, an error is logged, and delivery is
19701 deferred.
19702
19703
19704 .option initgroups transports boolean false
19705 .cindex "additional groups"
19706 .cindex "groups" "additional"
19707 .cindex "transport" "group; additional"
19708 If this option is true and the uid for the delivery process is provided by the
19709 transport, the &[initgroups()]& function is called when running the transport
19710 to ensure that any additional groups associated with the uid are set up.
19711
19712
19713 .option message_size_limit transports string&!! 0
19714 .cindex "limit" "message size per transport"
19715 .cindex "size" "of message, limit"
19716 .cindex "transport" "message size; limiting"
19717 This option controls the size of messages passed through the transport. It is
19718 expanded before use; the result of the expansion must be a sequence of decimal
19719 digits, optionally followed by K or M. If the expansion fails for any reason,
19720 including forced failure, or if the result is not of the required form,
19721 delivery is deferred. If the value is greater than zero and the size of a
19722 message exceeds this limit, the address is failed. If there is any chance that
19723 the resulting bounce message could be routed to the same transport, you should
19724 ensure that &%return_size_limit%& is less than the transport's
19725 &%message_size_limit%&, as otherwise the bounce message will fail to get
19726 delivered.
19727
19728
19729
19730 .option rcpt_include_affixes transports boolean false
19731 .cindex "prefix" "for local part, including in envelope"
19732 .cindex "suffix for local part" "including in envelope"
19733 .cindex "local part" "prefix"
19734 .cindex "local part" "suffix"
19735 When this option is false (the default), and an address that has had any
19736 affixes (prefixes or suffixes) removed from the local part is delivered by any
19737 form of SMTP or LMTP, the affixes are not included. For example, if a router
19738 that contains
19739 .code
19740 local_part_prefix = *-
19741 .endd
19742 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19743 is delivered with
19744 .code
19745 RCPT TO:<xyz@some.domain>
19746 .endd
19747 This is also the case when an ACL-time callout is being used to verify a
19748 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19749 whole local part is included in the RCPT command. This option applies to BSMTP
19750 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19751 &(lmtp)& and &(smtp)& transports.
19752
19753
19754 .option retry_use_local_part transports boolean "see below"
19755 .cindex "hints database" "retry keys"
19756 When a delivery suffers a temporary failure, a retry record is created
19757 in Exim's hints database. For remote deliveries, the key for the retry record
19758 is based on the name and/or IP address of the failing remote host. For local
19759 deliveries, the key is normally the entire address, including both the local
19760 part and the domain. This is suitable for most common cases of local delivery
19761 temporary failure &-- for example, exceeding a mailbox quota should delay only
19762 deliveries to that mailbox, not to the whole domain.
19763
19764 However, in some special cases you may want to treat a temporary local delivery
19765 as a failure associated with the domain, and not with a particular local part.
19766 (For example, if you are storing all mail for some domain in files.) You can do
19767 this by setting &%retry_use_local_part%& false.
19768
19769 For all the local transports, its default value is true. For remote transports,
19770 the default value is false for tidiness, but changing the value has no effect
19771 on a remote transport in the current implementation.
19772
19773
19774 .option return_path transports string&!! unset
19775 .cindex "envelope sender"
19776 .cindex "transport" "return path; changing"
19777 .cindex "return path" "changing in transport"
19778 If this option is set, the string is expanded at transport time and replaces
19779 the existing return path (envelope sender) value in the copy of the message
19780 that is being delivered. An empty return path is permitted. This feature is
19781 designed for remote deliveries, where the value of this option is used in the
19782 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19783 only effect is to change the address that is placed in the &'Return-path:'&
19784 header line, if one is added to the message (see the next option).
19785
19786 &*Note:*& A changed return path is not logged unless you add
19787 &%return_path_on_delivery%& to the log selector.
19788
19789 .vindex "&$return_path$&"
19790 The expansion can refer to the existing value via &$return_path$&. This is
19791 either the message's envelope sender, or an address set by the
19792 &%errors_to%& option on a router. If the expansion is forced to fail, no
19793 replacement occurs; if it fails for another reason, delivery is deferred. This
19794 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19795 section &<<SECTverp>>&.
19796
19797 &*Note*&: If a delivery error is detected locally, including the case when a
19798 remote server rejects a message at SMTP time, the bounce message is not sent to
19799 the value of this option. It is sent to the previously set errors address.
19800 This defaults to the incoming sender address, but can be changed by setting
19801 &%errors_to%& in a router.
19802
19803
19804
19805 .option return_path_add transports boolean false
19806 .cindex "&'Return-path:'& header line"
19807 If this option is true, a &'Return-path:'& header is added to the message.
19808 Although the return path is normally available in the prefix line of BSD
19809 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19810 have easy access to it.
19811
19812 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19813 the delivery SMTP server makes the final delivery"&. This implies that this
19814 header should not be present in incoming messages. Exim has a configuration
19815 option, &%return_path_remove%&, which requests removal of this header from
19816 incoming messages, so that delivered messages can safely be resent to other
19817 recipients.
19818
19819
19820 .option shadow_condition transports string&!! unset
19821 See &%shadow_transport%& below.
19822
19823
19824 .option shadow_transport transports string unset
19825 .cindex "shadow transport"
19826 .cindex "transport" "shadow"
19827 A local transport may set the &%shadow_transport%& option to the name of
19828 another local transport. Shadow remote transports are not supported.
19829
19830 Whenever a delivery to the main transport succeeds, and either
19831 &%shadow_condition%& is unset, or its expansion does not result in the empty
19832 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19833 passed to the shadow transport, with the same delivery address or addresses. If
19834 expansion fails, no action is taken except that non-forced expansion failures
19835 cause a log line to be written.
19836
19837 The result of the shadow transport is discarded and does not affect the
19838 subsequent processing of the message. Only a single level of shadowing is
19839 provided; the &%shadow_transport%& option is ignored on any transport when it
19840 is running as a shadow. Options concerned with output from pipes are also
19841 ignored. The log line for the successful delivery has an item added on the end,
19842 of the form
19843 .code
19844 ST=<shadow transport name>
19845 .endd
19846 If the shadow transport did not succeed, the error message is put in
19847 parentheses afterwards. Shadow transports can be used for a number of different
19848 purposes, including keeping more detailed log information than Exim normally
19849 provides, and implementing automatic acknowledgment policies based on message
19850 headers that some sites insist on.
19851
19852
19853 .option transport_filter transports string&!! unset
19854 .cindex "transport" "filter"
19855 .cindex "filter" "transport filter"
19856 This option sets up a filtering (in the Unix shell sense) process for messages
19857 at transport time. It should not be confused with mail filtering as set up by
19858 individual users or via a system filter.
19859
19860 When the message is about to be written out, the command specified by
19861 &%transport_filter%& is started up in a separate, parallel process, and
19862 the entire message, including the header lines, is passed to it on its standard
19863 input (this in fact is done from a third process, to avoid deadlock). The
19864 command must be specified as an absolute path.
19865
19866 The lines of the message that are written to the transport filter are
19867 terminated by newline (&"\n"&). The message is passed to the filter before any
19868 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19869 lines beginning with a dot, and also before any processing implied by the
19870 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19871 &(pipe)& transports.
19872
19873 The standard error for the filter process is set to the same destination as its
19874 standard output; this is read and written to the message's ultimate
19875 destination. The process that writes the message to the filter, the
19876 filter itself, and the original process that reads the result and delivers it
19877 are all run in parallel, like a shell pipeline.
19878
19879 The filter can perform any transformations it likes, but of course should take
19880 care not to break RFC 2822 syntax. Exim does not check the result, except to
19881 test for a final newline when SMTP is in use. All messages transmitted over
19882 SMTP must end with a newline, so Exim supplies one if it is missing.
19883
19884 .cindex "content scanning" "per user"
19885 A transport filter can be used to provide content-scanning on a per-user basis
19886 at delivery time if the only required effect of the scan is to modify the
19887 message. For example, a content scan could insert a new header line containing
19888 a spam score. This could be interpreted by a filter in the user's MUA. It is
19889 not possible to discard a message at this stage.
19890
19891 .cindex "SMTP" "SIZE"
19892 A problem might arise if the filter increases the size of a message that is
19893 being sent down an SMTP connection. If the receiving SMTP server has indicated
19894 support for the SIZE parameter, Exim will have sent the size of the message
19895 at the start of the SMTP session. If what is actually sent is substantially
19896 more, the server might reject the message. This can be worked round by setting
19897 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19898 additions to the message, or to disable the use of SIZE altogether.
19899
19900 .vindex "&$pipe_addresses$&"
19901 The value of the &%transport_filter%& option is the command string for starting
19902 the filter, which is run directly from Exim, not under a shell. The string is
19903 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19904 Exim breaks it up into arguments and then expands each argument separately (see
19905 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19906 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19907 of arguments, one for each address that applies to this delivery. (This isn't
19908 an ideal name for this feature here, but as it was already implemented for the
19909 &(pipe)& transport, it seemed sensible not to change it.)
19910
19911 .vindex "&$host$&"
19912 .vindex "&$host_address$&"
19913 The expansion variables &$host$& and &$host_address$& are available when the
19914 transport is a remote one. They contain the name and IP address of the host to
19915 which the message is being sent. For example:
19916 .code
19917 transport_filter = /some/directory/transport-filter.pl \
19918   $host $host_address $sender_address $pipe_addresses
19919 .endd
19920
19921 Two problems arise if you want to use more complicated expansion items to
19922 generate transport filter commands, both of which due to the fact that the
19923 command is split up &'before'& expansion.
19924 .ilist
19925 If an expansion item contains white space, you must quote it, so that it is all
19926 part of the same command item. If the entire option setting is one such
19927 expansion item, you have to take care what kind of quoting you use. For
19928 example:
19929 .code
19930 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19931 .endd
19932 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19933 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19934 stripped by Exim when it read the option's value. When the value is used, if
19935 the single quotes were missing, the line would be split into two items,
19936 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19937 Exim tried to expand the first one.
19938 .next
19939 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19940 expansion cannot generate multiple arguments, or a command name followed by
19941 arguments. Consider this example:
19942 .code
19943 transport_filter = ${lookup{$host}lsearch{/a/file}\
19944                     {$value}{/bin/cat}}
19945 .endd
19946 The result of the lookup is interpreted as the name of the command, even
19947 if it contains white space. The simplest way round this is to use a shell:
19948 .code
19949 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19950                                {$value}{/bin/cat}}
19951 .endd
19952 .endlist
19953
19954 The filter process is run under the same uid and gid as the normal delivery.
19955 For remote deliveries this is the Exim uid/gid by default. The command should
19956 normally yield a zero return code. Transport filters are not supposed to fail.
19957 A non-zero code is taken to mean that the transport filter encountered some
19958 serious problem. Delivery of the message is deferred; the message remains on
19959 the queue and is tried again later. It is not possible to cause a message to be
19960 bounced from a transport filter.
19961
19962 If a transport filter is set on an autoreply transport, the original message is
19963 passed through the filter as it is being copied into the newly generated
19964 message, which happens if the &%return_message%& option is set.
19965
19966
19967 .option transport_filter_timeout transports time 5m
19968 .cindex "transport" "filter, timeout"
19969 When Exim is reading the output of a transport filter, it applies a timeout
19970 that can be set by this option. Exceeding the timeout is normally treated as a
19971 temporary delivery failure. However, if a transport filter is used with a
19972 &(pipe)& transport, a timeout in the transport filter is treated in the same
19973 way as a timeout in the pipe command itself. By default, a timeout is a hard
19974 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19975 becomes a temporary error.
19976
19977
19978 .option user transports string&!! "Exim user"
19979 .cindex "uid (user id)" "local delivery"
19980 .cindex "transport" "user, specifying"
19981 This option specifies the user under whose uid the delivery process is to be
19982 run, overriding any uid that may have been set by the router. If the user is
19983 given as a name, the uid is looked up from the password data, and the
19984 associated group is taken as the value of the gid to be used if the &%group%&
19985 option is not set.
19986
19987 For deliveries that use local transports, a user and group are normally
19988 specified explicitly or implicitly (for example, as a result of
19989 &%check_local_user%&) by the router or transport.
19990
19991 .cindex "hints database" "access by remote transport"
19992 For remote transports, you should leave this option unset unless you really are
19993 sure you know what you are doing. When a remote transport is running, it needs
19994 to be able to access Exim's hints databases, because each host may have its own
19995 retry data.
19996 .ecindex IIDgenoptra1
19997 .ecindex IIDgenoptra2
19998 .ecindex IIDgenoptra3
19999
20000
20001
20002
20003
20004
20005 . ////////////////////////////////////////////////////////////////////////////
20006 . ////////////////////////////////////////////////////////////////////////////
20007
20008 .chapter "Address batching in local transports" "CHAPbatching" &&&
20009          "Address batching"
20010 .cindex "transport" "local; address batching in"
20011 The only remote transport (&(smtp)&) is normally configured to handle more than
20012 one address at a time, so that when several addresses are routed to the same
20013 remote host, just one copy of the message is sent. Local transports, however,
20014 normally handle one address at a time. That is, a separate instance of the
20015 transport is run for each address that is routed to the transport. A separate
20016 copy of the message is delivered each time.
20017
20018 .cindex "batched local delivery"
20019 .oindex "&%batch_max%&"
20020 .oindex "&%batch_id%&"
20021 In special cases, it may be desirable to handle several addresses at once in a
20022 local transport, for example:
20023
20024 .ilist
20025 In an &(appendfile)& transport, when storing messages in files for later
20026 delivery by some other means, a single copy of the message with multiple
20027 recipients saves space.
20028 .next
20029 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20030 a single copy saves time, and is the normal way LMTP is expected to work.
20031 .next
20032 In a &(pipe)& transport, when passing the message
20033 to a scanner program or
20034 to some other delivery mechanism such as UUCP, multiple recipients may be
20035 acceptable.
20036 .endlist
20037
20038 These three local transports all have the same options for controlling multiple
20039 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20040 repeating the information for each transport, these options are described here.
20041
20042 The &%batch_max%& option specifies the maximum number of addresses that can be
20043 delivered together in a single run of the transport. Its default value is one
20044 (no batching). When more than one address is routed to a transport that has a
20045 &%batch_max%& value greater than one, the addresses are delivered in a batch
20046 (that is, in a single run of the transport with multiple recipients), subject
20047 to certain conditions:
20048
20049 .ilist
20050 .vindex "&$local_part$&"
20051 If any of the transport's options contain a reference to &$local_part$&, no
20052 batching is possible.
20053 .next
20054 .vindex "&$domain$&"
20055 If any of the transport's options contain a reference to &$domain$&, only
20056 addresses with the same domain are batched.
20057 .next
20058 .cindex "customizing" "batching condition"
20059 If &%batch_id%& is set, it is expanded for each address, and only those
20060 addresses with the same expanded value are batched. This allows you to specify
20061 customized batching conditions. Failure of the expansion for any reason,
20062 including forced failure, disables batching, but it does not stop the delivery
20063 from taking place.
20064 .next
20065 Batched addresses must also have the same errors address (where to send
20066 delivery errors), the same header additions and removals, the same user and
20067 group for the transport, and if a host list is present, the first host must
20068 be the same.
20069 .endlist
20070
20071 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20072 both when the file or pipe command is specified in the transport, and when it
20073 is specified by a &(redirect)& router, but all the batched addresses must of
20074 course be routed to the same file or pipe command. These two transports have an
20075 option called &%use_bsmtp%&, which causes them to deliver the message in
20076 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20077 &%check_string%& and &%escape_string%& options are forced to the values
20078 .code
20079 check_string = "."
20080 escape_string = ".."
20081 .endd
20082 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20083 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20084 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20085
20086 .cindex "&'Envelope-to:'& header line"
20087 If the generic &%envelope_to_add%& option is set for a batching transport, the
20088 &'Envelope-to:'& header that is added to the message contains all the addresses
20089 that are being processed together. If you are using a batching &(appendfile)&
20090 transport without &%use_bsmtp%&, the only way to preserve the recipient
20091 addresses is to set the &%envelope_to_add%& option.
20092
20093 .cindex "&(pipe)& transport" "with multiple addresses"
20094 .vindex "&$pipe_addresses$&"
20095 If you are using a &(pipe)& transport without BSMTP, and setting the
20096 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20097 the command. This is not a true variable; it is a bit of magic that causes each
20098 of the recipient addresses to be inserted into the command as a separate
20099 argument. This provides a way of accessing all the addresses that are being
20100 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20101 are specified by a &(redirect)& router.
20102
20103
20104
20105
20106 . ////////////////////////////////////////////////////////////////////////////
20107 . ////////////////////////////////////////////////////////////////////////////
20108
20109 .chapter "The appendfile transport" "CHAPappendfile"
20110 .scindex IIDapptra1 "&(appendfile)& transport"
20111 .scindex IIDapptra2 "transports" "&(appendfile)&"
20112 .cindex "directory creation"
20113 .cindex "creating directories"
20114 The &(appendfile)& transport delivers a message by appending it to an existing
20115 file, or by creating an entirely new file in a specified directory. Single
20116 files to which messages are appended can be in the traditional Unix mailbox
20117 format, or optionally in the MBX format supported by the Pine MUA and
20118 University of Washington IMAP daemon, &'inter alia'&. When each message is
20119 being delivered as a separate file, &"maildir"& format can optionally be used
20120 to give added protection against failures that happen part-way through the
20121 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20122 supported. For all file formats, Exim attempts to create as many levels of
20123 directory as necessary, provided that &%create_directory%& is set.
20124
20125 The code for the optional formats is not included in the Exim binary by
20126 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20127 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20128 included.
20129
20130 .cindex "quota" "system"
20131 Exim recognizes system quota errors, and generates an appropriate message. Exim
20132 also supports its own quota control within the transport, for use when the
20133 system facility is unavailable or cannot be used for some reason.
20134
20135 If there is an error while appending to a file (for example, quota exceeded or
20136 partition filled), Exim attempts to reset the file's length and last
20137 modification time back to what they were before. If there is an error while
20138 creating an entirely new file, the new file is removed.
20139
20140 Before appending to a file, a number of security checks are made, and the
20141 file is locked. A detailed description is given below, after the list of
20142 private options.
20143
20144 The &(appendfile)& transport is most commonly used for local deliveries to
20145 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20146 putting messages into files for remote delivery by some means other than Exim.
20147 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20148 option).
20149
20150
20151
20152 .section "The file and directory options" "SECTfildiropt"
20153 The &%file%& option specifies a single file, to which the message is appended;
20154 the &%directory%& option specifies a directory, in which a new file containing
20155 the message is created. Only one of these two options can be set, and for
20156 normal deliveries to mailboxes, one of them &'must'& be set.
20157
20158 .vindex "&$address_file$&"
20159 .vindex "&$local_part$&"
20160 However, &(appendfile)& is also used for delivering messages to files or
20161 directories whose names (or parts of names) are obtained from alias,
20162 forwarding, or filtering operations (for example, a &%save%& command in a
20163 user's Exim filter). When such a transport is running, &$local_part$& contains
20164 the local part that was aliased or forwarded, and &$address_file$& contains the
20165 name (or partial name) of the file or directory generated by the redirection
20166 operation. There are two cases:
20167
20168 .ilist
20169 If neither &%file%& nor &%directory%& is set, the redirection operation
20170 must specify an absolute path (one that begins with &`/`&). This is the most
20171 common case when users with local accounts use filtering to sort mail into
20172 different folders. See for example, the &(address_file)& transport in the
20173 default configuration. If the path ends with a slash, it is assumed to be the
20174 name of a directory. A delivery to a directory can also be forced by setting
20175 &%maildir_format%& or &%mailstore_format%&.
20176 .next
20177 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20178 used to determine the file or directory name for the delivery. Normally, the
20179 contents of &$address_file$& are used in some way in the string expansion.
20180 .endlist
20181
20182
20183 .cindex "Sieve filter" "configuring &(appendfile)&"
20184 .cindex "Sieve filter" "relative mailbox path handling"
20185 As an example of the second case, consider an environment where users do not
20186 have home directories. They may be permitted to use Exim filter commands of the
20187 form:
20188 .code
20189 save folder23
20190 .endd
20191 or Sieve filter commands of the form:
20192 .code
20193 require "fileinto";
20194 fileinto "folder23";
20195 .endd
20196 In this situation, the expansion of &%file%& or &%directory%& in the transport
20197 must transform the relative path into an appropriate absolute file name. In the
20198 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20199 is used as a result of a &"keep"& action in the filter. This example shows one
20200 way of handling this requirement:
20201 .code
20202 file = ${if eq{$address_file}{inbox} \
20203             {/var/mail/$local_part} \
20204             {${if eq{${substr_0_1:$address_file}}{/} \
20205                   {$address_file} \
20206                   {$home/mail/$address_file} \
20207             }} \
20208        }
20209 .endd
20210 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20211 location, absolute paths are used without change, and other folders are in the
20212 &_mail_& directory within the home directory.
20213
20214 &*Note 1*&: While processing an Exim filter, a relative path such as
20215 &_folder23_& is turned into an absolute path if a home directory is known to
20216 the router. In particular, this is the case if &%check_local_user%& is set. If
20217 you want to prevent this happening at routing time, you can set
20218 &%router_home_directory%& empty. This forces the router to pass the relative
20219 path to the transport.
20220
20221 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20222 the &%file%& or &%directory%& option is still used if it is set.
20223
20224
20225
20226
20227 .section "Private options for appendfile" "SECID134"
20228 .cindex "options" "&(appendfile)& transport"
20229
20230
20231
20232 .option allow_fifo appendfile boolean false
20233 .cindex "fifo (named pipe)"
20234 .cindex "named pipe (fifo)"
20235 .cindex "pipe" "named (fifo)"
20236 Setting this option permits delivery to named pipes (FIFOs) as well as to
20237 regular files. If no process is reading the named pipe at delivery time, the
20238 delivery is deferred.
20239
20240
20241 .option allow_symlink appendfile boolean false
20242 .cindex "symbolic link" "to mailbox"
20243 .cindex "mailbox" "symbolic link"
20244 By default, &(appendfile)& will not deliver if the path name for the file is
20245 that of a symbolic link. Setting this option relaxes that constraint, but there
20246 are security issues involved in the use of symbolic links. Be sure you know
20247 what you are doing if you set this. Details of exactly what this option affects
20248 are included in the discussion which follows this list of options.
20249
20250
20251 .option batch_id appendfile string&!! unset
20252 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20253 However, batching is automatically disabled for &(appendfile)& deliveries that
20254 happen as a result of forwarding or aliasing or other redirection directly to a
20255 file.
20256
20257
20258 .option batch_max appendfile integer 1
20259 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20260
20261
20262 .option check_group appendfile boolean false
20263 When this option is set, the group owner of the file defined by the &%file%&
20264 option is checked to see that it is the same as the group under which the
20265 delivery process is running. The default setting is false because the default
20266 file mode is 0600, which means that the group is irrelevant.
20267
20268
20269 .option check_owner appendfile boolean true
20270 When this option is set, the owner of the file defined by the &%file%& option
20271 is checked to ensure that it is the same as the user under which the delivery
20272 process is running.
20273
20274
20275 .option check_string appendfile string "see below"
20276 .cindex "&""From""& line"
20277 As &(appendfile)& writes the message, the start of each line is tested for
20278 matching &%check_string%&, and if it does, the initial matching characters are
20279 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20280 a literal string, not a regular expression, and the case of any letters it
20281 contains is significant.
20282
20283 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20284 are forced to &"."& and &".."& respectively, and any settings in the
20285 configuration are ignored. Otherwise, they default to &"From&~"& and
20286 &">From&~"& when the &%file%& option is set, and unset when any of the
20287 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20288
20289 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20290 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20291 &"From&~"& indicates the start of a new message. All four options need changing
20292 if another format is used. For example, to deliver to mailboxes in MMDF format:
20293 .cindex "MMDF format mailbox"
20294 .cindex "mailbox" "MMDF format"
20295 .code
20296 check_string = "\1\1\1\1\n"
20297 escape_string = "\1\1\1\1 \n"
20298 message_prefix = "\1\1\1\1\n"
20299 message_suffix = "\1\1\1\1\n"
20300 .endd
20301 .option create_directory appendfile boolean true
20302 .cindex "directory creation"
20303 When this option is true, Exim attempts to create any missing superior
20304 directories for the file that it is about to write. A created directory's mode
20305 is given by the &%directory_mode%& option.
20306
20307 The group ownership of a newly created directory is highly dependent on the
20308 operating system (and possibly the file system) that is being used. For
20309 example, in Solaris, if the parent directory has the setgid bit set, its group
20310 is propagated to the child; if not, the currently set group is used. However,
20311 in FreeBSD, the parent's group is always used.
20312
20313
20314
20315 .option create_file appendfile string anywhere
20316 This option constrains the location of files and directories that are created
20317 by this transport. It applies to files defined by the &%file%& option and
20318 directories defined by the &%directory%& option. In the case of maildir
20319 delivery, it applies to the top level directory, not the maildir directories
20320 beneath.
20321
20322 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20323 &"belowhome"&. In the second and third cases, a home directory must have been
20324 set for the transport. This option is not useful when an explicit file name is
20325 given for normal mailbox deliveries. It is intended for the case when file
20326 names are generated from users' &_.forward_& files. These are usually handled
20327 by an &(appendfile)& transport called &%address_file%&. See also
20328 &%file_must_exist%&.
20329
20330
20331 .option directory appendfile string&!! unset
20332 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20333 or &%directory%& must be set, unless the delivery is the direct result of a
20334 redirection (see section &<<SECTfildiropt>>&).
20335
20336 When &%directory%& is set, the string is expanded, and the message is delivered
20337 into a new file or files in or below the given directory, instead of being
20338 appended to a single mailbox file. A number of different formats are provided
20339 (see &%maildir_format%& and &%mailstore_format%&), and see section
20340 &<<SECTopdir>>& for further details of this form of delivery.
20341
20342
20343 .option directory_file appendfile string&!! "see below"
20344 .cindex "base62"
20345 .vindex "&$inode$&"
20346 When &%directory%& is set, but neither &%maildir_format%& nor
20347 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20348 whose name is obtained by expanding this string. The default value is:
20349 .code
20350 q${base62:$tod_epoch}-$inode
20351 .endd
20352 This generates a unique name from the current time, in base 62 form, and the
20353 inode of the file. The variable &$inode$& is available only when expanding this
20354 option.
20355
20356
20357 .option directory_mode appendfile "octal integer" 0700
20358 If &(appendfile)& creates any directories as a result of the
20359 &%create_directory%& option, their mode is specified by this option.
20360
20361
20362 .option escape_string appendfile string "see description"
20363 See &%check_string%& above.
20364
20365
20366 .option file appendfile string&!! unset
20367 This option is mutually exclusive with the &%directory%& option, but one of
20368 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20369 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20370 specifies a single file, to which the message is appended. One or more of
20371 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20372 &%file%&.
20373
20374 .cindex "NFS" "lock file"
20375 .cindex "locking files"
20376 .cindex "lock files"
20377 If you are using more than one host to deliver over NFS into the same
20378 mailboxes, you should always use lock files.
20379
20380 The string value is expanded for each delivery, and must yield an absolute
20381 path. The most common settings of this option are variations on one of these
20382 examples:
20383 .code
20384 file = /var/spool/mail/$local_part
20385 file = /home/$local_part/inbox
20386 file = $home/inbox
20387 .endd
20388 .cindex "&""sticky""& bit"
20389 In the first example, all deliveries are done into the same directory. If Exim
20390 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20391 create a file in the directory, so the &"sticky"& bit must be turned on for
20392 deliveries to be possible, or alternatively the &%group%& option can be used to
20393 run the delivery under a group id which has write access to the directory.
20394
20395
20396
20397 .option file_format appendfile string unset
20398 .cindex "file" "mailbox; checking existing format"
20399 This option requests the transport to check the format of an existing file
20400 before adding to it. The check consists of matching a specific string at the
20401 start of the file. The value of the option consists of an even number of
20402 colon-separated strings. The first of each pair is the test string, and the
20403 second is the name of a transport. If the transport associated with a matched
20404 string is not the current transport, control is passed over to the other
20405 transport. For example, suppose the standard &(local_delivery)& transport has
20406 this added to it:
20407 .code
20408 file_format = "From       : local_delivery :\
20409                \1\1\1\1\n : local_mmdf_delivery"
20410 .endd
20411 Mailboxes that begin with &"From"& are still handled by this transport, but if
20412 a mailbox begins with four binary ones followed by a newline, control is passed
20413 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20414 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20415 is assumed to match the current transport. If the start of a mailbox doesn't
20416 match any string, or if the transport named for a given string is not defined,
20417 delivery is deferred.
20418
20419
20420 .option file_must_exist appendfile boolean false
20421 If this option is true, the file specified by the &%file%& option must exist.
20422 A temporary error occurs if it does not, causing delivery to be deferred.
20423 If this option is false, the file is created if it does not exist.
20424
20425
20426 .option lock_fcntl_timeout appendfile time 0s
20427 .cindex "timeout" "mailbox locking"
20428 .cindex "mailbox" "locking, blocking and non-blocking"
20429 .cindex "locking files"
20430 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20431 when locking an open mailbox file. If the call fails, the delivery process
20432 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20433 Non-blocking calls are used so that the file is not kept open during the wait
20434 for the lock; the reason for this is to make it as safe as possible for
20435 deliveries over NFS in the case when processes might be accessing an NFS
20436 mailbox without using a lock file. This should not be done, but
20437 misunderstandings and hence misconfigurations are not unknown.
20438
20439 On a busy system, however, the performance of a non-blocking lock approach is
20440 not as good as using a blocking lock with a timeout. In this case, the waiting
20441 is done inside the system call, and Exim's delivery process acquires the lock
20442 and can proceed as soon as the previous lock holder releases it.
20443
20444 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20445 timeout, are used. There may still be some retrying: the maximum number of
20446 retries is
20447 .code
20448 (lock_retries * lock_interval) / lock_fcntl_timeout
20449 .endd
20450 rounded up to the next whole number. In other words, the total time during
20451 which &(appendfile)& is trying to get a lock is roughly the same, unless
20452 &%lock_fcntl_timeout%& is set very large.
20453
20454 You should consider setting this option if you are getting a lot of delayed
20455 local deliveries because of errors of the form
20456 .code
20457 failed to lock mailbox /some/file (fcntl)
20458 .endd
20459
20460 .option lock_flock_timeout appendfile time 0s
20461 This timeout applies to file locking when using &[flock()]& (see
20462 &%use_flock%&); the timeout operates in a similar manner to
20463 &%lock_fcntl_timeout%&.
20464
20465
20466 .option lock_interval appendfile time 3s
20467 This specifies the time to wait between attempts to lock the file. See below
20468 for details of locking.
20469
20470
20471 .option lock_retries appendfile integer 10
20472 This specifies the maximum number of attempts to lock the file. A value of zero
20473 is treated as 1. See below for details of locking.
20474
20475
20476 .option lockfile_mode appendfile "octal integer" 0600
20477 This specifies the mode of the created lock file, when a lock file is being
20478 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20479
20480
20481 .option lockfile_timeout appendfile time 30m
20482 .cindex "timeout" "mailbox locking"
20483 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20484 exists and is older than this value, it is assumed to have been left behind by
20485 accident, and Exim attempts to remove it.
20486
20487
20488 .option mailbox_filecount appendfile string&!! unset
20489 .cindex "mailbox" "specifying size of"
20490 .cindex "size" "of mailbox"
20491 If this option is set, it is expanded, and the result is taken as the current
20492 number of files in the mailbox. It must be a decimal number, optionally
20493 followed by K or M. This provides a way of obtaining this information from an
20494 external source that maintains the data.
20495
20496
20497 .option mailbox_size appendfile string&!! unset
20498 .cindex "mailbox" "specifying size of"
20499 .cindex "size" "of mailbox"
20500 If this option is set, it is expanded, and the result is taken as the current
20501 size the mailbox. It must be a decimal number, optionally followed by K or M.
20502 This provides a way of obtaining this information from an external source that
20503 maintains the data. This is likely to be helpful for maildir deliveries where
20504 it is computationally expensive to compute the size of a mailbox.
20505
20506
20507
20508 .option maildir_format appendfile boolean false
20509 .cindex "maildir format" "specifying"
20510 If this option is set with the &%directory%& option, the delivery is into a new
20511 file, in the &"maildir"& format that is used by other mail software. When the
20512 transport is activated directly from a &(redirect)& router (for example, the
20513 &(address_file)& transport in the default configuration), setting
20514 &%maildir_format%& causes the path received from the router to be treated as a
20515 directory, whether or not it ends with &`/`&. This option is available only if
20516 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20517 &<<SECTmaildirdelivery>>& below for further details.
20518
20519
20520 .option maildir_quota_directory_regex appendfile string "See below"
20521 .cindex "maildir format" "quota; directories included in"
20522 .cindex "quota" "maildir; directories included in"
20523 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20524 a regular expression for specifying directories, relative to the quota
20525 directory (see &%quota_directory%&), that should be included in the quota
20526 calculation. The default value is:
20527 .code
20528 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20529 .endd
20530 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20531 (directories whose names begin with a dot). If you want to exclude the
20532 &_Trash_&
20533 folder from the count (as some sites do), you need to change this setting to
20534 .code
20535 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20536 .endd
20537 This uses a negative lookahead in the regular expression to exclude the
20538 directory whose name is &_.Trash_&. When a directory is excluded from quota
20539 calculations, quota processing is bypassed for any messages that are delivered
20540 directly into that directory.
20541
20542
20543 .option maildir_retries appendfile integer 10
20544 This option specifies the number of times to retry when writing a file in
20545 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20546
20547
20548 .option maildir_tag appendfile string&!! unset
20549 This option applies only to deliveries in maildir format, and is described in
20550 section &<<SECTmaildirdelivery>>& below.
20551
20552
20553 .option maildir_use_size_file appendfile&!! boolean false
20554 .cindex "maildir format" "&_maildirsize_& file"
20555 The result of string expansion for this option must be a valid boolean value.
20556 If it is true, it enables support for &_maildirsize_& files. Exim
20557 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20558 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20559 value is zero. See &%maildir_quota_directory_regex%& above and section
20560 &<<SECTmaildirdelivery>>& below for further details.
20561
20562 .option maildirfolder_create_regex appendfile string unset
20563 .cindex "maildir format" "&_maildirfolder_& file"
20564 .cindex "&_maildirfolder_&, creating"
20565 The value of this option is a regular expression. If it is unset, it has no
20566 effect. Otherwise, before a maildir delivery takes place, the pattern is
20567 matched against the name of the maildir directory, that is, the directory
20568 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20569 delivery. If there is a match, Exim checks for the existence of a file called
20570 &_maildirfolder_& in the directory, and creates it if it does not exist.
20571 See section &<<SECTmaildirdelivery>>& for more details.
20572
20573
20574 .option mailstore_format appendfile boolean false
20575 .cindex "mailstore format" "specifying"
20576 If this option is set with the &%directory%& option, the delivery is into two
20577 new files in  &"mailstore"& format. The option is available only if
20578 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20579 below for further details.
20580
20581
20582 .option mailstore_prefix appendfile string&!! unset
20583 This option applies only to deliveries in mailstore format, and is described in
20584 section &<<SECTopdir>>& below.
20585
20586
20587 .option mailstore_suffix appendfile string&!! unset
20588 This option applies only to deliveries in mailstore format, and is described in
20589 section &<<SECTopdir>>& below.
20590
20591
20592 .option mbx_format appendfile boolean false
20593 .cindex "locking files"
20594 .cindex "file" "locking"
20595 .cindex "file" "MBX format"
20596 .cindex "MBX format, specifying"
20597 This option is available only if Exim has been compiled with SUPPORT_MBX
20598 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20599 the message is appended to the mailbox file in MBX format instead of
20600 traditional Unix format. This format is supported by Pine4 and its associated
20601 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20602
20603 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20604 automatically changed by the use of &%mbx_format%&. They should normally be set
20605 empty when using MBX format, so this option almost always appears in this
20606 combination:
20607 .code
20608 mbx_format = true
20609 message_prefix =
20610 message_suffix =
20611 .endd
20612 If none of the locking options are mentioned in the configuration,
20613 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20614 is possible to specify the other kinds of locking with &%mbx_format%&, but
20615 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20616 interworks with &'c-client'&, providing for shared access to the mailbox. It
20617 should not be used if any program that does not use this form of locking is
20618 going to access the mailbox, nor should it be used if the mailbox file is NFS
20619 mounted, because it works only when the mailbox is accessed from a single host.
20620
20621 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20622 the standard version of &'c-client'&, because as long as it has a mailbox open
20623 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20624 append messages to it.
20625
20626
20627 .option message_prefix appendfile string&!! "see below"
20628 .cindex "&""From""& line"
20629 The string specified here is expanded and output at the start of every message.
20630 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20631 in which case it is:
20632 .code
20633 message_prefix = "From ${if def:return_path{$return_path}\
20634   {MAILER-DAEMON}} $tod_bsdinbox\n"
20635 .endd
20636 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20637 &`\n`& to &`\r\n`& in &%message_prefix%&.
20638
20639 .option message_suffix appendfile string&!! "see below"
20640 The string specified here is expanded and output at the end of every message.
20641 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20642 in which case it is a single newline character. The suffix can be suppressed by
20643 setting
20644 .code
20645 message_suffix =
20646 .endd
20647 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20648 &`\n`& to &`\r\n`& in &%message_suffix%&.
20649
20650 .option mode appendfile "octal integer" 0600
20651 If the output file is created, it is given this mode. If it already exists and
20652 has wider permissions, they are reduced to this mode. If it has narrower
20653 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20654 if the delivery is the result of a &%save%& command in a filter file specifying
20655 a particular mode, the mode of the output file is always forced to take that
20656 value, and this option is ignored.
20657
20658
20659 .option mode_fail_narrower appendfile boolean true
20660 This option applies in the case when an existing mailbox file has a narrower
20661 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20662 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20663 continues with the delivery attempt, using the existing mode of the file.
20664
20665
20666 .option notify_comsat appendfile boolean false
20667 If this option is true, the &'comsat'& daemon is notified after every
20668 successful delivery to a user mailbox. This is the daemon that notifies logged
20669 on users about incoming mail.
20670
20671
20672 .option quota appendfile string&!! unset
20673 .cindex "quota" "imposed by Exim"
20674 This option imposes a limit on the size of the file to which Exim is appending,
20675 or to the total space used in the directory tree when the &%directory%& option
20676 is set. In the latter case, computation of the space used is expensive, because
20677 all the files in the directory (and any sub-directories) have to be
20678 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20679 &%maildir_use_size_file%& for ways to avoid this in environments where users
20680 have no shell access to their mailboxes).
20681
20682 As there is no interlock against two simultaneous deliveries into a
20683 multi-file mailbox, it is possible for the quota to be overrun in this case.
20684 For single-file mailboxes, of course, an interlock is a necessity.
20685
20686 A file's size is taken as its &'used'& value. Because of blocking effects, this
20687 may be a lot less than the actual amount of disk space allocated to the file.
20688 If the sizes of a number of files are being added up, the rounding effect can
20689 become quite noticeable, especially on systems that have large block sizes.
20690 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20691 the obvious value which users understand most easily.
20692
20693 The value of the option is expanded, and must then be a numerical value
20694 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20695 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20696 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20697 be handled.
20698
20699 &*Note*&: A value of zero is interpreted as &"no quota"&.
20700
20701 The expansion happens while Exim is running as root, before it changes uid for
20702 the delivery. This means that files that are inaccessible to the end user can
20703 be used to hold quota values that are looked up in the expansion. When delivery
20704 fails because this quota is exceeded, the handling of the error is as for
20705 system quota failures.
20706
20707 By default, Exim's quota checking mimics system quotas, and restricts the
20708 mailbox to the specified maximum size, though the value is not accurate to the
20709 last byte, owing to separator lines and additional headers that may get added
20710 during message delivery. When a mailbox is nearly full, large messages may get
20711 refused even though small ones are accepted, because the size of the current
20712 message is added to the quota when the check is made. This behaviour can be
20713 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20714 for exceeding the quota does not include the current message. Thus, deliveries
20715 continue until the quota has been exceeded; thereafter, no further messages are
20716 delivered. See also &%quota_warn_threshold%&.
20717
20718
20719 .option quota_directory appendfile string&!! unset
20720 This option defines the directory to check for quota purposes when delivering
20721 into individual files. The default is the delivery directory, or, if a file
20722 called &_maildirfolder_& exists in a maildir directory, the parent of the
20723 delivery directory.
20724
20725
20726 .option quota_filecount appendfile string&!! 0
20727 This option applies when the &%directory%& option is set. It limits the total
20728 number of files in the directory (compare the inode limit in system quotas). It
20729 can only be used if &%quota%& is also set. The value is expanded; an expansion
20730 failure causes delivery to be deferred. A value of zero is interpreted as
20731 &"no quota"&.
20732
20733
20734 .option quota_is_inclusive appendfile boolean true
20735 See &%quota%& above.
20736
20737
20738 .option quota_size_regex appendfile string unset
20739 This option applies when one of the delivery modes that writes a separate file
20740 for each message is being used. When Exim wants to find the size of one of
20741 these files in order to test the quota, it first checks &%quota_size_regex%&.
20742 If this is set to a regular expression that matches the file name, and it
20743 captures one string, that string is interpreted as a representation of the
20744 file's size. The value of &%quota_size_regex%& is not expanded.
20745
20746 This feature is useful only when users have no shell access to their mailboxes
20747 &-- otherwise they could defeat the quota simply by renaming the files. This
20748 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20749 the file length to the file name. For example:
20750 .code
20751 maildir_tag = ,S=$message_size
20752 quota_size_regex = ,S=(\d+)
20753 .endd
20754 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20755 number of lines in the message.
20756
20757 The regular expression should not assume that the length is at the end of the
20758 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20759 sometimes add other information onto the ends of message file names.
20760
20761 Section &<<SECID136>>& contains further information.
20762
20763
20764 .option quota_warn_message appendfile string&!! "see below"
20765 See below for the use of this option. If it is not set when
20766 &%quota_warn_threshold%& is set, it defaults to
20767 .code
20768 quota_warn_message = "\
20769   To: $local_part@$domain\n\
20770   Subject: Your mailbox\n\n\
20771   This message is automatically created \
20772   by mail delivery software.\n\n\
20773   The size of your mailbox has exceeded \
20774   a warning threshold that is\n\
20775   set by the system administrator.\n"
20776 .endd
20777
20778
20779 .option quota_warn_threshold appendfile string&!! 0
20780 .cindex "quota" "warning threshold"
20781 .cindex "mailbox" "size warning"
20782 .cindex "size" "of mailbox"
20783 This option is expanded in the same way as &%quota%& (see above). If the
20784 resulting value is greater than zero, and delivery of the message causes the
20785 size of the file or total space in the directory tree to cross the given
20786 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20787 may be specified as a percentage of it by following the value with a percent
20788 sign. For example:
20789 .code
20790 quota = 10M
20791 quota_warn_threshold = 75%
20792 .endd
20793 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20794 percent sign is ignored.
20795
20796 The warning message itself is specified by the &%quota_warn_message%& option,
20797 and it must start with a &'To:'& header line containing the recipient(s) of the
20798 warning message. These do not necessarily have to include the recipient(s) of
20799 the original message. A &'Subject:'& line should also normally be supplied. You
20800 can include any other header lines that you want. If you do not include a
20801 &'From:'& line, the default is:
20802 .code
20803 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20804 .endd
20805 .oindex &%errors_reply_to%&
20806 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20807 option.
20808
20809 The &%quota%& option does not have to be set in order to use this option; they
20810 are independent of one another except when the threshold is specified as a
20811 percentage.
20812
20813
20814 .option use_bsmtp appendfile boolean false
20815 .cindex "envelope sender"
20816 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20817 format, with the envelope sender and recipient(s) included as SMTP commands. If
20818 you want to include a leading HELO command with such messages, you can do
20819 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20820 for details of batch SMTP.
20821
20822
20823 .option use_crlf appendfile boolean false
20824 .cindex "carriage return"
20825 .cindex "linefeed"
20826 This option causes lines to be terminated with the two-character CRLF sequence
20827 (carriage return, linefeed) instead of just a linefeed character. In the case
20828 of batched SMTP, the byte sequence written to the file is then an exact image
20829 of what would be sent down a real SMTP connection.
20830
20831 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20832 (which are used to supply the traditional &"From&~"& and blank line separators
20833 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20834 carriage return characters if these are needed. In cases where these options
20835 have non-empty defaults, the values end with a single linefeed, so they must be
20836 changed to end with &`\r\n`& if &%use_crlf%& is set.
20837
20838
20839 .option use_fcntl_lock appendfile boolean "see below"
20840 This option controls the use of the &[fcntl()]& function to lock a file for
20841 exclusive use when a message is being appended. It is set by default unless
20842 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20843 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20844 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20845
20846
20847 .option use_flock_lock appendfile boolean false
20848 This option is provided to support the use of &[flock()]& for file locking, for
20849 the few situations where it is needed. Most modern operating systems support
20850 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20851 each other. Exim uses &[fcntl()]& locking by default.
20852
20853 This option is required only if you are using an operating system where
20854 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20855 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20856 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20857
20858 .cindex "Solaris" "&[flock()]& support"
20859 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20860 have it (and some, I think, provide a not quite right version built on top of
20861 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20862 the ability to use it, and any attempt to do so will cause a configuration
20863 error.
20864
20865 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20866 is just being mapped onto &[fcntl()]& by the OS).
20867
20868
20869 .option use_lockfile appendfile boolean "see below"
20870 If this option is turned off, Exim does not attempt to create a lock file when
20871 appending to a mailbox file. In this situation, the only locking is by
20872 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20873 sure that every MUA that is ever going to look at your users' mailboxes uses
20874 &[fcntl()]& rather than a lock file, and even then only when you are not
20875 delivering over NFS from more than one host.
20876
20877 .cindex "NFS" "lock file"
20878 In order to append to an NFS file safely from more than one host, it is
20879 necessary to take out a lock &'before'& opening the file, and the lock file
20880 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20881 file corruption.
20882
20883 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20884 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20885 except when &%mbx_format%& is set.
20886
20887
20888 .option use_mbx_lock appendfile boolean "see below"
20889 This option is available only if Exim has been compiled with SUPPORT_MBX
20890 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20891 locking rules be used. It is set by default if &%mbx_format%& is set and none
20892 of the locking options are mentioned in the configuration. The locking rules
20893 are the same as are used by the &'c-client'& library that underlies Pine and
20894 the IMAP4 and POP daemons that come with it (see the discussion below). The
20895 rules allow for shared access to the mailbox. However, this kind of locking
20896 does not work when the mailbox is NFS mounted.
20897
20898 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20899 &%use_flock_lock%& to control what kind of locking is used in implementing the
20900 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20901 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20902
20903
20904
20905
20906 .section "Operational details for appending" "SECTopappend"
20907 .cindex "appending to a file"
20908 .cindex "file" "appending"
20909 Before appending to a file, the following preparations are made:
20910
20911 .ilist
20912 If the name of the file is &_/dev/null_&, no action is taken, and a success
20913 return is given.
20914
20915 .next
20916 .cindex "directory creation"
20917 If any directories on the file's path are missing, Exim creates them if the
20918 &%create_directory%& option is set. A created directory's mode is given by the
20919 &%directory_mode%& option.
20920
20921 .next
20922 If &%file_format%& is set, the format of an existing file is checked. If this
20923 indicates that a different transport should be used, control is passed to that
20924 transport.
20925
20926 .next
20927 .cindex "file" "locking"
20928 .cindex "locking files"
20929 .cindex "NFS" "lock file"
20930 If &%use_lockfile%& is set, a lock file is built in a way that will work
20931 reliably over NFS, as follows:
20932
20933 .olist
20934 Create a &"hitching post"& file whose name is that of the lock file with the
20935 current time, primary host name, and process id added, by opening for writing
20936 as a new file. If this fails with an access error, delivery is deferred.
20937 .next
20938 Close the hitching post file, and hard link it to the lock file name.
20939 .next
20940 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20941 Unlink the hitching post name.
20942 .next
20943 Otherwise, use &[stat()]& to get information about the hitching post file, and
20944 then unlink hitching post name. If the number of links is exactly two, creation
20945 of the lock file succeeded but something (for example, an NFS server crash and
20946 restart) caused this fact not to be communicated to the &[link()]& call.
20947 .next
20948 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20949 up to &%lock_retries%& times. However, since any program that writes to a
20950 mailbox should complete its task very quickly, it is reasonable to time out old
20951 lock files that are normally the result of user agent and system crashes. If an
20952 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20953 it before trying again.
20954 .endlist olist
20955
20956 .next
20957 A call is made to &[lstat()]& to discover whether the main file exists, and if
20958 so, what its characteristics are. If &[lstat()]& fails for any reason other
20959 than non-existence, delivery is deferred.
20960
20961 .next
20962 .cindex "symbolic link" "to mailbox"
20963 .cindex "mailbox" "symbolic link"
20964 If the file does exist and is a symbolic link, delivery is deferred, unless the
20965 &%allow_symlink%& option is set, in which case the ownership of the link is
20966 checked, and then &[stat()]& is called to find out about the real file, which
20967 is then subjected to the checks below. The check on the top-level link
20968 ownership prevents one user creating a link for another's mailbox in a sticky
20969 directory, though allowing symbolic links in this case is definitely not a good
20970 idea. If there is a chain of symbolic links, the intermediate ones are not
20971 checked.
20972
20973 .next
20974 If the file already exists but is not a regular file, or if the file's owner
20975 and group (if the group is being checked &-- see &%check_group%& above) are
20976 different from the user and group under which the delivery is running,
20977 delivery is deferred.
20978
20979 .next
20980 If the file's permissions are more generous than specified, they are reduced.
20981 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20982 is set false, in which case the delivery is tried using the existing
20983 permissions.
20984
20985 .next
20986 The file's inode number is saved, and the file is then opened for appending.
20987 If this fails because the file has vanished, &(appendfile)& behaves as if it
20988 hadn't existed (see below). For any other failures, delivery is deferred.
20989
20990 .next
20991 If the file is opened successfully, check that the inode number hasn't
20992 changed, that it is still a regular file, and that the owner and permissions
20993 have not changed. If anything is wrong, defer delivery and freeze the message.
20994
20995 .next
20996 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20997 option is set. Otherwise, check that the file is being created in a permitted
20998 directory if the &%create_file%& option is set (deferring on failure), and then
20999 open for writing as a new file, with the O_EXCL and O_CREAT options,
21000 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21001 set). In this case, which can happen if the link points to a non-existent file,
21002 the file is opened for writing using O_CREAT but not O_EXCL, because
21003 that prevents link following.
21004
21005 .next
21006 .cindex "loop" "while file testing"
21007 If opening fails because the file exists, obey the tests given above for
21008 existing files. However, to avoid looping in a situation where the file is
21009 being continuously created and destroyed, the exists/not-exists loop is broken
21010 after 10 repetitions, and the message is then frozen.
21011
21012 .next
21013 If opening fails with any other error, defer delivery.
21014
21015 .next
21016 .cindex "file" "locking"
21017 .cindex "locking files"
21018 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21019 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21020 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21021 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21022 file, and an exclusive lock on the file whose name is
21023 .code
21024 /tmp/.<device-number>.<inode-number>
21025 .endd
21026 using the device and inode numbers of the open mailbox file, in accordance with
21027 the MBX locking rules. This file is created with a mode that is specified by
21028 the &%lockfile_mode%& option.
21029
21030 If Exim fails to lock the file, there are two possible courses of action,
21031 depending on the value of the locking timeout. This is obtained from
21032 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21033
21034 If the timeout value is zero, the file is closed, Exim waits for
21035 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21036 to lock it again. This happens up to &%lock_retries%& times, after which the
21037 delivery is deferred.
21038
21039 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21040 &[flock()]& are used (with the given timeout), so there has already been some
21041 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21042 immediately. It retries up to
21043 .code
21044 (lock_retries * lock_interval) / <timeout>
21045 .endd
21046 times (rounded up).
21047 .endlist
21048
21049 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21050 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21051
21052
21053 .section "Operational details for delivery to a new file" "SECTopdir"
21054 .cindex "delivery" "to single file"
21055 .cindex "&""From""& line"
21056 When the &%directory%& option is set instead of &%file%&, each message is
21057 delivered into a newly-created file or set of files. When &(appendfile)& is
21058 activated directly from a &(redirect)& router, neither &%file%& nor
21059 &%directory%& is normally set, because the path for delivery is supplied by the
21060 router. (See for example, the &(address_file)& transport in the default
21061 configuration.) In this case, delivery is to a new file if either the path name
21062 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21063
21064 No locking is required while writing the message to a new file, so the various
21065 locking options of the transport are ignored. The &"From"& line that by default
21066 separates messages in a single file is not normally needed, nor is the escaping
21067 of message lines that start with &"From"&, and there is no need to ensure a
21068 newline at the end of each message. Consequently, the default values for
21069 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21070 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21071
21072 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21073 the files in the delivery directory by default. However, you can specify a
21074 different directory by setting &%quota_directory%&. Also, for maildir
21075 deliveries (see below) the &_maildirfolder_& convention is honoured.
21076
21077
21078 .cindex "maildir format"
21079 .cindex "mailstore format"
21080 There are three different ways in which delivery to individual files can be
21081 done, controlled by the settings of the &%maildir_format%& and
21082 &%mailstore_format%& options. Note that code to support maildir or mailstore
21083 formats is not included in the binary unless SUPPORT_MAILDIR or
21084 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21085
21086 .cindex "directory creation"
21087 In all three cases an attempt is made to create the directory and any necessary
21088 sub-directories if they do not exist, provided that the &%create_directory%&
21089 option is set (the default). The location of a created directory can be
21090 constrained by setting &%create_file%&. A created directory's mode is given by
21091 the &%directory_mode%& option. If creation fails, or if the
21092 &%create_directory%& option is not set when creation is required, delivery is
21093 deferred.
21094
21095
21096
21097 .section "Maildir delivery" "SECTmaildirdelivery"
21098 .cindex "maildir format" "description of"
21099 If the &%maildir_format%& option is true, Exim delivers each message by writing
21100 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21101 directory that is defined by the &%directory%& option (the &"delivery
21102 directory"&). If the delivery is successful, the file is renamed into the
21103 &_new_& subdirectory.
21104
21105 In the file name, <&'stime'&> is the current time of day in seconds, and
21106 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21107 Exim checks that the time-of-day clock has moved on by at least one microsecond
21108 before terminating the delivery process. This guarantees uniqueness for the
21109 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21110 opening it. If any response other than ENOENT (does not exist) is given,
21111 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21112
21113 Before Exim carries out a maildir delivery, it ensures that subdirectories
21114 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21115 do not exist, Exim tries to create them and any superior directories in their
21116 path, subject to the &%create_directory%& and &%create_file%& options. If the
21117 &%maildirfolder_create_regex%& option is set, and the regular expression it
21118 contains matches the delivery directory, Exim also ensures that a file called
21119 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21120 &_maildirfolder_& file cannot be created, delivery is deferred.
21121
21122 These features make it possible to use Exim to create all the necessary files
21123 and directories in a maildir mailbox, including subdirectories for maildir++
21124 folders. Consider this example:
21125 .code
21126 maildir_format = true
21127 directory = /var/mail/$local_part\
21128            ${if eq{$local_part_suffix}{}{}\
21129            {/.${substr_1:$local_part_suffix}}}
21130 maildirfolder_create_regex = /\.[^/]+$
21131 .endd
21132 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21133 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21134 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21135 not match this name, so Exim will not look for or create the file
21136 &_/var/mail/pimbo/maildirfolder_&, though it will create
21137 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21138
21139 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21140 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21141 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21142 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21143 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21144
21145 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21146 not inadvertently match the toplevel maildir directory, because a
21147 &_maildirfolder_& file at top level would completely break quota calculations.
21148
21149 .cindex "quota" "in maildir delivery"
21150 .cindex "maildir++"
21151 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21152 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21153 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21154 Exim assumes the directory is a maildir++ folder directory, which is one level
21155 down from the user's top level mailbox directory. This causes it to start at
21156 the parent directory instead of the current directory when calculating the
21157 amount of space used.
21158
21159 One problem with delivering into a multi-file mailbox is that it is
21160 computationally expensive to compute the size of the mailbox for quota
21161 checking. Various approaches have been taken to reduce the amount of work
21162 needed. The next two sections describe two of them. A third alternative is to
21163 use some external process for maintaining the size data, and use the expansion
21164 of the &%mailbox_size%& option as a way of importing it into Exim.
21165
21166
21167
21168
21169 .section "Using tags to record message sizes" "SECID135"
21170 If &%maildir_tag%& is set, the string is expanded for each delivery.
21171 When the maildir file is renamed into the &_new_& sub-directory, the
21172 tag is added to its name. However, if adding the tag takes the length of the
21173 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21174 the tag is dropped and the maildir file is created with no tag.
21175
21176
21177 .vindex "&$message_size$&"
21178 Tags can be used to encode the size of files in their names; see
21179 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21180 happens after the message has been written. The value of the &$message_size$&
21181 variable is set to the number of bytes actually written. If the expansion is
21182 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21183 be deferred. The expanded tag may contain any printing characters except &"/"&.
21184 Non-printing characters in the string are ignored; if the resulting string is
21185 empty, it is ignored. If it starts with an alphanumeric character, a leading
21186 colon is inserted; this default has not proven to be the path that popular
21187 maildir implementations have chosen (but changing it in Exim would break
21188 backwards compatibility).
21189
21190 For one common implementation, you might set:
21191 .code
21192 maildir_tag = ,S=${message_size}
21193 .endd
21194 but you should check the documentation of the other software to be sure.
21195
21196 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21197 as this allows Exim to extract the size from your tag, instead of having to
21198 &[stat()]& each message file.
21199
21200
21201 .section "Using a maildirsize file" "SECID136"
21202 .cindex "quota" "in maildir delivery"
21203 .cindex "maildir format" "&_maildirsize_& file"
21204 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21205 storing quota and message size information in a file called &_maildirsize_&
21206 within the toplevel maildir directory. If this file does not exist, Exim
21207 creates it, setting the quota from the &%quota%& option of the transport. If
21208 the maildir directory itself does not exist, it is created before any attempt
21209 to write a &_maildirsize_& file.
21210
21211 The &_maildirsize_& file is used to hold information about the sizes of
21212 messages in the maildir, thus speeding up quota calculations. The quota value
21213 in the file is just a cache; if the quota is changed in the transport, the new
21214 value overrides the cached value when the next message is delivered. The cache
21215 is maintained for the benefit of other programs that access the maildir and
21216 need to know the quota.
21217
21218 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21219 file is maintained (with a zero quota setting), but no quota is imposed.
21220
21221 A regular expression is available for controlling which directories in the
21222 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21223 See the description of the &%maildir_quota_directory_regex%& option above for
21224 details.
21225
21226
21227 .section "Mailstore delivery" "SECID137"
21228 .cindex "mailstore format" "description of"
21229 If the &%mailstore_format%& option is true, each message is written as two
21230 files in the given directory. A unique base name is constructed from the
21231 message id and the current delivery process, and the files that are written use
21232 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21233 contains the message's envelope, and the &_.msg_& file contains the message
21234 itself. The base name is placed in the variable &$mailstore_basename$&.
21235
21236 During delivery, the envelope is first written to a file with the suffix
21237 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21238 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21239 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21240 file before accessing either of them. An alternative approach is to wait for
21241 the absence of a &_.tmp_& file.
21242
21243 The envelope file starts with any text defined by the &%mailstore_prefix%&
21244 option, expanded and terminated by a newline if there isn't one. Then follows
21245 the sender address on one line, then all the recipient addresses, one per line.
21246 There can be more than one recipient only if the &%batch_max%& option is set
21247 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21248 appended to the file, followed by a newline if it does not end with one.
21249
21250 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21251 failure, it is ignored. Other expansion errors are treated as serious
21252 configuration errors, and delivery is deferred. The variable
21253 &$mailstore_basename$& is available for use during these expansions.
21254
21255
21256 .section "Non-special new file delivery" "SECID138"
21257 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21258 file is created directly in the named directory. For example, when delivering
21259 messages into files in batched SMTP format for later delivery to some host (see
21260 section &<<SECTbatchSMTP>>&), a setting such as
21261 .code
21262 directory = /var/bsmtp/$host
21263 .endd
21264 might be used. A message is written to a file with a temporary name, which is
21265 then renamed when the delivery is complete. The final name is obtained by
21266 expanding the contents of the &%directory_file%& option.
21267 .ecindex IIDapptra1
21268 .ecindex IIDapptra2
21269
21270
21271
21272
21273
21274
21275 . ////////////////////////////////////////////////////////////////////////////
21276 . ////////////////////////////////////////////////////////////////////////////
21277
21278 .chapter "The autoreply transport" "CHID8"
21279 .scindex IIDauttra1 "transports" "&(autoreply)&"
21280 .scindex IIDauttra2 "&(autoreply)& transport"
21281 The &(autoreply)& transport is not a true transport in that it does not cause
21282 the message to be transmitted. Instead, it generates a new mail message as an
21283 automatic reply to the incoming message. &'References:'& and
21284 &'Auto-Submitted:'& header lines are included. These are constructed according
21285 to the rules in RFCs 2822 and 3834, respectively.
21286
21287 If the router that passes the message to this transport does not have the
21288 &%unseen%& option set, the original message (for the current recipient) is not
21289 delivered anywhere. However, when the &%unseen%& option is set on the router
21290 that passes the message to this transport, routing of the address continues, so
21291 another router can set up a normal message delivery.
21292
21293
21294 The &(autoreply)& transport is usually run as the result of mail filtering, a
21295 &"vacation"& message being the standard example. However, it can also be run
21296 directly from a router like any other transport. To reduce the possibility of
21297 message cascades, messages created by the &(autoreply)& transport always have
21298 empty envelope sender addresses, like bounce messages.
21299
21300 The parameters of the message to be sent can be specified in the configuration
21301 by options described below. However, these are used only when the address
21302 passed to the transport does not contain its own reply information. When the
21303 transport is run as a consequence of a
21304 &%mail%&
21305 or &%vacation%& command in a filter file, the parameters of the message are
21306 supplied by the filter, and passed with the address. The transport's options
21307 that define the message are then ignored (so they are not usually set in this
21308 case). The message is specified entirely by the filter or by the transport; it
21309 is never built from a mixture of options. However, the &%file_optional%&,
21310 &%mode%&, and &%return_message%& options apply in all cases.
21311
21312 &(Autoreply)& is implemented as a local transport. When used as a result of a
21313 command in a user's filter file, &(autoreply)& normally runs under the uid and
21314 gid of the user, and with appropriate current and home directories (see chapter
21315 &<<CHAPenvironment>>&).
21316
21317 There is a subtle difference between routing a message to a &(pipe)& transport
21318 that generates some text to be returned to the sender, and routing it to an
21319 &(autoreply)& transport. This difference is noticeable only if more than one
21320 address from the same message is so handled. In the case of a pipe, the
21321 separate outputs from the different addresses are gathered up and returned to
21322 the sender in a single message, whereas if &(autoreply)& is used, a separate
21323 message is generated for each address that is passed to it.
21324
21325 Non-printing characters are not permitted in the header lines generated for the
21326 message that &(autoreply)& creates, with the exception of newlines that are
21327 immediately followed by white space. If any non-printing characters are found,
21328 the transport defers.
21329 Whether characters with the top bit set count as printing characters or not is
21330 controlled by the &%print_topbitchars%& global option.
21331
21332 If any of the generic options for manipulating headers (for example,
21333 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21334 of the original message that is included in the generated message when
21335 &%return_message%& is set. They do not apply to the generated message itself.
21336
21337 .vindex "&$sender_address$&"
21338 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21339 the message, indicating that there were no recipients, it does not treat this
21340 as an error. This means that autoreplies sent to &$sender_address$& when this
21341 is empty (because the incoming message is a bounce message) do not cause
21342 problems. They are just discarded.
21343
21344
21345
21346 .section "Private options for autoreply" "SECID139"
21347 .cindex "options" "&(autoreply)& transport"
21348
21349 .option bcc autoreply string&!! unset
21350 This specifies the addresses that are to receive &"blind carbon copies"& of the
21351 message when the message is specified by the transport.
21352
21353
21354 .option cc autoreply string&!! unset
21355 This specifies recipients of the message and the contents of the &'Cc:'& header
21356 when the message is specified by the transport.
21357
21358
21359 .option file autoreply string&!! unset
21360 The contents of the file are sent as the body of the message when the message
21361 is specified by the transport. If both &%file%& and &%text%& are set, the text
21362 string comes first.
21363
21364
21365 .option file_expand autoreply boolean false
21366 If this is set, the contents of the file named by the &%file%& option are
21367 subjected to string expansion as they are added to the message.
21368
21369
21370 .option file_optional autoreply boolean false
21371 If this option is true, no error is generated if the file named by the &%file%&
21372 option or passed with the address does not exist or cannot be read.
21373
21374
21375 .option from autoreply string&!! unset
21376 This specifies the contents of the &'From:'& header when the message is
21377 specified by the transport.
21378
21379
21380 .option headers autoreply string&!! unset
21381 This specifies additional RFC 2822 headers that are to be added to the message
21382 when the message is specified by the transport. Several can be given by using
21383 &"\n"& to separate them. There is no check on the format.
21384
21385
21386 .option log autoreply string&!! unset
21387 This option names a file in which a record of every message sent is logged when
21388 the message is specified by the transport.
21389
21390
21391 .option mode autoreply "octal integer" 0600
21392 If either the log file or the &"once"& file has to be created, this mode is
21393 used.
21394
21395
21396 .option never_mail autoreply "address list&!!" unset
21397 If any run of the transport creates a message with a recipient that matches any
21398 item in the list, that recipient is quietly discarded. If all recipients are
21399 discarded, no message is created. This applies both when the recipients are
21400 generated by a filter and when they are specified in the transport.
21401
21402
21403
21404 .option once autoreply string&!! unset
21405 This option names a file or DBM database in which a record of each &'To:'&
21406 recipient is kept when the message is specified by the transport. &*Note*&:
21407 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21408
21409 If &%once%& is unset, or is set to an empty string, the message is always sent.
21410 By default, if &%once%& is set to a non-empty file name, the message
21411 is not sent if a potential recipient is already listed in the database.
21412 However, if the &%once_repeat%& option specifies a time greater than zero, the
21413 message is sent if that much time has elapsed since a message was last sent to
21414 this recipient. A setting of zero time for &%once_repeat%& (the default)
21415 prevents a message from being sent a second time &-- in this case, zero means
21416 infinity.
21417
21418 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21419 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21420 greater than zero, it changes the way Exim implements the &%once%& option.
21421 Instead of using a DBM file to record every recipient it sends to, it uses a
21422 regular file, whose size will never get larger than the given value.
21423
21424 In the file, Exim keeps a linear list of recipient addresses and the times at
21425 which they were sent messages. If the file is full when a new address needs to
21426 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21427 means that a given recipient may receive multiple messages, but at
21428 unpredictable intervals that depend on the rate of turnover of addresses in the
21429 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21430
21431
21432 .option once_file_size autoreply integer 0
21433 See &%once%& above.
21434
21435
21436 .option once_repeat autoreply time&!! 0s
21437 See &%once%& above.
21438 After expansion, the value of this option must be a valid time value.
21439
21440
21441 .option reply_to autoreply string&!! unset
21442 This specifies the contents of the &'Reply-To:'& header when the message is
21443 specified by the transport.
21444
21445
21446 .option return_message autoreply boolean false
21447 If this is set, a copy of the original message is returned with the new
21448 message, subject to the maximum size set in the &%return_size_limit%& global
21449 configuration option.
21450
21451
21452 .option subject autoreply string&!! unset
21453 This specifies the contents of the &'Subject:'& header when the message is
21454 specified by the transport. It is tempting to quote the original subject in
21455 automatic responses. For example:
21456 .code
21457 subject = Re: $h_subject:
21458 .endd
21459 There is a danger in doing this, however. It may allow a third party to
21460 subscribe your users to an opt-in mailing list, provided that the list accepts
21461 bounce messages as subscription confirmations. Well-managed lists require a
21462 non-bounce message to confirm a subscription, so the danger is relatively
21463 small.
21464
21465
21466
21467 .option text autoreply string&!! unset
21468 This specifies a single string to be used as the body of the message when the
21469 message is specified by the transport. If both &%text%& and &%file%& are set,
21470 the text comes first.
21471
21472
21473 .option to autoreply string&!! unset
21474 This specifies recipients of the message and the contents of the &'To:'& header
21475 when the message is specified by the transport.
21476 .ecindex IIDauttra1
21477 .ecindex IIDauttra2
21478
21479
21480
21481
21482 . ////////////////////////////////////////////////////////////////////////////
21483 . ////////////////////////////////////////////////////////////////////////////
21484
21485 .chapter "The lmtp transport" "CHAPLMTP"
21486 .cindex "transports" "&(lmtp)&"
21487 .cindex "&(lmtp)& transport"
21488 .cindex "LMTP" "over a pipe"
21489 .cindex "LMTP" "over a socket"
21490 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21491 specified command
21492 or by interacting with a Unix domain socket.
21493 This transport is something of a cross between the &(pipe)& and &(smtp)&
21494 transports. Exim also has support for using LMTP over TCP/IP; this is
21495 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21496 to be of minority interest, the default build-time configure in &_src/EDITME_&
21497 has it commented out. You need to ensure that
21498 .code
21499 TRANSPORT_LMTP=yes
21500 .endd
21501 .cindex "options" "&(lmtp)& transport"
21502 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21503 included in the Exim binary. The private options of the &(lmtp)& transport are
21504 as follows:
21505
21506 .option batch_id lmtp string&!! unset
21507 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21508
21509
21510 .option batch_max lmtp integer 1
21511 This limits the number of addresses that can be handled in a single delivery.
21512 Most LMTP servers can handle several addresses at once, so it is normally a
21513 good idea to increase this value. See the description of local delivery
21514 batching in chapter &<<CHAPbatching>>&.
21515
21516
21517 .option command lmtp string&!! unset
21518 This option must be set if &%socket%& is not set. The string is a command which
21519 is run in a separate process. It is split up into a command name and list of
21520 arguments, each of which is separately expanded (so expansion cannot change the
21521 number of arguments). The command is run directly, not via a shell. The message
21522 is passed to the new process using the standard input and output to operate the
21523 LMTP protocol.
21524
21525 .option ignore_quota lmtp boolean false
21526 .cindex "LMTP" "ignoring quota errors"
21527 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21528 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21529 in its response to the LHLO command.
21530
21531 .option socket lmtp string&!! unset
21532 This option must be set if &%command%& is not set. The result of expansion must
21533 be the name of a Unix domain socket. The transport connects to the socket and
21534 delivers the message to it using the LMTP protocol.
21535
21536
21537 .option timeout lmtp time 5m
21538 The transport is aborted if the created process or Unix domain socket does not
21539 respond to LMTP commands or message input within this timeout. Delivery
21540 is deferred, and will be tried again later. Here is an example of a typical
21541 LMTP transport:
21542 .code
21543 lmtp:
21544   driver = lmtp
21545   command = /some/local/lmtp/delivery/program
21546   batch_max = 20
21547   user = exim
21548 .endd
21549 This delivers up to 20 addresses at a time, in a mixture of domains if
21550 necessary, running as the user &'exim'&.
21551
21552
21553
21554 . ////////////////////////////////////////////////////////////////////////////
21555 . ////////////////////////////////////////////////////////////////////////////
21556
21557 .chapter "The pipe transport" "CHAPpipetransport"
21558 .scindex IIDpiptra1 "transports" "&(pipe)&"
21559 .scindex IIDpiptra2 "&(pipe)& transport"
21560 The &(pipe)& transport is used to deliver messages via a pipe to a command
21561 running in another process. One example is the use of &(pipe)& as a
21562 pseudo-remote transport for passing messages to some other delivery mechanism
21563 (such as UUCP). Another is the use by individual users to automatically process
21564 their incoming messages. The &(pipe)& transport can be used in one of the
21565 following ways:
21566
21567 .ilist
21568 .vindex "&$local_part$&"
21569 A router routes one address to a transport in the normal way, and the
21570 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21571 contains the local part of the address (as usual), and the command that is run
21572 is specified by the &%command%& option on the transport.
21573 .next
21574 .vindex "&$pipe_addresses$&"
21575 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21576 transport can handle more than one address in a single run. In this case, when
21577 more than one address is routed to the transport, &$local_part$& is not set
21578 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21579 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21580 that are routed to the transport.
21581 .next
21582 .vindex "&$address_pipe$&"
21583 A router redirects an address directly to a pipe command (for example, from an
21584 alias or forward file). In this case, &$address_pipe$& contains the text of the
21585 pipe command, and the &%command%& option on the transport is ignored. If only
21586 one address is being transported (&%batch_max%& is not greater than one, or
21587 only one address was redirected to this pipe command), &$local_part$& contains
21588 the local part that was redirected.
21589 .endlist
21590
21591
21592 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21593 deliver messages over pipes using the LMTP interactive protocol. This is
21594 implemented by the &(lmtp)& transport.
21595
21596 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21597 &_.forward_& file, the command runs under the uid and gid of that user. In
21598 other cases, the uid and gid have to be specified explicitly, either on the
21599 transport or on the router that handles the address. Current and &"home"&
21600 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21601 details of the local delivery environment and chapter &<<CHAPbatching>>&
21602 for a discussion of local delivery batching.
21603
21604
21605 .section "Concurrent delivery" "SECID140"
21606 If two messages arrive at almost the same time, and both are routed to a pipe
21607 delivery, the two pipe transports may be run concurrently. You must ensure that
21608 any pipe commands you set up are robust against this happening. If the commands
21609 write to a file, the &%exim_lock%& utility might be of use.
21610
21611
21612
21613
21614 .section "Returned status and data" "SECID141"
21615 .cindex "&(pipe)& transport" "returned data"
21616 If the command exits with a non-zero return code, the delivery is deemed to
21617 have failed, unless either the &%ignore_status%& option is set (in which case
21618 the return code is treated as zero), or the return code is one of those listed
21619 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21620 later"&. In this case, delivery is deferred. Details of a permanent failure are
21621 logged, but are not included in the bounce message, which merely contains
21622 &"local delivery failed"&.
21623
21624 If the command exits on a signal and the &%freeze_signal%& option is set then
21625 the message will be frozen in the queue. If that option is not set, a bounce
21626 will be sent as normal.
21627
21628 If the return code is greater than 128 and the command being run is a shell
21629 script, it normally means that the script was terminated by a signal whose
21630 value is the return code minus 128. The &%freeze_signal%& option does not
21631 apply in this case.
21632
21633 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21634 return code is set to 127. This is the value that a shell returns if it is
21635 asked to run a non-existent command. The wording for the log line suggests that
21636 a non-existent command may be the problem.
21637
21638 The &%return_output%& option can affect the result of a pipe delivery. If it is
21639 set and the command produces any output on its standard output or standard
21640 error streams, the command is considered to have failed, even if it gave a zero
21641 return code or if &%ignore_status%& is set. The output from the command is
21642 included as part of the bounce message. The &%return_fail_output%& option is
21643 similar, except that output is returned only when the command exits with a
21644 failure return code, that is, a value other than zero or a code that matches
21645 &%temp_errors%&.
21646
21647
21648
21649 .section "How the command is run" "SECThowcommandrun"
21650 .cindex "&(pipe)& transport" "path for command"
21651 The command line is (by default) broken down into a command name and arguments
21652 by the &(pipe)& transport itself. The &%allow_commands%& and
21653 &%restrict_to_path%& options can be used to restrict the commands that may be
21654 run.
21655
21656 .cindex "quoting" "in pipe command"
21657 Unquoted arguments are delimited by white space. If an argument appears in
21658 double quotes, backslash is interpreted as an escape character in the usual
21659 way. If an argument appears in single quotes, no escaping is done.
21660
21661 String expansion is applied to the command line except when it comes from a
21662 traditional &_.forward_& file (commands from a filter file are expanded). The
21663 expansion is applied to each argument in turn rather than to the whole line.
21664 For this reason, any string expansion item that contains white space must be
21665 quoted so as to be contained within a single argument. A setting such as
21666 .code
21667 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21668 .endd
21669 will not work, because the expansion item gets split between several
21670 arguments. You have to write
21671 .code
21672 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21673 .endd
21674 to ensure that it is all in one argument. The expansion is done in this way,
21675 argument by argument, so that the number of arguments cannot be changed as a
21676 result of expansion, and quotes or backslashes in inserted variables do not
21677 interact with external quoting. However, this leads to problems if you want to
21678 generate multiple arguments (or the command name plus arguments) from a single
21679 expansion. In this situation, the simplest solution is to use a shell. For
21680 example:
21681 .code
21682 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21683 .endd
21684
21685 .cindex "transport" "filter"
21686 .cindex "filter" "transport filter"
21687 .vindex "&$pipe_addresses$&"
21688 Special handling takes place when an argument consists of precisely the text
21689 &`$pipe_addresses`&. This is not a general expansion variable; the only
21690 place this string is recognized is when it appears as an argument for a pipe or
21691 transport filter command. It causes each address that is being handled to be
21692 inserted in the argument list at that point &'as a separate argument'&. This
21693 avoids any problems with spaces or shell metacharacters, and is of use when a
21694 &(pipe)& transport is handling groups of addresses in a batch.
21695
21696 After splitting up into arguments and expansion, the resulting command is run
21697 in a subprocess directly from the transport, &'not'& under a shell. The
21698 message that is being delivered is supplied on the standard input, and the
21699 standard output and standard error are both connected to a single pipe that is
21700 read by Exim. The &%max_output%& option controls how much output the command
21701 may produce, and the &%return_output%& and &%return_fail_output%& options
21702 control what is done with it.
21703
21704 Not running the command under a shell (by default) lessens the security risks
21705 in cases when a command from a user's filter file is built out of data that was
21706 taken from an incoming message. If a shell is required, it can of course be
21707 explicitly specified as the command to be run. However, there are circumstances
21708 where existing commands (for example, in &_.forward_& files) expect to be run
21709 under a shell and cannot easily be modified. To allow for these cases, there is
21710 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21711 works. Instead of breaking up the command line as just described, it expands it
21712 as a single string and passes the result to &_/bin/sh_&. The
21713 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21714 with &%use_shell%&, and the whole mechanism is inherently less secure.
21715
21716
21717
21718 .section "Environment variables" "SECTpipeenv"
21719 .cindex "&(pipe)& transport" "environment for command"
21720 .cindex "environment for pipe transport"
21721 The environment variables listed below are set up when the command is invoked.
21722 This list is a compromise for maximum compatibility with other MTAs. Note that
21723 the &%environment%& option can be used to add additional variables to this
21724 environment.
21725 .display
21726 &`DOMAIN            `&   the domain of the address
21727 &`HOME              `&   the home directory, if set
21728 &`HOST              `&   the host name when called from a router (see below)
21729 &`LOCAL_PART        `&   see below
21730 &`LOCAL_PART_PREFIX `&   see below
21731 &`LOCAL_PART_SUFFIX `&   see below
21732 &`LOGNAME           `&   see below
21733 &`MESSAGE_ID        `&   Exim's local ID for the message
21734 &`PATH              `&   as specified by the &%path%& option below
21735 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21736 &`RECIPIENT         `&   the complete recipient address
21737 &`SENDER            `&   the sender of the message (empty if a bounce)
21738 &`SHELL             `&   &`/bin/sh`&
21739 &`TZ                `&   the value of the &%timezone%& option, if set
21740 &`USER              `&   see below
21741 .endd
21742 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21743 router, LOCAL_PART is set to the local part of the address. When it is
21744 called as a result of a forward or alias expansion, LOCAL_PART is set to
21745 the local part of the address that was expanded. In both cases, any affixes are
21746 removed from the local part, and made available in LOCAL_PART_PREFIX and
21747 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21748 same value as LOCAL_PART for compatibility with other MTAs.
21749
21750 .cindex "HOST"
21751 HOST is set only when a &(pipe)& transport is called from a router that
21752 associates hosts with an address, typically when using &(pipe)& as a
21753 pseudo-remote transport. HOST is set to the first host name specified by
21754 the router.
21755
21756 .cindex "HOME"
21757 If the transport's generic &%home_directory%& option is set, its value is used
21758 for the HOME environment variable. Otherwise, a home directory may be set
21759 by the router's &%transport_home_directory%& option, which defaults to the
21760 user's home directory if &%check_local_user%& is set.
21761
21762
21763 .section "Private options for pipe" "SECID142"
21764 .cindex "options" "&(pipe)& transport"
21765
21766
21767
21768 .option allow_commands pipe "string list&!!" unset
21769 .cindex "&(pipe)& transport" "permitted commands"
21770 The string is expanded, and is then interpreted as a colon-separated list of
21771 permitted commands. If &%restrict_to_path%& is not set, the only commands
21772 permitted are those in the &%allow_commands%& list. They need not be absolute
21773 paths; the &%path%& option is still used for relative paths. If
21774 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21775 in the &%allow_commands%& list, or a name without any slashes that is found on
21776 the path. In other words, if neither &%allow_commands%& nor
21777 &%restrict_to_path%& is set, there is no restriction on the command, but
21778 otherwise only commands that are permitted by one or the other are allowed. For
21779 example, if
21780 .code
21781 allow_commands = /usr/bin/vacation
21782 .endd
21783 and &%restrict_to_path%& is not set, the only permitted command is
21784 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21785 &%use_shell%& is set.
21786
21787
21788 .option batch_id pipe string&!! unset
21789 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21790
21791
21792 .option batch_max pipe integer 1
21793 This limits the number of addresses that can be handled in a single delivery.
21794 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21795
21796
21797 .option check_string pipe string unset
21798 As &(pipe)& writes the message, the start of each line is tested for matching
21799 &%check_string%&, and if it does, the initial matching characters are replaced
21800 by the contents of &%escape_string%&, provided both are set. The value of
21801 &%check_string%& is a literal string, not a regular expression, and the case of
21802 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21803 of &%check_string%& and &%escape_string%& are forced to values that implement
21804 the SMTP escaping protocol. Any settings made in the configuration file are
21805 ignored.
21806
21807
21808 .option command pipe string&!! unset
21809 This option need not be set when &(pipe)& is being used to deliver to pipes
21810 obtained directly from address redirections. In other cases, the option must be
21811 set, to provide a command to be run. It need not yield an absolute path (see
21812 the &%path%& option below). The command is split up into separate arguments by
21813 Exim, and each argument is separately expanded, as described in section
21814 &<<SECThowcommandrun>>& above.
21815
21816
21817 .option environment pipe string&!! unset
21818 .cindex "&(pipe)& transport" "environment for command"
21819 .cindex "environment for &(pipe)& transport"
21820 This option is used to add additional variables to the environment in which the
21821 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21822 a string which is expanded, and then interpreted as a colon-separated list of
21823 environment settings of the form <&'name'&>=<&'value'&>.
21824
21825
21826 .option escape_string pipe string unset
21827 See &%check_string%& above.
21828
21829
21830 .option freeze_exec_fail pipe boolean false
21831 .cindex "exec failure"
21832 .cindex "failure of exec"
21833 .cindex "&(pipe)& transport" "failure of exec"
21834 Failure to exec the command in a pipe transport is by default treated like
21835 any other failure while running the command. However, if &%freeze_exec_fail%&
21836 is set, failure to exec is treated specially, and causes the message to be
21837 frozen, whatever the setting of &%ignore_status%&.
21838
21839
21840 .option freeze_signal pipe boolean false
21841 .cindex "signal exit"
21842 .cindex "&(pipe)& transport", "signal exit"
21843 Normally if the process run by a command in a pipe transport exits on a signal,
21844 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21845 frozen in Exim's queue instead.
21846
21847
21848 .option ignore_status pipe boolean false
21849 If this option is true, the status returned by the subprocess that is set up to
21850 run the command is ignored, and Exim behaves as if zero had been returned.
21851 Otherwise, a non-zero status or termination by signal causes an error return
21852 from the transport unless the status value is one of those listed in
21853 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21854
21855 &*Note*&: This option does not apply to timeouts, which do not return a status.
21856 See the &%timeout_defer%& option for how timeouts are handled.
21857
21858 .option log_defer_output pipe boolean false
21859 .cindex "&(pipe)& transport" "logging output"
21860 If this option is set, and the status returned by the command is
21861 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21862 and any output was produced, the first line of it is written to the main log.
21863
21864
21865 .option log_fail_output pipe boolean false
21866 If this option is set, and the command returns any output, and also ends with a
21867 return code that is neither zero nor one of the return codes listed in
21868 &%temp_errors%& (that is, the delivery failed), the first line of output is
21869 written to the main log. This option and &%log_output%& are mutually exclusive.
21870 Only one of them may be set.
21871
21872
21873
21874 .option log_output pipe boolean false
21875 If this option is set and the command returns any output, the first line of
21876 output is written to the main log, whatever the return code. This option and
21877 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21878
21879
21880
21881 .option max_output pipe integer 20K
21882 This specifies the maximum amount of output that the command may produce on its
21883 standard output and standard error file combined. If the limit is exceeded, the
21884 process running the command is killed. This is intended as a safety measure to
21885 catch runaway processes. The limit is applied independently of the settings of
21886 the options that control what is done with such output (for example,
21887 &%return_output%&). Because of buffering effects, the amount of output may
21888 exceed the limit by a small amount before Exim notices.
21889
21890
21891 .option message_prefix pipe string&!! "see below"
21892 The string specified here is expanded and output at the start of every message.
21893 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21894 .code
21895 message_prefix = \
21896   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21897   ${tod_bsdinbox}\n
21898 .endd
21899 .cindex "Cyrus"
21900 .cindex "&%tmail%&"
21901 .cindex "&""From""& line"
21902 This is required by the commonly used &_/usr/bin/vacation_& program.
21903 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21904 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21905 setting
21906 .code
21907 message_prefix =
21908 .endd
21909 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21910 &`\n`& to &`\r\n`& in &%message_prefix%&.
21911
21912
21913 .option message_suffix pipe string&!! "see below"
21914 The string specified here is expanded and output at the end of every message.
21915 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21916 The suffix can be suppressed by setting
21917 .code
21918 message_suffix =
21919 .endd
21920 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21921 &`\n`& to &`\r\n`& in &%message_suffix%&.
21922
21923
21924 .option path pipe string "see below"
21925 This option specifies the string that is set up in the PATH environment
21926 variable of the subprocess. The default is:
21927 .code
21928 /bin:/usr/bin
21929 .endd
21930 If the &%command%& option does not yield an absolute path name, the command is
21931 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21932 apply to a command specified as a transport filter.
21933
21934
21935 .option permit_coredump pipe boolean false
21936 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21937 a core-dump of a pipe command, enable this command.  This enables core-dumps
21938 during delivery and affects both the Exim binary and the pipe command run.
21939 It is recommended that this option remain off unless and until you have a need
21940 for it and that this only be enabled when needed, as the risk of excessive
21941 resource consumption can be quite high.  Note also that Exim is typically
21942 installed as a setuid binary and most operating systems will inhibit coredumps
21943 of these by default, so further OS-specific action may be required.
21944
21945
21946 .option pipe_as_creator pipe boolean false
21947 .cindex "uid (user id)" "local delivery"
21948 If the generic &%user%& option is not set and this option is true, the delivery
21949 process is run under the uid that was in force when Exim was originally called
21950 to accept the message. If the group id is not otherwise set (via the generic
21951 &%group%& option), the gid that was in force when Exim was originally called to
21952 accept the message is used.
21953
21954
21955 .option restrict_to_path pipe boolean false
21956 When this option is set, any command name not listed in &%allow_commands%& must
21957 contain no slashes. The command is searched for only in the directories listed
21958 in the &%path%& option. This option is intended for use in the case when a pipe
21959 command has been generated from a user's &_.forward_& file. This is usually
21960 handled by a &(pipe)& transport called &%address_pipe%&.
21961
21962
21963 .option return_fail_output pipe boolean false
21964 If this option is true, and the command produced any output and ended with a
21965 return code other than zero or one of the codes listed in &%temp_errors%& (that
21966 is, the delivery failed), the output is returned in the bounce message.
21967 However, if the message has a null sender (that is, it is itself a bounce
21968 message), output from the command is discarded. This option and
21969 &%return_output%& are mutually exclusive. Only one of them may be set.
21970
21971
21972
21973 .option return_output pipe boolean false
21974 If this option is true, and the command produced any output, the delivery is
21975 deemed to have failed whatever the return code from the command, and the output
21976 is returned in the bounce message. Otherwise, the output is just discarded.
21977 However, if the message has a null sender (that is, it is a bounce message),
21978 output from the command is always discarded, whatever the setting of this
21979 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21980 of them may be set.
21981
21982
21983
21984 .option temp_errors pipe "string list" "see below"
21985 .cindex "&(pipe)& transport" "temporary failure"
21986 This option contains either a colon-separated list of numbers, or a single
21987 asterisk. If &%ignore_status%& is false
21988 and &%return_output%& is not set,
21989 and the command exits with a non-zero return code, the failure is treated as
21990 temporary and the delivery is deferred if the return code matches one of the
21991 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21992 codes are treated as permanent errors. The default setting contains the codes
21993 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21994 compiled on a system that does not define these macros, it assumes values of 75
21995 and 73, respectively.
21996
21997
21998 .option timeout pipe time 1h
21999 If the command fails to complete within this time, it is killed. This normally
22000 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22001 specifies no timeout. In order to ensure that any subprocesses created by the
22002 command are also killed, Exim makes the initial process a process group leader,
22003 and kills the whole process group on a timeout. However, this can be defeated
22004 if one of the processes starts a new process group.
22005
22006 .option timeout_defer pipe boolean false
22007 A timeout in a &(pipe)& transport, either in the command that the transport
22008 runs, or in a transport filter that is associated with it, is by default
22009 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22010 is set true, both kinds of timeout become temporary errors, causing the
22011 delivery to be deferred.
22012
22013 .option umask pipe "octal integer" 022
22014 This specifies the umask setting for the subprocess that runs the command.
22015
22016
22017 .option use_bsmtp pipe boolean false
22018 .cindex "envelope sender"
22019 If this option is set true, the &(pipe)& transport writes messages in &"batch
22020 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22021 commands. If you want to include a leading HELO command with such messages,
22022 you can do so by setting the &%message_prefix%& option. See section
22023 &<<SECTbatchSMTP>>& for details of batch SMTP.
22024
22025 .option use_classresources pipe boolean false
22026 .cindex "class resources (BSD)"
22027 This option is available only when Exim is running on FreeBSD, NetBSD, or
22028 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22029 resource limits when a &(pipe)& transport is run to perform a delivery. The
22030 limits for the uid under which the pipe is to run are obtained from the login
22031 class database.
22032
22033
22034 .option use_crlf pipe boolean false
22035 .cindex "carriage return"
22036 .cindex "linefeed"
22037 This option causes lines to be terminated with the two-character CRLF sequence
22038 (carriage return, linefeed) instead of just a linefeed character. In the case
22039 of batched SMTP, the byte sequence written to the pipe is then an exact image
22040 of what would be sent down a real SMTP connection.
22041
22042 The contents of the &%message_prefix%& and &%message_suffix%& options are
22043 written verbatim, so must contain their own carriage return characters if these
22044 are needed. When &%use_bsmtp%& is not set, the default values for both
22045 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22046 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22047
22048
22049 .option use_shell pipe boolean false
22050 .vindex "&$pipe_addresses$&"
22051 If this option is set, it causes the command to be passed to &_/bin/sh_&
22052 instead of being run directly from the transport, as described in section
22053 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22054 where the command is expected to be run under a shell and cannot easily be
22055 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22056 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22057 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22058 its &%-c%& option.
22059
22060
22061
22062 .section "Using an external local delivery agent" "SECID143"
22063 .cindex "local delivery" "using an external agent"
22064 .cindex "&'procmail'&"
22065 .cindex "external local delivery"
22066 .cindex "delivery" "&'procmail'&"
22067 .cindex "delivery" "by external agent"
22068 The &(pipe)& transport can be used to pass all messages that require local
22069 delivery to a separate local delivery agent such as &%procmail%&. When doing
22070 this, care must be taken to ensure that the pipe is run under an appropriate
22071 uid and gid. In some configurations one wants this to be a uid that is trusted
22072 by the delivery agent to supply the correct sender of the message. It may be
22073 necessary to recompile or reconfigure the delivery agent so that it trusts an
22074 appropriate user. The following is an example transport and router
22075 configuration for &%procmail%&:
22076 .code
22077 # transport
22078 procmail_pipe:
22079   driver = pipe
22080   command = /usr/local/bin/procmail -d $local_part
22081   return_path_add
22082   delivery_date_add
22083   envelope_to_add
22084   check_string = "From "
22085   escape_string = ">From "
22086   umask = 077
22087   user = $local_part
22088   group = mail
22089
22090 # router
22091 procmail:
22092   driver = accept
22093   check_local_user
22094   transport = procmail_pipe
22095 .endd
22096 In this example, the pipe is run as the local user, but with the group set to
22097 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22098 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22099 user to supply a correct sender address. If you do not specify either a
22100 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22101 home directory is the user's home directory by default.
22102
22103 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22104 .code
22105 IFS=" "
22106 .endd
22107 as shown in some &%procmail%& documentation, because Exim does not by default
22108 use a shell to run pipe commands.
22109
22110 .cindex "Cyrus"
22111 The next example shows a transport and a router for a system where local
22112 deliveries are handled by the Cyrus IMAP server.
22113 .code
22114 # transport
22115 local_delivery_cyrus:
22116   driver = pipe
22117   command = /usr/cyrus/bin/deliver \
22118             -m ${substr_1:$local_part_suffix} -- $local_part
22119   user = cyrus
22120   group = mail
22121   return_output
22122   log_output
22123   message_prefix =
22124   message_suffix =
22125
22126 # router
22127 local_user_cyrus:
22128   driver = accept
22129   check_local_user
22130   local_part_suffix = .*
22131   transport = local_delivery_cyrus
22132 .endd
22133 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22134 &%return_output%& to cause any text written by Cyrus to be returned to the
22135 sender.
22136 .ecindex IIDpiptra1
22137 .ecindex IIDpiptra2
22138
22139
22140 . ////////////////////////////////////////////////////////////////////////////
22141 . ////////////////////////////////////////////////////////////////////////////
22142
22143 .chapter "The smtp transport" "CHAPsmtptrans"
22144 .scindex IIDsmttra1 "transports" "&(smtp)&"
22145 .scindex IIDsmttra2 "&(smtp)& transport"
22146 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22147 or LMTP protocol. The list of hosts to try can either be taken from the address
22148 that is being processed (having been set up by the router), or specified
22149 explicitly for the transport. Timeout and retry processing (see chapter
22150 &<<CHAPretry>>&) is applied to each IP address independently.
22151
22152
22153 .section "Multiple messages on a single connection" "SECID144"
22154 The sending of multiple messages over a single TCP/IP connection can arise in
22155 two ways:
22156
22157 .ilist
22158 If a message contains more than &%max_rcpt%& (see below) addresses that are
22159 routed to the same host, more than one copy of the message has to be sent to
22160 that host. In this situation, multiple copies may be sent in a single run of
22161 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22162 does when it has too many addresses to send in one message also depends on the
22163 value of the global &%remote_max_parallel%& option. Details are given in
22164 section &<<SECToutSMTPTCP>>&.)
22165 .next
22166 .cindex "hints database" "remembering routing"
22167 When a message has been successfully delivered over a TCP/IP connection, Exim
22168 looks in its hints database to see if there are any other messages awaiting a
22169 connection to the same host. If there are, a new delivery process is started
22170 for one of them, and the current TCP/IP connection is passed on to it. The new
22171 process may in turn send multiple copies and possibly create yet another
22172 process.
22173 .endlist
22174
22175
22176 For each copy sent over the same TCP/IP connection, a sequence counter is
22177 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22178 no further messages are sent over that connection.
22179
22180
22181
22182 .section "Use of the $host and $host_address variables" "SECID145"
22183 .vindex "&$host$&"
22184 .vindex "&$host_address$&"
22185 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22186 &$host_address$& are the name and IP address of the first host on the host list
22187 passed by the router. However, when the transport is about to connect to a
22188 specific host, and while it is connected to that host, &$host$& and
22189 &$host_address$& are set to the values for that host. These are the values
22190 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22191 &%serialize_hosts%&, and the various TLS options are expanded.
22192
22193
22194 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22195 .vindex &$tls_bits$&
22196 .vindex &$tls_cipher$&
22197 .vindex &$tls_peerdn$&
22198 .vindex &$tls_sni$&
22199 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22200 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22201 are the values that were set when the message was received.
22202 These are the values that are used for options that are expanded before any
22203 SMTP connections are made. Just before each connection is made, these four
22204 variables are emptied. If TLS is subsequently started, they are set to the
22205 appropriate values for the outgoing connection, and these are the values that
22206 are in force when any authenticators are run and when the
22207 &%authenticated_sender%& option is expanded.
22208
22209 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22210 and will be removed in a future release.
22211
22212
22213 .section "Private options for smtp" "SECID146"
22214 .cindex "options" "&(smtp)& transport"
22215 The private options of the &(smtp)& transport are as follows:
22216
22217
22218 .option address_retry_include_sender smtp boolean true
22219 .cindex "4&'xx'& responses" "retrying after"
22220 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22221 is the combination of sender and recipient that is delayed in subsequent queue
22222 runs until the retry time is reached. You can delay the recipient without
22223 reference to the sender (which is what earlier versions of Exim did), by
22224 setting &%address_retry_include_sender%& false. However, this can lead to
22225 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22226
22227 .option allow_localhost smtp boolean false
22228 .cindex "local host" "sending to"
22229 .cindex "fallback" "hosts specified on transport"
22230 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22231 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22232 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22233 the delivery anyway. This should be used only in special cases when the
22234 configuration ensures that no looping will result (for example, a differently
22235 configured Exim is listening on the port to which the message is sent).
22236
22237
22238 .option authenticated_sender smtp string&!! unset
22239 .cindex "Cyrus"
22240 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22241 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22242 overriding any existing authenticated sender value. If the string expansion is
22243 forced to fail, the option is ignored. Other expansion failures cause delivery
22244 to be deferred. If the result of expansion is an empty string, that is also
22245 ignored.
22246
22247 The expansion happens after the outgoing connection has been made and TLS
22248 started, if required. This means that the &$host$&, &$host_address$&,
22249 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22250 particular connection.
22251
22252 If the SMTP session is not authenticated, the expansion of
22253 &%authenticated_sender%& still happens (and can cause the delivery to be
22254 deferred if it fails), but no AUTH= item is added to MAIL commands
22255 unless &%authenticated_sender_force%& is true.
22256
22257 This option allows you to use the &(smtp)& transport in LMTP mode to
22258 deliver mail to Cyrus IMAP and provide the proper local part as the
22259 &"authenticated sender"&, via a setting such as:
22260 .code
22261 authenticated_sender = $local_part
22262 .endd
22263 This removes the need for IMAP subfolders to be assigned special ACLs to
22264 allow direct delivery to those subfolders.
22265
22266 Because of expected uses such as that just described for Cyrus (when no
22267 domain is involved), there is no checking on the syntax of the provided
22268 value.
22269
22270
22271 .option authenticated_sender_force smtp boolean false
22272 If this option is set true, the &%authenticated_sender%& option's value
22273 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22274 authenticated as a client.
22275
22276
22277 .option command_timeout smtp time 5m
22278 This sets a timeout for receiving a response to an SMTP command that has been
22279 sent out. It is also used when waiting for the initial banner line from the
22280 remote host. Its value must not be zero.
22281
22282
22283 .option connect_timeout smtp time 5m
22284 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22285 to a remote host. A setting of zero allows the system timeout (typically
22286 several minutes) to act. To have any effect, the value of this option must be
22287 less than the system timeout. However, it has been observed that on some
22288 systems there is no system timeout, which is why the default value for this
22289 option is 5 minutes, a value recommended by RFC 1123.
22290
22291
22292 .option connection_max_messages smtp integer 500
22293 .cindex "SMTP" "passed connection"
22294 .cindex "SMTP" "multiple deliveries"
22295 .cindex "multiple SMTP deliveries"
22296 This controls the maximum number of separate message deliveries that are sent
22297 over a single TCP/IP connection. If the value is zero, there is no limit.
22298 For testing purposes, this value can be overridden by the &%-oB%& command line
22299 option.
22300
22301
22302 .option data_timeout smtp time 5m
22303 This sets a timeout for the transmission of each block in the data portion of
22304 the message. As a result, the overall timeout for a message depends on the size
22305 of the message. Its value must not be zero. See also &%final_timeout%&.
22306
22307
22308 .option delay_after_cutoff smtp boolean true
22309 This option controls what happens when all remote IP addresses for a given
22310 domain have been inaccessible for so long that they have passed their retry
22311 cutoff times.
22312
22313 In the default state, if the next retry time has not been reached for any of
22314 them, the address is bounced without trying any deliveries. In other words,
22315 Exim delays retrying an IP address after the final cutoff time until a new
22316 retry time is reached, and can therefore bounce an address without ever trying
22317 a delivery, when machines have been down for a long time. Some people are
22318 unhappy at this prospect, so...
22319
22320 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22321 addresses are past their final cutoff time, Exim tries to deliver to those
22322 IP addresses that have not been tried since the message arrived. If there are
22323 none, of if they all fail, the address is bounced. In other words, it does not
22324 delay when a new message arrives, but immediately tries those expired IP
22325 addresses that haven't been tried since the message arrived. If there is a
22326 continuous stream of messages for the dead hosts, unsetting
22327 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22328 to them.
22329
22330
22331 .option dns_qualify_single smtp boolean true
22332 If the &%hosts%& or &%fallback_hosts%& option is being used,
22333 and the &%gethostbyname%& option is false,
22334 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22335 in chapter &<<CHAPdnslookup>>& for more details.
22336
22337
22338 .option dns_search_parents smtp boolean false
22339 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22340 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22341 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22342 details.
22343
22344
22345 .new
22346 .option dscp smtp string&!! unset
22347 .cindex "DCSP" "outbound"
22348 This option causes the DSCP value associated with a socket to be set to one
22349 of a number of fixed strings or to numeric value.
22350 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22351 Common values include &`throughput`&, &`mincost`&, and on newer systems
22352 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22353
22354 The outbound packets from Exim will be marked with this value in the header
22355 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22356 that these values will have any effect, not be stripped by networking
22357 equipment, or do much of anything without cooperation with your Network
22358 Engineer and those of all network operators between the source and destination.
22359 .wen
22360
22361
22362 .option fallback_hosts smtp "string list" unset
22363 .cindex "fallback" "hosts specified on transport"
22364 String expansion is not applied to this option. The argument must be a
22365 colon-separated list of host names or IP addresses, optionally also including
22366 port numbers, though the separator can be changed, as described in section
22367 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22368 item in a &%route_list%& setting for the &(manualroute)& router, as described
22369 in section &<<SECTformatonehostitem>>&.
22370
22371 Fallback hosts can also be specified on routers, which associate them with the
22372 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22373 &%fallback_hosts%& specified on the transport is used only if the address does
22374 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22375 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22376 However, &%hosts_randomize%& does apply to fallback host lists.
22377
22378 If Exim is unable to deliver to any of the hosts for a particular address, and
22379 the errors are not permanent rejections, the address is put on a separate
22380 transport queue with its host list replaced by the fallback hosts, unless the
22381 address was routed via MX records and the current host was in the original MX
22382 list. In that situation, the fallback host list is not used.
22383
22384 Once normal deliveries are complete, the fallback queue is delivered by
22385 re-running the same transports with the new host lists. If several failing
22386 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22387 copy of the message is sent.
22388
22389 The resolution of the host names on the fallback list is controlled by the
22390 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22391 both to cases when the host list comes with the address and when it is taken
22392 from &%hosts%&. This option provides a &"use a smart host only if delivery
22393 fails"& facility.
22394
22395
22396 .option final_timeout smtp time 10m
22397 This is the timeout that applies while waiting for the response to the final
22398 line containing just &"."& that terminates a message. Its value must not be
22399 zero.
22400
22401 .option gethostbyname smtp boolean false
22402 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22403 being used, names are looked up using &[gethostbyname()]&
22404 (or &[getipnodebyname()]& when available)
22405 instead of using the DNS. Of course, that function may in fact use the DNS, but
22406 it may also consult other sources of information such as &_/etc/hosts_&.
22407
22408 .option gnutls_compat_mode smtp boolean unset
22409 This option controls whether GnuTLS is used in compatibility mode in an Exim
22410 server. This reduces security slightly, but improves interworking with older
22411 implementations of TLS.
22412
22413 .option helo_data smtp string&!! "see below"
22414 .cindex "HELO" "argument, setting"
22415 .cindex "EHLO" "argument, setting"
22416 .cindex "LHLO argument setting"
22417 The value of this option is expanded after a connection to a another host has
22418 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22419 command that starts the outgoing SMTP or LMTP session. The default value of the
22420 option is:
22421 .code
22422 $primary_hostname
22423 .endd
22424 During the expansion, the variables &$host$& and &$host_address$& are set to
22425 the identity of the remote host, and the variables &$sending_ip_address$& and
22426 &$sending_port$& are set to the local IP address and port number that are being
22427 used. These variables can be used to generate different values for different
22428 servers or different local IP addresses. For example, if you want the string
22429 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22430 interface address, you could use this:
22431 .code
22432 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22433   {$primary_hostname}}
22434 .endd
22435 The use of &%helo_data%& applies both to sending messages and when doing
22436 callouts.
22437
22438 .option hosts smtp "string list&!!" unset
22439 Hosts are associated with an address by a router such as &(dnslookup)&, which
22440 finds the hosts by looking up the address domain in the DNS, or by
22441 &(manualroute)&, which has lists of hosts in its configuration. However,
22442 email addresses can be passed to the &(smtp)& transport by any router, and not
22443 all of them can provide an associated list of hosts.
22444
22445 The &%hosts%& option specifies a list of hosts to be used if the address being
22446 processed does not have any hosts associated with it. The hosts specified by
22447 &%hosts%& are also used, whether or not the address has its own hosts, if
22448 &%hosts_override%& is set.
22449
22450 The string is first expanded, before being interpreted as a colon-separated
22451 list of host names or IP addresses, possibly including port numbers. The
22452 separator may be changed to something other than colon, as described in section
22453 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22454 item in a &%route_list%& setting for the &(manualroute)& router, as described
22455 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22456 of the &(manualroute)& router is not available here.
22457
22458 If the expansion fails, delivery is deferred. Unless the failure was caused by
22459 the inability to complete a lookup, the error is logged to the panic log as
22460 well as the main log. Host names are looked up either by searching directly for
22461 address records in the DNS or by calling &[gethostbyname()]& (or
22462 &[getipnodebyname()]& when available), depending on the setting of the
22463 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22464 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22465 address are used.
22466
22467 During delivery, the hosts are tried in order, subject to their retry status,
22468 unless &%hosts_randomize%& is set.
22469
22470
22471 .option hosts_avoid_esmtp smtp "host list&!!" unset
22472 .cindex "ESMTP, avoiding use of"
22473 .cindex "HELO" "forcing use of"
22474 .cindex "EHLO" "avoiding use of"
22475 .cindex "PIPELINING" "avoiding the use of"
22476 This option is for use with broken hosts that announce ESMTP facilities (for
22477 example, PIPELINING) and then fail to implement them properly. When a host
22478 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22479 start of the SMTP session. This means that it cannot use any of the ESMTP
22480 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22481
22482
22483 .option hosts_avoid_pipelining smtp "host list&!!" unset
22484 .cindex "PIPELINING" "avoiding the use of"
22485 Exim will not use the SMTP PIPELINING extension when delivering to any host
22486 that matches this list, even if the server host advertises PIPELINING support.
22487
22488
22489 .option hosts_avoid_tls smtp "host list&!!" unset
22490 .cindex "TLS" "avoiding for certain hosts"
22491 Exim will not try to start a TLS session when delivering to any host that
22492 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22493
22494 .option hosts_verify_avoid_tls smtp "host list&!!" *
22495 .cindex "TLS" "avoiding for certain hosts"
22496 Exim will not try to start a TLS session for a verify callout,
22497 or when delivering in cutthrough mode,
22498 to any host that matches this list.
22499 Note that the default is to not use TLS.
22500
22501
22502 .option hosts_max_try smtp integer 5
22503 .cindex "host" "maximum number to try"
22504 .cindex "limit" "number of hosts tried"
22505 .cindex "limit" "number of MX tried"
22506 .cindex "MX record" "maximum tried"
22507 This option limits the number of IP addresses that are tried for any one
22508 delivery in cases where there are temporary delivery errors. Section
22509 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22510
22511
22512 .option hosts_max_try_hardlimit smtp integer 50
22513 This is an additional check on the maximum number of IP addresses that Exim
22514 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22515 why it exists.
22516
22517
22518
22519 .option hosts_nopass_tls smtp "host list&!!" unset
22520 .cindex "TLS" "passing connection"
22521 .cindex "multiple SMTP deliveries"
22522 .cindex "TLS" "multiple message deliveries"
22523 For any host that matches this list, a connection on which a TLS session has
22524 been started will not be passed to a new delivery process for sending another
22525 message on the same connection. See section &<<SECTmulmessam>>& for an
22526 explanation of when this might be needed.
22527
22528
22529 .option hosts_override smtp boolean false
22530 If this option is set and the &%hosts%& option is also set, any hosts that are
22531 attached to the address are ignored, and instead the hosts specified by the
22532 &%hosts%& option are always used. This option does not apply to
22533 &%fallback_hosts%&.
22534
22535
22536 .option hosts_randomize smtp boolean false
22537 .cindex "randomized host list"
22538 .cindex "host" "list of; randomized"
22539 .cindex "fallback" "randomized hosts"
22540 If this option is set, and either the list of hosts is taken from the
22541 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22542 were not obtained from MX records (this includes fallback hosts from the
22543 router), and were not randomized by the router, the order of trying the hosts
22544 is randomized each time the transport runs. Randomizing the order of a host
22545 list can be used to do crude load sharing.
22546
22547 When &%hosts_randomize%& is true, a host list may be split into groups whose
22548 order is separately randomized. This makes it possible to set up MX-like
22549 behaviour. The boundaries between groups are indicated by an item that is just
22550 &`+`& in the host list. For example:
22551 .code
22552 hosts = host1:host2:host3:+:host4:host5
22553 .endd
22554 The order of the first three hosts and the order of the last two hosts is
22555 randomized for each use, but the first three always end up before the last two.
22556 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22557
22558 .option hosts_require_auth smtp "host list&!!" unset
22559 .cindex "authentication" "required by client"
22560 This option provides a list of servers for which authentication must succeed
22561 before Exim will try to transfer a message. If authentication fails for
22562 servers which are not in this list, Exim tries to send unauthenticated. If
22563 authentication fails for one of these servers, delivery is deferred. This
22564 temporary error is detectable in the retry rules, so it can be turned into a
22565 hard failure if required. See also &%hosts_try_auth%&, and chapter
22566 &<<CHAPSMTPAUTH>>& for details of authentication.
22567
22568
22569 .option hosts_require_tls smtp "host list&!!" unset
22570 .cindex "TLS" "requiring for certain servers"
22571 Exim will insist on using a TLS session when delivering to any host that
22572 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22573 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22574 incoming messages, use an appropriate ACL.
22575
22576 .option hosts_try_auth smtp "host list&!!" unset
22577 .cindex "authentication" "optional in client"
22578 This option provides a list of servers to which, provided they announce
22579 authentication support, Exim will attempt to authenticate as a client when it
22580 connects. If authentication fails, Exim will try to transfer the message
22581 unauthenticated. See also &%hosts_require_auth%&, and chapter
22582 &<<CHAPSMTPAUTH>>& for details of authentication.
22583
22584 .option interface smtp "string list&!!" unset
22585 .cindex "bind IP address"
22586 .cindex "IP address" "binding"
22587 .vindex "&$host$&"
22588 .vindex "&$host_address$&"
22589 This option specifies which interface to bind to when making an outgoing SMTP
22590 call. The value is an IP address, not an interface name such as
22591 &`eth0`&. Do not confuse this with the interface address that was used when a
22592 message was received, which is in &$received_ip_address$&, formerly known as
22593 &$interface_address$&. The name was changed to minimize confusion with the
22594 outgoing interface address. There is no variable that contains an outgoing
22595 interface address because, unless it is set by this option, its value is
22596 unknown.
22597
22598 During the expansion of the &%interface%& option the variables &$host$& and
22599 &$host_address$& refer to the host to which a connection is about to be made
22600 during the expansion of the string. Forced expansion failure, or an empty
22601 string result causes the option to be ignored. Otherwise, after expansion, the
22602 string must be a list of IP addresses, colon-separated by default, but the
22603 separator can be changed in the usual way. For example:
22604 .code
22605 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22606 .endd
22607 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22608 connection. If none of them are the correct type, the option is ignored. If
22609 &%interface%& is not set, or is ignored, the system's IP functions choose which
22610 interface to use if the host has more than one.
22611
22612
22613 .option keepalive smtp boolean true
22614 .cindex "keepalive" "on outgoing connection"
22615 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22616 connections. When set, it causes the kernel to probe idle connections
22617 periodically, by sending packets with &"old"& sequence numbers. The other end
22618 of the connection should send a acknowledgment if the connection is still okay
22619 or a reset if the connection has been aborted. The reason for doing this is
22620 that it has the beneficial effect of freeing up certain types of connection
22621 that can get stuck when the remote host is disconnected without tidying up the
22622 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22623 unreachable hosts.
22624
22625
22626 .option lmtp_ignore_quota smtp boolean false
22627 .cindex "LMTP" "ignoring quota errors"
22628 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22629 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22630 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22631
22632 .option max_rcpt smtp integer 100
22633 .cindex "RCPT" "maximum number of outgoing"
22634 This option limits the number of RCPT commands that are sent in a single
22635 SMTP message transaction. Each set of addresses is treated independently, and
22636 so can cause parallel connections to the same host if &%remote_max_parallel%&
22637 permits this.
22638
22639
22640 .option multi_domain smtp boolean true
22641 .vindex "&$domain$&"
22642 When this option is set, the &(smtp)& transport can handle a number of
22643 addresses containing a mixture of different domains provided they all resolve
22644 to the same list of hosts. Turning the option off restricts the transport to
22645 handling only one domain at a time. This is useful if you want to use
22646 &$domain$& in an expansion for the transport, because it is set only when there
22647 is a single domain involved in a remote delivery.
22648
22649
22650 .option port smtp string&!! "see below"
22651 .cindex "port" "sending TCP/IP"
22652 .cindex "TCP/IP" "setting outgoing port"
22653 This option specifies the TCP/IP port on the server to which Exim connects.
22654 &*Note:*& Do not confuse this with the port that was used when a message was
22655 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22656 The name was changed to minimize confusion with the outgoing port. There is no
22657 variable that contains an outgoing port.
22658
22659 If the value of this option begins with a digit it is taken as a port number;
22660 otherwise it is looked up using &[getservbyname()]&. The default value is
22661 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22662 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22663 is deferred.
22664
22665
22666
22667 .option protocol smtp string smtp
22668 .cindex "LMTP" "over TCP/IP"
22669 .cindex "ssmtp protocol" "outbound"
22670 .cindex "TLS" "SSL-on-connect outbound"
22671 .vindex "&$port$&"
22672 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22673 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22674 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22675 deliveries into closed message stores. Exim also has support for running LMTP
22676 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22677
22678 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22679 changes to &"smtps"&, and the transport initiates TLS immediately after
22680 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22681 The Internet standards bodies strongly discourage use of this mode.
22682
22683
22684 .option retry_include_ip_address smtp boolean true
22685 Exim normally includes both the host name and the IP address in the key it
22686 constructs for indexing retry data after a temporary delivery failure. This
22687 means that when one of several IP addresses for a host is failing, it gets
22688 tried periodically (controlled by the retry rules), but use of the other IP
22689 addresses is not affected.
22690
22691 However, in some dialup environments hosts are assigned a different IP address
22692 each time they connect. In this situation the use of the IP address as part of
22693 the retry key leads to undesirable behaviour. Setting this option false causes
22694 Exim to use only the host name. This should normally be done on a separate
22695 instance of the &(smtp)& transport, set up specially to handle the dialup
22696 hosts.
22697
22698
22699 .option serialize_hosts smtp "host list&!!" unset
22700 .cindex "serializing connections"
22701 .cindex "host" "serializing connections"
22702 Because Exim operates in a distributed manner, if several messages for the same
22703 host arrive at around the same time, more than one simultaneous connection to
22704 the remote host can occur. This is not usually a problem except when there is a
22705 slow link between the hosts. In that situation it may be helpful to restrict
22706 Exim to one connection at a time. This can be done by setting
22707 &%serialize_hosts%& to match the relevant hosts.
22708
22709 .cindex "hints database" "serializing deliveries to a host"
22710 Exim implements serialization by means of a hints database in which a record is
22711 written whenever a process connects to one of the restricted hosts. The record
22712 is deleted when the connection is completed. Obviously there is scope for
22713 records to get left lying around if there is a system or program crash. To
22714 guard against this, Exim ignores any records that are more than six hours old.
22715
22716 If you set up this kind of serialization, you should also arrange to delete the
22717 relevant hints database whenever your system reboots. The names of the files
22718 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22719 may be one or two files, depending on the type of DBM in use. The same files
22720 are used for ETRN serialization.
22721
22722
22723 .option size_addition smtp integer 1024
22724 .cindex "SMTP" "SIZE"
22725 .cindex "message" "size issue for transport filter"
22726 .cindex "size" "of message"
22727 .cindex "transport" "filter"
22728 .cindex "filter" "transport filter"
22729 If a remote SMTP server indicates that it supports the SIZE option of the
22730 MAIL command, Exim uses this to pass over the message size at the start of
22731 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22732 sends, to allow for headers and other text that may be added during delivery by
22733 configuration options or in a transport filter. It may be necessary to increase
22734 this if a lot of text is added to messages.
22735
22736 Alternatively, if the value of &%size_addition%& is set negative, it disables
22737 the use of the SIZE option altogether.
22738
22739
22740 .option tls_certificate smtp string&!! unset
22741 .cindex "TLS" "client certificate, location of"
22742 .cindex "certificate" "client, location of"
22743 .vindex "&$host$&"
22744 .vindex "&$host_address$&"
22745 The value of this option must be the absolute path to a file which contains the
22746 client's certificate, for possible use when sending a message over an encrypted
22747 connection. The values of &$host$& and &$host_address$& are set to the name and
22748 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22749 details of TLS.
22750
22751 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22752 certificate when sending messages as a client. The global option of the same
22753 name specifies the certificate for Exim as a server; it is not automatically
22754 assumed that the same certificate should be used when Exim is operating as a
22755 client.
22756
22757
22758 .option tls_crl smtp string&!! unset
22759 .cindex "TLS" "client certificate revocation list"
22760 .cindex "certificate" "revocation list for client"
22761 This option specifies a certificate revocation list. The expanded value must
22762 be the name of a file that contains a CRL in PEM format.
22763
22764
22765 .new
22766 .option tls_dh_min_bits smtp integer 1024
22767 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22768 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22769 key agreement is negotiated, the server will provide a large prime number
22770 for use.  This option establishes the minimum acceptable size of that number.
22771 If the parameter offered by the server is too small, then the TLS handshake
22772 will fail.
22773
22774 Only supported when using GnuTLS.
22775 .wen
22776
22777
22778 .option tls_privatekey smtp string&!! unset
22779 .cindex "TLS" "client private key, location of"
22780 .vindex "&$host$&"
22781 .vindex "&$host_address$&"
22782 The value of this option must be the absolute path to a file which contains the
22783 client's private key. This is used when sending a message over an encrypted
22784 connection using a client certificate. The values of &$host$& and
22785 &$host_address$& are set to the name and address of the server during the
22786 expansion. If this option is unset, or the expansion is forced to fail, or the
22787 result is an empty string, the private key is assumed to be in the same file as
22788 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22789
22790
22791 .option tls_require_ciphers smtp string&!! unset
22792 .cindex "TLS" "requiring specific ciphers"
22793 .cindex "cipher" "requiring specific"
22794 .vindex "&$host$&"
22795 .vindex "&$host_address$&"
22796 The value of this option must be a list of permitted cipher suites, for use
22797 when setting up an outgoing encrypted connection. (There is a global option of
22798 the same name for controlling incoming connections.) The values of &$host$& and
22799 &$host_address$& are set to the name and address of the server during the
22800 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22801 is used in different ways by OpenSSL and GnuTLS (see sections
22802 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22803 ciphers is a preference order.
22804
22805
22806
22807 .option tls_sni smtp string&!! unset
22808 .cindex "TLS" "Server Name Indication"
22809 .vindex "&$tls_sni$&"
22810 If this option is set then it sets the $tls_out_sni variable and causes any
22811 TLS session to pass this value as the Server Name Indication extension to
22812 the remote side, which can be used by the remote side to select an appropriate
22813 certificate and private key for the session.
22814
22815 See &<<SECTtlssni>>& for more information.
22816
22817 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22818 TLS extensions.
22819
22820
22821
22822
22823 .option tls_tempfail_tryclear smtp boolean true
22824 .cindex "4&'xx'& responses" "to STARTTLS"
22825 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22826 setting up a TLS session, this option determines whether or not Exim should try
22827 to deliver the message unencrypted. If it is set false, delivery to the
22828 current host is deferred; if there are other hosts, they are tried. If this
22829 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22830 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22831 TLS negotiation fails, Exim closes the current connection (because it is in an
22832 unknown state), opens a new one to the same host, and then tries the delivery
22833 in clear.
22834
22835
22836 .option tls_verify_certificates smtp string&!! unset
22837 .cindex "TLS" "server certificate verification"
22838 .cindex "certificate" "verification of server"
22839 .vindex "&$host$&"
22840 .vindex "&$host_address$&"
22841 The value of this option must be the absolute path to a file containing
22842 permitted server certificates, for use when setting up an encrypted connection.
22843 Alternatively, if you are using OpenSSL, you can set
22844 &%tls_verify_certificates%& to the name of a directory containing certificate
22845 files. This does not work with GnuTLS; the option must be set to the name of a
22846 single file if you are using GnuTLS. The values of &$host$& and
22847 &$host_address$& are set to the name and address of the server during the
22848 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22849
22850
22851
22852
22853 .section "How the limits for the number of hosts to try are used" &&&
22854          "SECTvalhosmax"
22855 .cindex "host" "maximum number to try"
22856 .cindex "limit" "hosts; maximum number tried"
22857 There are two options that are concerned with the number of hosts that are
22858 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22859 &%hosts_max_try_hardlimit%&.
22860
22861
22862 The &%hosts_max_try%& option limits the number of hosts that are tried
22863 for a single delivery. However, despite the term &"host"& in its name, the
22864 option actually applies to each IP address independently. In other words, a
22865 multihomed host is treated as several independent hosts, just as it is for
22866 retrying.
22867
22868 Many of the larger ISPs have multiple MX records which often point to
22869 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22870 created as a result of routing one of these domains.
22871
22872 Trying every single IP address on such a long list does not seem sensible; if
22873 several at the top of the list fail, it is reasonable to assume there is some
22874 problem that is likely to affect all of them. Roughly speaking, the value of
22875 &%hosts_max_try%& is the maximum number that are tried before deferring the
22876 delivery. However, the logic cannot be quite that simple.
22877
22878 Firstly, IP addresses that are skipped because their retry times have not
22879 arrived do not count, and in addition, addresses that are past their retry
22880 limits are also not counted, even when they are tried. This means that when
22881 some IP addresses are past their retry limits, more than the value of
22882 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22883 that all IP addresses are considered before timing out an email address (but
22884 see below for an exception).
22885
22886 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22887 list to see if there is a subsequent host with a different (higher valued) MX.
22888 If there is, that host is considered next, and the current IP address is used
22889 but not counted. This behaviour helps in the case of a domain with a retry rule
22890 that hardly ever delays any hosts, as is now explained:
22891
22892 Consider the case of a long list of hosts with one MX value, and a few with a
22893 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22894 hosts at the top of the list are tried at first. With the default retry rule,
22895 which specifies increasing retry times, the higher MX hosts are eventually
22896 tried when those at the top of the list are skipped because they have not
22897 reached their retry times.
22898
22899 However, it is common practice to put a fixed short retry time on domains for
22900 large ISPs, on the grounds that their servers are rarely down for very long.
22901 Unfortunately, these are exactly the domains that tend to resolve to long lists
22902 of hosts. The short retry time means that the lowest MX hosts are tried every
22903 time. The attempts may be in a different order because of random sorting, but
22904 without the special MX check, the higher MX hosts would never be tried until
22905 all the lower MX hosts had timed out (which might be several days), because
22906 there are always some lower MX hosts that have reached their retry times. With
22907 the special check, Exim considers at least one IP address from each MX value at
22908 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22909 reached.
22910
22911 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22912 particular, Exim normally eventually tries all the IP addresses before timing
22913 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22914 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22915 been set up with hundreds of IP addresses for some domains. It can
22916 take a very long time indeed for an address to time out in these cases.
22917
22918 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22919 Exim never tries more than this number of IP addresses; if it hits this limit
22920 and they are all timed out, the email address is bounced, even though not all
22921 possible IP addresses have been tried.
22922 .ecindex IIDsmttra1
22923 .ecindex IIDsmttra2
22924
22925
22926
22927
22928
22929 . ////////////////////////////////////////////////////////////////////////////
22930 . ////////////////////////////////////////////////////////////////////////////
22931
22932 .chapter "Address rewriting" "CHAPrewrite"
22933 .scindex IIDaddrew "rewriting" "addresses"
22934 There are some circumstances in which Exim automatically rewrites domains in
22935 addresses. The two most common are when an address is given without a domain
22936 (referred to as an &"unqualified address"&) or when an address contains an
22937 abbreviated domain that is expanded by DNS lookup.
22938
22939 Unqualified envelope addresses are accepted only for locally submitted
22940 messages, or for messages that are received from hosts matching
22941 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22942 appropriate. Unqualified addresses in header lines are qualified if they are in
22943 locally submitted messages, or messages from hosts that are permitted to send
22944 unqualified envelope addresses. Otherwise, unqualified addresses in header
22945 lines are neither qualified nor rewritten.
22946
22947 One situation in which Exim does &'not'& automatically rewrite a domain is
22948 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22949 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22950 do this. The new RFCs do not contain this suggestion.
22951
22952
22953 .section "Explicitly configured address rewriting" "SECID147"
22954 This chapter describes the rewriting rules that can be used in the
22955 main rewrite section of the configuration file, and also in the generic
22956 &%headers_rewrite%& option that can be set on any transport.
22957
22958 Some people believe that configured address rewriting is a Mortal Sin.
22959 Others believe that life is not possible without it. Exim provides the
22960 facility; you do not have to use it.
22961
22962 The main rewriting rules that appear in the &"rewrite"& section of the
22963 configuration file are applied to addresses in incoming messages, both envelope
22964 addresses and addresses in header lines. Each rule specifies the types of
22965 address to which it applies.
22966
22967 Whether or not addresses in header lines are rewritten depends on the origin of
22968 the headers and the type of rewriting. Global rewriting, that is, rewriting
22969 rules from the rewrite section of the configuration file, is applied only to
22970 those headers that were received with the message. Header lines that are added
22971 by ACLs or by a system filter or by individual routers or transports (which
22972 are specific to individual recipient addresses) are not rewritten by the global
22973 rules.
22974
22975 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22976 applies all headers except those added by routers and transports. That is, as
22977 well as the headers that were received with the message, it also applies to
22978 headers that were added by an ACL or a system filter.
22979
22980
22981 In general, rewriting addresses from your own system or domain has some
22982 legitimacy. Rewriting other addresses should be done only with great care and
22983 in special circumstances. The author of Exim believes that rewriting should be
22984 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22985 Although it can sometimes be used as a routing tool, this is very strongly
22986 discouraged.
22987
22988 There are two commonly encountered circumstances where rewriting is used, as
22989 illustrated by these examples:
22990
22991 .ilist
22992 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22993 exchange mail with each other behind a firewall, but there is only a single
22994 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22995 &'hitch.fict.example'& when sending mail off-site.
22996 .next
22997 A host rewrites the local parts of its own users so that, for example,
22998 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22999 .endlist
23000
23001
23002
23003 .section "When does rewriting happen?" "SECID148"
23004 .cindex "rewriting" "timing of"
23005 .cindex "&ACL;" "rewriting addresses in"
23006 Configured address rewriting can take place at several different stages of a
23007 message's processing.
23008
23009 .vindex "&$sender_address$&"
23010 At the start of an ACL for MAIL, the sender address may have been rewritten
23011 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23012 ordinary rewrite rules have yet been applied. If, however, the sender address
23013 is verified in the ACL, it is rewritten before verification, and remains
23014 rewritten thereafter. The subsequent value of &$sender_address$& is the
23015 rewritten address. This also applies if sender verification happens in a
23016 RCPT ACL. Otherwise, when the sender address is not verified, it is
23017 rewritten as soon as a message's header lines have been received.
23018
23019 .vindex "&$domain$&"
23020 .vindex "&$local_part$&"
23021 Similarly, at the start of an ACL for RCPT, the current recipient's address
23022 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23023 rewrite rules have yet been applied to it. However, the behaviour is different
23024 from the sender address when a recipient is verified. The address is rewritten
23025 for the verification, but the rewriting is not remembered at this stage. The
23026 value of &$local_part$& and &$domain$& after verification are always the same
23027 as they were before (that is, they contain the unrewritten &-- except for
23028 SMTP-time rewriting &-- address).
23029
23030 As soon as a message's header lines have been received, all the envelope
23031 recipient addresses are permanently rewritten, and rewriting is also applied to
23032 the addresses in the header lines (if configured). This happens before adding
23033 any header lines that were specified in MAIL or RCPT ACLs, and
23034 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23035 before the DATA ACL and &[local_scan()]& functions are run.
23036
23037 When an address is being routed, either for delivery or for verification,
23038 rewriting is applied immediately to child addresses that are generated by
23039 redirection, unless &%no_rewrite%& is set on the router.
23040
23041 .cindex "envelope sender" "rewriting at transport time"
23042 .cindex "rewriting" "at transport time"
23043 .cindex "header lines" "rewriting at transport time"
23044 At transport time, additional rewriting of addresses in header lines can be
23045 specified by setting the generic &%headers_rewrite%& option on a transport.
23046 This option contains rules that are identical in form to those in the rewrite
23047 section of the configuration file. They are applied to the original message
23048 header lines and any that were added by ACLs or a system filter. They are not
23049 applied to header lines that are added by routers or the transport.
23050
23051 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23052 transport option. However, it is not possible to rewrite envelope recipients at
23053 transport time.
23054
23055
23056
23057
23058 .section "Testing the rewriting rules that apply on input" "SECID149"
23059 .cindex "rewriting" "testing"
23060 .cindex "testing" "rewriting"
23061 Exim's input rewriting configuration appears in a part of the run time
23062 configuration file headed by &"begin rewrite"&. It can be tested by the
23063 &%-brw%& command line option. This takes an address (which can be a full RFC
23064 2822 address) as its argument. The output is a list of how the address would be
23065 transformed by the rewriting rules for each of the different places it might
23066 appear in an incoming message, that is, for each different header and for the
23067 envelope sender and recipient fields. For example,
23068 .code
23069 exim -brw ph10@exim.workshop.example
23070 .endd
23071 might produce the output
23072 .code
23073 sender: Philip.Hazel@exim.workshop.example
23074 from: Philip.Hazel@exim.workshop.example
23075 to: ph10@exim.workshop.example
23076 cc: ph10@exim.workshop.example
23077 bcc: ph10@exim.workshop.example
23078 reply-to: Philip.Hazel@exim.workshop.example
23079 env-from: Philip.Hazel@exim.workshop.example
23080 env-to: ph10@exim.workshop.example
23081 .endd
23082 which shows that rewriting has been set up for that address when used in any of
23083 the source fields, but not when it appears as a recipient address. At the
23084 present time, there is no equivalent way of testing rewriting rules that are
23085 set for a particular transport.
23086
23087
23088 .section "Rewriting rules" "SECID150"
23089 .cindex "rewriting" "rules"
23090 The rewrite section of the configuration file consists of lines of rewriting
23091 rules in the form
23092 .display
23093 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23094 .endd
23095 Rewriting rules that are specified for the &%headers_rewrite%& generic
23096 transport option are given as a colon-separated list. Each item in the list
23097 takes the same form as a line in the main rewriting configuration (except that
23098 any colons must be doubled, of course).
23099
23100 The formats of source patterns and replacement strings are described below.
23101 Each is terminated by white space, unless enclosed in double quotes, in which
23102 case normal quoting conventions apply inside the quotes. The flags are single
23103 characters which may appear in any order. Spaces and tabs between them are
23104 ignored.
23105
23106 For each address that could potentially be rewritten, the rules are scanned in
23107 order, and replacements for the address from earlier rules can themselves be
23108 replaced by later rules (but see the &"q"& and &"R"& flags).
23109
23110 The order in which addresses are rewritten is undefined, may change between
23111 releases, and must not be relied on, with one exception: when a message is
23112 received, the envelope sender is always rewritten first, before any header
23113 lines are rewritten. For example, the replacement string for a rewrite of an
23114 address in &'To:'& must not assume that the message's address in &'From:'& has
23115 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23116 that the envelope sender has already been rewritten.
23117
23118 .vindex "&$domain$&"
23119 .vindex "&$local_part$&"
23120 The variables &$local_part$& and &$domain$& can be used in the replacement
23121 string to refer to the address that is being rewritten. Note that lookup-driven
23122 rewriting can be done by a rule of the form
23123 .code
23124 *@*   ${lookup ...
23125 .endd
23126 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23127 refer to the address that is being rewritten.
23128
23129
23130 .section "Rewriting patterns" "SECID151"
23131 .cindex "rewriting" "patterns"
23132 .cindex "address list" "in a rewriting pattern"
23133 The source pattern in a rewriting rule is any item which may appear in an
23134 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23135 single-item address list, which means that it is expanded before being tested
23136 against the address. As always, if you use a regular expression as a pattern,
23137 you must take care to escape dollar and backslash characters, or use the &`\N`&
23138 facility to suppress string expansion within the regular expression.
23139
23140 Domains in patterns should be given in lower case. Local parts in patterns are
23141 case-sensitive. If you want to do case-insensitive matching of local parts, you
23142 can use a regular expression that starts with &`^(?i)`&.
23143
23144 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23145 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23146 depending on the type of match which occurred. These can be used in the
23147 replacement string to insert portions of the incoming address. &$0$& always
23148 refers to the complete incoming address. When a regular expression is used, the
23149 numerical variables are set from its capturing subexpressions. For other types
23150 of pattern they are set as follows:
23151
23152 .ilist
23153 If a local part or domain starts with an asterisk, the numerical variables
23154 refer to the character strings matched by asterisks, with &$1$& associated with
23155 the first asterisk, and &$2$& with the second, if present. For example, if the
23156 pattern
23157 .code
23158 *queen@*.fict.example
23159 .endd
23160 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23161 .code
23162 $0 = hearts-queen@wonderland.fict.example
23163 $1 = hearts-
23164 $2 = wonderland
23165 .endd
23166 Note that if the local part does not start with an asterisk, but the domain
23167 does, it is &$1$& that contains the wild part of the domain.
23168
23169 .next
23170 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23171 of the domain are placed in the next available numerical variables. Suppose,
23172 for example, that the address &'foo@bar.baz.example'& is processed by a
23173 rewriting rule of the form
23174 .display
23175 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23176 .endd
23177 and the key in the file that matches the domain is &`*.baz.example`&. Then
23178 .code
23179 $1 = foo
23180 $2 = bar
23181 $3 = baz.example
23182 .endd
23183 If the address &'foo@baz.example'& is looked up, this matches the same
23184 wildcard file entry, and in this case &$2$& is set to the empty string, but
23185 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23186 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23187 whole domain. For non-partial domain lookups, no numerical variables are set.
23188 .endlist
23189
23190
23191 .section "Rewriting replacements" "SECID152"
23192 .cindex "rewriting" "replacements"
23193 If the replacement string for a rule is a single asterisk, addresses that
23194 match the pattern and the flags are &'not'& rewritten, and no subsequent
23195 rewriting rules are scanned. For example,
23196 .code
23197 hatta@lookingglass.fict.example  *  f
23198 .endd
23199 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23200 &'From:'& headers.
23201
23202 .vindex "&$domain$&"
23203 .vindex "&$local_part$&"
23204 If the replacement string is not a single asterisk, it is expanded, and must
23205 yield a fully qualified address. Within the expansion, the variables
23206 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23207 Any letters they contain retain their original case &-- they are not lower
23208 cased. The numerical variables are set up according to the type of pattern that
23209 matched the address, as described above. If the expansion is forced to fail by
23210 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23211 current rule is abandoned, but subsequent rules may take effect. Any other
23212 expansion failure causes the entire rewriting operation to be abandoned, and an
23213 entry written to the panic log.
23214
23215
23216
23217 .section "Rewriting flags" "SECID153"
23218 There are three different kinds of flag that may appear on rewriting rules:
23219
23220 .ilist
23221 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23222 c, f, h, r, s, t.
23223 .next
23224 A flag that specifies rewriting at SMTP time: S.
23225 .next
23226 Flags that control the rewriting process: Q, q, R, w.
23227 .endlist
23228
23229 For rules that are part of the &%headers_rewrite%& generic transport option,
23230 E, F, T, and S are not permitted.
23231
23232
23233
23234 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23235          "SECID154"
23236 .cindex "rewriting" "flags"
23237 If none of the following flag letters, nor the &"S"& flag (see section
23238 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23239 and to both the sender and recipient fields of the envelope, whereas a
23240 transport-time rewriting rule just applies to all headers. Otherwise, the
23241 rewriting rule is skipped unless the relevant addresses are being processed.
23242 .display
23243 &`E`&       rewrite all envelope fields
23244 &`F`&       rewrite the envelope From field
23245 &`T`&       rewrite the envelope To field
23246 &`b`&       rewrite the &'Bcc:'& header
23247 &`c`&       rewrite the &'Cc:'& header
23248 &`f`&       rewrite the &'From:'& header
23249 &`h`&       rewrite all headers
23250 &`r`&       rewrite the &'Reply-To:'& header
23251 &`s`&       rewrite the &'Sender:'& header
23252 &`t`&       rewrite the &'To:'& header
23253 .endd
23254 "All headers" means all of the headers listed above that can be selected
23255 individually, plus their &'Resent-'& versions. It does not include
23256 other headers such as &'Subject:'& etc.
23257
23258 You should be particularly careful about rewriting &'Sender:'& headers, and
23259 restrict this to special known cases in your own domains.
23260
23261
23262 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23263 .cindex "SMTP" "rewriting malformed addresses"
23264 .cindex "RCPT" "rewriting argument of"
23265 .cindex "MAIL" "rewriting argument of"
23266 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23267 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23268 before any other processing; even before syntax checking. The pattern is
23269 required to be a regular expression, and it is matched against the whole of the
23270 data for the command, including any surrounding angle brackets.
23271
23272 .vindex "&$domain$&"
23273 .vindex "&$local_part$&"
23274 This form of rewrite rule allows for the handling of addresses that are not
23275 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23276 input). Because the input is not required to be a syntactically valid address,
23277 the variables &$local_part$& and &$domain$& are not available during the
23278 expansion of the replacement string. The result of rewriting replaces the
23279 original address in the MAIL or RCPT command.
23280
23281
23282 .section "Flags controlling the rewriting process" "SECID155"
23283 There are four flags which control the way the rewriting process works. These
23284 take effect only when a rule is invoked, that is, when the address is of the
23285 correct type (matches the flags) and matches the pattern:
23286
23287 .ilist
23288 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23289 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23290 absence of &"Q"& the rewritten address must always include a domain.
23291 .next
23292 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23293 even if no rewriting actually takes place because of a &"fail"& in the
23294 expansion. The &"q"& flag is not effective if the address is of the wrong type
23295 (does not match the flags) or does not match the pattern.
23296 .next
23297 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23298 address, up to ten times. It can be combined with the &"q"& flag, to stop
23299 rewriting once it fails to match (after at least one successful rewrite).
23300 .next
23301 .cindex "rewriting" "whole addresses"
23302 When an address in a header is rewritten, the rewriting normally applies only
23303 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23304 left unchanged. For example, rewriting might change
23305 .code
23306 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23307 .endd
23308 into
23309 .code
23310 From: Ford Prefect <prefectf@hitch.fict.example>
23311 .endd
23312 .cindex "RFC 2047"
23313 Sometimes there is a need to replace the whole address item, and this can be
23314 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23315 causes an address in a header line to be rewritten, the entire address is
23316 replaced, not just the working part. The replacement must be a complete RFC
23317 2822 address, including the angle brackets if necessary. If text outside angle
23318 brackets contains a character whose value is greater than 126 or less than 32
23319 (except for tab), the text is encoded according to RFC 2047. The character set
23320 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23321
23322 When the &"w"& flag is set on a rule that causes an envelope address to be
23323 rewritten, all but the working part of the replacement address is discarded.
23324 .endlist
23325
23326
23327 .section "Rewriting examples" "SECID156"
23328 Here is an example of the two common rewriting paradigms:
23329 .code
23330 *@*.hitch.fict.example  $1@hitch.fict.example
23331 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23332                      {$value}fail}@hitch.fict.example bctfrF
23333 .endd
23334 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23335 the string expansion to fail if the lookup does not succeed. In this context it
23336 has the effect of leaving the original address unchanged, but Exim goes on to
23337 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23338 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23339 explicitly, which would cause the rewritten address to be the same as before,
23340 at the cost of a small bit of processing. Not supplying either of these is an
23341 error, since the rewritten address would then contain no local part.
23342
23343 The first example above replaces the domain with a superior, more general
23344 domain. This may not be desirable for certain local parts. If the rule
23345 .code
23346 root@*.hitch.fict.example  *
23347 .endd
23348 were inserted before the first rule, rewriting would be suppressed for the
23349 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23350
23351 Rewriting can be made conditional on a number of tests, by making use of
23352 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23353 messages that originate outside the local host:
23354 .code
23355 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23356                          {$1@hitch.fict.example}fail}"
23357 .endd
23358 The replacement string is quoted in this example because it contains white
23359 space.
23360
23361 .cindex "rewriting" "bang paths"
23362 .cindex "bang paths" "rewriting"
23363 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23364 an address it treats it as an unqualified local part which it qualifies with
23365 the local qualification domain (if the source of the message is local or if the
23366 remote host is permitted to send unqualified addresses). Rewriting can
23367 sometimes be used to handle simple bang paths with a fixed number of
23368 components. For example, the rule
23369 .code
23370 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23371 .endd
23372 rewrites a two-component bang path &'host.name!user'& as the domain address
23373 &'user@host.name'&. However, there is a security implication in using this as
23374 a global rewriting rule for envelope addresses. It can provide a backdoor
23375 method for using your system as a relay, because the incoming addresses appear
23376 to be local. If the bang path addresses are received via SMTP, it is safer to
23377 use the &"S"& flag to rewrite them as they are received, so that relay checking
23378 can be done on the rewritten addresses.
23379 .ecindex IIDaddrew
23380
23381
23382
23383
23384
23385 . ////////////////////////////////////////////////////////////////////////////
23386 . ////////////////////////////////////////////////////////////////////////////
23387
23388 .chapter "Retry configuration" "CHAPretry"
23389 .scindex IIDretconf1 "retry" "configuration, description of"
23390 .scindex IIDregconf2 "configuration file" "retry section"
23391 The &"retry"& section of the runtime configuration file contains a list of
23392 retry rules that control how often Exim tries to deliver messages that cannot
23393 be delivered at the first attempt. If there are no retry rules (the section is
23394 empty or not present), there are no retries. In this situation, temporary
23395 errors are treated as permanent. The default configuration contains a single,
23396 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23397 line option can be used to test which retry rule will be used for a given
23398 address, domain and error.
23399
23400 The most common cause of retries is temporary failure to deliver to a remote
23401 host because the host is down, or inaccessible because of a network problem.
23402 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23403 address) basis, not on a per-message basis. Thus, if one message has recently
23404 been delayed, delivery of a new message to the same host is not immediately
23405 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23406 log selector is set, the message
23407 .cindex "retry" "time not reached"
23408 &"retry time not reached"& is written to the main log whenever a delivery is
23409 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23410 the handling of errors during remote deliveries.
23411
23412 Retry processing applies to routing as well as to delivering, except as covered
23413 in the next paragraph. The retry rules do not distinguish between these
23414 actions. It is not possible, for example, to specify different behaviour for
23415 failures to route the domain &'snark.fict.example'& and failures to deliver to
23416 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23417 added complication, so did not implement it. However, although they share the
23418 same retry rule, the actual retry times for routing and transporting a given
23419 domain are maintained independently.
23420
23421 When a delivery is not part of a queue run (typically an immediate delivery on
23422 receipt of a message), the routers are always run, and local deliveries are
23423 always attempted, even if retry times are set for them. This makes for better
23424 behaviour if one particular message is causing problems (for example, causing
23425 quota overflow, or provoking an error in a filter file). If such a delivery
23426 suffers a temporary failure, the retry data is updated as normal, and
23427 subsequent delivery attempts from queue runs occur only when the retry time for
23428 the local address is reached.
23429
23430 .section "Changing retry rules" "SECID157"
23431 If you change the retry rules in your configuration, you should consider
23432 whether or not to delete the retry data that is stored in Exim's spool area in
23433 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23434 always safe; that is why they are called &"hints"&.
23435
23436 The hints retry data contains suggested retry times based on the previous
23437 rules. In the case of a long-running problem with a remote host, it might
23438 record the fact that the host has timed out. If your new rules increase the
23439 timeout time for such a host, you should definitely remove the old retry data
23440 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23441 messages that it should now be retaining.
23442
23443
23444
23445 .section "Format of retry rules" "SECID158"
23446 .cindex "retry" "rules"
23447 Each retry rule occupies one line and consists of three or four parts,
23448 separated by white space: a pattern, an error name, an optional list of sender
23449 addresses, and a list of retry parameters. The pattern and sender lists must be
23450 enclosed in double quotes if they contain white space. The rules are searched
23451 in order until one is found where the pattern, error name, and sender list (if
23452 present) match the failing host or address, the error that occurred, and the
23453 message's sender, respectively.
23454
23455
23456 The pattern is any single item that may appear in an address list (see section
23457 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23458 which means that it is expanded before being tested against the address that
23459 has been delayed. A negated address list item is permitted. Address
23460 list processing treats a plain domain name as if it were preceded by &"*@"&,
23461 which makes it possible for many retry rules to start with just a domain. For
23462 example,
23463 .code
23464 lookingglass.fict.example        *  F,24h,30m;
23465 .endd
23466 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23467 whereas
23468 .code
23469 alice@lookingglass.fict.example  *  F,24h,30m;
23470 .endd
23471 applies only to temporary failures involving the local part &%alice%&.
23472 In practice, almost all rules start with a domain name pattern without a local
23473 part.
23474
23475 .cindex "regular expressions" "in retry rules"
23476 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23477 must match a complete address, not just a domain, because that is how regular
23478 expressions work in address lists.
23479 .display
23480 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23481 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23482 .endd
23483
23484
23485 .section "Choosing which retry rule to use for address errors" "SECID159"
23486 When Exim is looking for a retry rule after a routing attempt has failed (for
23487 example, after a DNS timeout), each line in the retry configuration is tested
23488 against the complete address only if &%retry_use_local_part%& is set for the
23489 router. Otherwise, only the domain is used, except when matching against a
23490 regular expression, when the local part of the address is replaced with &"*"&.
23491 A domain on its own can match a domain pattern, or a pattern that starts with
23492 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23493 &%check_local_user%& is true, and false for other routers.
23494
23495 Similarly, when Exim is looking for a retry rule after a local delivery has
23496 failed (for example, after a mailbox full error), each line in the retry
23497 configuration is tested against the complete address only if
23498 &%retry_use_local_part%& is set for the transport (it defaults true for all
23499 local transports).
23500
23501 .cindex "4&'xx'& responses" "retry rules for"
23502 However, when Exim is looking for a retry rule after a remote delivery attempt
23503 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23504 whole address is always used as the key when searching the retry rules. The
23505 rule that is found is used to create a retry time for the combination of the
23506 failing address and the message's sender. It is the combination of sender and
23507 recipient that is delayed in subsequent queue runs until its retry time is
23508 reached. You can delay the recipient without regard to the sender by setting
23509 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23510 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23511 commands.
23512
23513
23514
23515 .section "Choosing which retry rule to use for host and message errors" &&&
23516          "SECID160"
23517 For a temporary error that is not related to an individual address (for
23518 example, a connection timeout), each line in the retry configuration is checked
23519 twice. First, the name of the remote host is used as a domain name (preceded by
23520 &"*@"& when matching a regular expression). If this does not match the line,
23521 the domain from the email address is tried in a similar fashion. For example,
23522 suppose the MX records for &'a.b.c.example'& are
23523 .code
23524 a.b.c.example  MX  5  x.y.z.example
23525                MX  6  p.q.r.example
23526                MX  7  m.n.o.example
23527 .endd
23528 and the retry rules are
23529 .code
23530 p.q.r.example    *      F,24h,30m;
23531 a.b.c.example    *      F,4d,45m;
23532 .endd
23533 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23534 first rule matches neither the host nor the domain, so Exim looks at the second
23535 rule. This does not match the host, but it does match the domain, so it is used
23536 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23537 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23538 first retry rule is used, because it matches the host.
23539
23540 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23541 first rule to determine retry times, but for all the other hosts for the domain
23542 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23543 routing to &'a.b.c.example'& suffers a temporary failure.
23544
23545 &*Note*&: The host name is used when matching the patterns, not its IP address.
23546 However, if a message is routed directly to an IP address without the use of a
23547 host name, for example, if a &(manualroute)& router contains a setting such as:
23548 .code
23549 route_list = *.a.example  192.168.34.23
23550 .endd
23551 then the &"host name"& that is used when searching for a retry rule is the
23552 textual form of the IP address.
23553
23554 .section "Retry rules for specific errors" "SECID161"
23555 .cindex "retry" "specific errors; specifying"
23556 The second field in a retry rule is the name of a particular error, or an
23557 asterisk, which matches any error. The errors that can be tested for are:
23558
23559 .vlist
23560 .vitem &%auth_failed%&
23561 Authentication failed when trying to send to a host in the
23562 &%hosts_require_auth%& list in an &(smtp)& transport.
23563
23564 .vitem &%data_4xx%&
23565 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23566 after the command, or after sending the message's data.
23567
23568 .vitem &%mail_4xx%&
23569 A 4&'xx'& error was received for an outgoing MAIL command.
23570
23571 .vitem &%rcpt_4xx%&
23572 A 4&'xx'& error was received for an outgoing RCPT command.
23573 .endlist
23574
23575 For the three 4&'xx'& errors, either the first or both of the x's can be given
23576 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23577 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23578 and have retries every ten minutes with a one-hour timeout, you could set up a
23579 retry rule of this form:
23580 .code
23581 the.domain.name  rcpt_452   F,1h,10m
23582 .endd
23583 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23584 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23585
23586 .vlist
23587 .vitem &%lost_connection%&
23588 A server unexpectedly closed the SMTP connection. There may, of course,
23589 legitimate reasons for this (host died, network died), but if it repeats a lot
23590 for the same host, it indicates something odd.
23591
23592 .vitem &%refused_MX%&
23593 A connection to a host obtained from an MX record was refused.
23594
23595 .vitem &%refused_A%&
23596 A connection to a host not obtained from an MX record was refused.
23597
23598 .vitem &%refused%&
23599 A connection was refused.
23600
23601 .vitem &%timeout_connect_MX%&
23602 A connection attempt to a host obtained from an MX record timed out.
23603
23604 .vitem &%timeout_connect_A%&
23605 A connection attempt to a host not obtained from an MX record timed out.
23606
23607 .vitem &%timeout_connect%&
23608 A connection attempt timed out.
23609
23610 .vitem &%timeout_MX%&
23611 There was a timeout while connecting or during an SMTP session with a host
23612 obtained from an MX record.
23613
23614 .vitem &%timeout_A%&
23615 There was a timeout while connecting or during an SMTP session with a host not
23616 obtained from an MX record.
23617
23618 .vitem &%timeout%&
23619 There was a timeout while connecting or during an SMTP session.
23620
23621 .vitem &%tls_required%&
23622 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23623 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23624 to STARTTLS, or there was a problem setting up the TLS connection.
23625
23626 .vitem &%quota%&
23627 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23628 transport.
23629
23630 .vitem &%quota_%&<&'time'&>
23631 .cindex "quota" "error testing in retry rule"
23632 .cindex "retry" "quota error testing"
23633 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23634 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23635 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23636 for four days.
23637 .endlist
23638
23639 .cindex "mailbox" "time of last read"
23640 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23641 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23642 it should be based on the last time that the user accessed the mailbox.
23643 However, it is not always possible to determine this. Exim uses the following
23644 heuristic rules:
23645
23646 .ilist
23647 If the mailbox is a single file, the time of last access (the &"atime"&) is
23648 used. As no new messages are being delivered (because the mailbox is over
23649 quota), Exim does not access the file, so this is the time of last user access.
23650 .next
23651 .cindex "maildir format" "time of last read"
23652 For a maildir delivery, the time of last modification of the &_new_&
23653 subdirectory is used. As the mailbox is over quota, no new files are created in
23654 the &_new_& subdirectory, because no new messages are being delivered. Any
23655 change to the &_new_& subdirectory is therefore assumed to be the result of an
23656 MUA moving a new message to the &_cur_& directory when it is first read. The
23657 time that is used is therefore the last time that the user read a new message.
23658 .next
23659 For other kinds of multi-file mailbox, the time of last access cannot be
23660 obtained, so a retry rule that uses this type of error field is never matched.
23661 .endlist
23662
23663 The quota errors apply both to system-enforced quotas and to Exim's own quota
23664 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23665 when a local delivery is deferred because a partition is full (the ENOSPC
23666 error).
23667
23668
23669
23670 .section "Retry rules for specified senders" "SECID162"
23671 .cindex "retry" "rules; sender-specific"
23672 You can specify retry rules that apply only when the failing message has a
23673 specific sender. In particular, this can be used to define retry rules that
23674 apply only to bounce messages. The third item in a retry rule can be of this
23675 form:
23676 .display
23677 &`senders=`&<&'address list'&>
23678 .endd
23679 The retry timings themselves are then the fourth item. For example:
23680 .code
23681 *   rcpt_4xx   senders=:   F,1h,30m
23682 .endd
23683 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23684 host. If the address list contains white space, it must be enclosed in quotes.
23685 For example:
23686 .code
23687 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23688 .endd
23689 &*Warning*&: This facility can be unhelpful if it is used for host errors
23690 (which do not depend on the recipient). The reason is that the sender is used
23691 only to match the retry rule. Once the rule has been found for a host error,
23692 its contents are used to set a retry time for the host, and this will apply to
23693 all messages, not just those with specific senders.
23694
23695 When testing retry rules using &%-brt%&, you can supply a sender using the
23696 &%-f%& command line option, like this:
23697 .code
23698 exim -f "" -brt user@dom.ain
23699 .endd
23700 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23701 list is never matched.
23702
23703
23704
23705
23706
23707 .section "Retry parameters" "SECID163"
23708 .cindex "retry" "parameters in rules"
23709 The third (or fourth, if a senders list is present) field in a retry rule is a
23710 sequence of retry parameter sets, separated by semicolons. Each set consists of
23711 .display
23712 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23713 .endd
23714 The letter identifies the algorithm for computing a new retry time; the cutoff
23715 time is the time beyond which this algorithm no longer applies, and the
23716 arguments vary the algorithm's action. The cutoff time is measured from the
23717 time that the first failure for the domain (combined with the local part if
23718 relevant) was detected, not from the time the message was received.
23719
23720 .cindex "retry" "algorithms"
23721 .cindex "retry" "fixed intervals"
23722 .cindex "retry" "increasing intervals"
23723 .cindex "retry" "random intervals"
23724 The available algorithms are:
23725
23726 .ilist
23727 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23728 the interval.
23729 .next
23730 &'G'&: retry at geometrically increasing intervals. The first argument
23731 specifies a starting value for the interval, and the second a multiplier, which
23732 is used to increase the size of the interval at each retry.
23733 .next
23734 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23735 retry, the previous interval is multiplied by the factor in order to get a
23736 maximum for the next interval. The minimum interval is the first argument of
23737 the parameter, and an actual interval is chosen randomly between them. Such a
23738 rule has been found to be helpful in cluster configurations when all the
23739 members of the cluster restart at once, and may therefore synchronize their
23740 queue processing times.
23741 .endlist
23742
23743 When computing the next retry time, the algorithm definitions are scanned in
23744 order until one whose cutoff time has not yet passed is reached. This is then
23745 used to compute a new retry time that is later than the current time. In the
23746 case of fixed interval retries, this simply means adding the interval to the
23747 current time. For geometrically increasing intervals, retry intervals are
23748 computed from the rule's parameters until one that is greater than the previous
23749 interval is found. The main configuration variable
23750 .cindex "limit" "retry interval"
23751 .cindex "retry" "interval, maximum"
23752 .oindex "&%retry_interval_max%&"
23753 &%retry_interval_max%& limits the maximum interval between retries. It
23754 cannot be set greater than &`24h`&, which is its default value.
23755
23756 A single remote domain may have a number of hosts associated with it, and each
23757 host may have more than one IP address. Retry algorithms are selected on the
23758 basis of the domain name, but are applied to each IP address independently. If,
23759 for example, a host has two IP addresses and one is unusable, Exim will
23760 generate retry times for it and will not try to use it until its next retry
23761 time comes. Thus the good IP address is likely to be tried first most of the
23762 time.
23763
23764 .cindex "hints database" "use for retrying"
23765 Retry times are hints rather than promises. Exim does not make any attempt to
23766 run deliveries exactly at the computed times. Instead, a queue runner process
23767 starts delivery processes for delayed messages periodically, and these attempt
23768 new deliveries only for those addresses that have passed their next retry time.
23769 If a new message arrives for a deferred address, an immediate delivery attempt
23770 occurs only if the address has passed its retry time. In the absence of new
23771 messages, the minimum time between retries is the interval between queue runner
23772 processes. There is not much point in setting retry times of five minutes if
23773 your queue runners happen only once an hour, unless there are a significant
23774 number of incoming messages (which might be the case on a system that is
23775 sending everything to a smart host, for example).
23776
23777 The data in the retry hints database can be inspected by using the
23778 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23779 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23780 &'exinext'& utility script can be used to find out what the next retry times
23781 are for the hosts associated with a particular mail domain, and also for local
23782 deliveries that have been deferred.
23783
23784
23785 .section "Retry rule examples" "SECID164"
23786 Here are some example retry rules:
23787 .code
23788 alice@wonderland.fict.example quota_5d  F,7d,3h
23789 wonderland.fict.example       quota_5d
23790 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23791 lookingglass.fict.example     *         F,24h,30m;
23792 *                 refused_A   F,2h,20m;
23793 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23794 .endd
23795 The first rule sets up special handling for mail to
23796 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23797 mailbox has not been read for at least 5 days. Retries continue every three
23798 hours for 7 days. The second rule handles over-quota errors for all other local
23799 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23800 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23801 fail are bounced immediately if the mailbox has not been read for at least 5
23802 days.
23803
23804 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23805 happen every 15 minutes for an hour, then with geometrically increasing
23806 intervals until two days have passed since a delivery first failed. After the
23807 first hour there is a delay of one hour, then two hours, then four hours, and
23808 so on (this is a rather extreme example).
23809
23810 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23811 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23812 all other domains, with special action for connection refusal from hosts that
23813 were not obtained from an MX record.
23814
23815 The final rule in a retry configuration should always have asterisks in the
23816 first two fields so as to provide a general catch-all for any addresses that do
23817 not have their own special handling. This example tries every 15 minutes for 2
23818 hours, then with intervals starting at one hour and increasing by a factor of
23819 1.5 up to 16 hours, then every 8 hours up to 5 days.
23820
23821
23822
23823 .section "Timeout of retry data" "SECID165"
23824 .cindex "timeout" "of retry data"
23825 .oindex "&%retry_data_expire%&"
23826 .cindex "hints database" "data expiry"
23827 .cindex "retry" "timeout of data"
23828 Exim timestamps the data that it writes to its retry hints database. When it
23829 consults the data during a delivery it ignores any that is older than the value
23830 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23831 been tried for 7 days, Exim will try to deliver to it immediately a message
23832 arrives, and if that fails, it will calculate a retry time as if it were
23833 failing for the first time.
23834
23835 This improves the behaviour for messages routed to rarely-used hosts such as MX
23836 backups. If such a host was down at one time, and happens to be down again when
23837 Exim tries a month later, using the old retry data would imply that it had been
23838 down all the time, which is not a justified assumption.
23839
23840 If a host really is permanently dead, this behaviour causes a burst of retries
23841 every now and again, but only if messages routed to it are rare. If there is a
23842 message at least once every 7 days the retry data never expires.
23843
23844
23845
23846
23847 .section "Long-term failures" "SECID166"
23848 .cindex "delivery failure, long-term"
23849 .cindex "retry" "after long-term failure"
23850 Special processing happens when an email address has been failing for so long
23851 that the cutoff time for the last algorithm is reached. For example, using the
23852 default retry rule:
23853 .code
23854 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23855 .endd
23856 the cutoff time is four days. Reaching the retry cutoff is independent of how
23857 long any specific message has been failing; it is the length of continuous
23858 failure for the recipient address that counts.
23859
23860 When the cutoff time is reached for a local delivery, or for all the IP
23861 addresses associated with a remote delivery, a subsequent delivery failure
23862 causes Exim to give up on the address, and a bounce message is generated.
23863 In order to cater for new messages that use the failing address, a next retry
23864 time is still computed from the final algorithm, and is used as follows:
23865
23866 For local deliveries, one delivery attempt is always made for any subsequent
23867 messages. If this delivery fails, the address fails immediately. The
23868 post-cutoff retry time is not used.
23869
23870 If the delivery is remote, there are two possibilities, controlled by the
23871 .oindex "&%delay_after_cutoff%&"
23872 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23873 default. Until the post-cutoff retry time for one of the IP addresses is
23874 reached, the failing email address is bounced immediately, without a delivery
23875 attempt taking place. After that time, one new delivery attempt is made to
23876 those IP addresses that are past their retry times, and if that still fails,
23877 the address is bounced and new retry times are computed.
23878
23879 In other words, when all the hosts for a given email address have been failing
23880 for a long time, Exim bounces rather then defers until one of the hosts' retry
23881 times is reached. Then it tries once, and bounces if that attempt fails. This
23882 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23883 to a broken destination, but if the host does recover, Exim will eventually
23884 notice.
23885
23886 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23887 addresses are past their final cutoff time, Exim tries to deliver to those IP
23888 addresses that have not been tried since the message arrived. If there are
23889 no suitable IP addresses, or if they all fail, the address is bounced. In other
23890 words, it does not delay when a new message arrives, but tries the expired
23891 addresses immediately, unless they have been tried since the message arrived.
23892 If there is a continuous stream of messages for the failing domains, setting
23893 &%delay_after_cutoff%& false means that there will be many more attempts to
23894 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23895 true.
23896
23897 .section "Deliveries that work intermittently" "SECID167"
23898 .cindex "retry" "intermittently working deliveries"
23899 Some additional logic is needed to cope with cases where a host is
23900 intermittently available, or when a message has some attribute that prevents
23901 its delivery when others to the same address get through. In this situation,
23902 because some messages are successfully delivered, the &"retry clock"& for the
23903 host or address keeps getting reset by the successful deliveries, and so
23904 failing messages remain on the queue for ever because the cutoff time is never
23905 reached.
23906
23907 Two exceptional actions are applied to prevent this happening. The first
23908 applies to errors that are related to a message rather than a remote host.
23909 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23910 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23911 commands, and quota failures. For this type of error, if a message's arrival
23912 time is earlier than the &"first failed"& time for the error, the earlier time
23913 is used when scanning the retry rules to decide when to try next and when to
23914 time out the address.
23915
23916 The exceptional second action applies in all cases. If a message has been on
23917 the queue for longer than the cutoff time of any applicable retry rule for a
23918 given address, a delivery is attempted for that address, even if it is not yet
23919 time, and if this delivery fails, the address is timed out. A new retry time is
23920 not computed in this case, so that other messages for the same address are
23921 considered immediately.
23922 .ecindex IIDretconf1
23923 .ecindex IIDregconf2
23924
23925
23926
23927
23928
23929
23930 . ////////////////////////////////////////////////////////////////////////////
23931 . ////////////////////////////////////////////////////////////////////////////
23932
23933 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23934 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23935 .scindex IIDauthconf2 "authentication"
23936 The &"authenticators"& section of Exim's run time configuration is concerned
23937 with SMTP authentication. This facility is an extension to the SMTP protocol,
23938 described in RFC 2554, which allows a client SMTP host to authenticate itself
23939 to a server. This is a common way for a server to recognize clients that are
23940 permitted to use it as a relay. SMTP authentication is not of relevance to the
23941 transfer of mail between servers that have no managerial connection with each
23942 other.
23943
23944 .cindex "AUTH" "description of"
23945 Very briefly, the way SMTP authentication works is as follows:
23946
23947 .ilist
23948 The server advertises a number of authentication &'mechanisms'& in response to
23949 the client's EHLO command.
23950 .next
23951 The client issues an AUTH command, naming a specific mechanism. The command
23952 may, optionally, contain some authentication data.
23953 .next
23954 The server may issue one or more &'challenges'&, to which the client must send
23955 appropriate responses. In simple authentication mechanisms, the challenges are
23956 just prompts for user names and passwords. The server does not have to issue
23957 any challenges &-- in some mechanisms the relevant data may all be transmitted
23958 with the AUTH command.
23959 .next
23960 The server either accepts or denies authentication.
23961 .next
23962 If authentication succeeds, the client may optionally make use of the AUTH
23963 option on the MAIL command to pass an authenticated sender in subsequent
23964 mail transactions. Authentication lasts for the remainder of the SMTP
23965 connection.
23966 .next
23967 If authentication fails, the client may give up, or it may try a different
23968 authentication mechanism, or it may try transferring mail over the
23969 unauthenticated connection.
23970 .endlist
23971
23972 If you are setting up a client, and want to know which authentication
23973 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23974 SMTP port) on the server, and issue an EHLO command. The response to this
23975 includes the list of supported mechanisms. For example:
23976 .display
23977 &`$ `&&*&`telnet server.example 25`&*&
23978 &`Trying 192.168.34.25...`&
23979 &`Connected to server.example.`&
23980 &`Escape character is &#x0027;^]&#x0027;.`&
23981 &`220 server.example ESMTP Exim 4.20 ...`&
23982 &*&`ehlo client.example`&*&
23983 &`250-server.example Hello client.example [10.8.4.5]`&
23984 &`250-SIZE 52428800`&
23985 &`250-PIPELINING`&
23986 &`250-AUTH PLAIN`&
23987 &`250 HELP`&
23988 .endd
23989 The second-last line of this example output shows that the server supports
23990 authentication using the PLAIN mechanism. In Exim, the different authentication
23991 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23992 routers and transports, which authenticators are included in the binary is
23993 controlled by build-time definitions. The following are currently available,
23994 included by setting
23995 .code
23996 AUTH_CRAM_MD5=yes
23997 AUTH_CYRUS_SASL=yes
23998 AUTH_DOVECOT=yes
23999 AUTH_GSASL=yes
24000 AUTH_HEIMDAL_GSSAPI=yes
24001 AUTH_PLAINTEXT=yes
24002 AUTH_SPA=yes
24003 .endd
24004 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24005 authentication mechanism (RFC 2195), and the second provides an interface to
24006 the Cyrus SASL authentication library.
24007 The third is an interface to Dovecot's authentication system, delegating the
24008 work via a socket interface.
24009 The fourth provides an interface to the GNU SASL authentication library, which
24010 provides mechanisms but typically not data sources.
24011 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24012 supporting setting a server keytab.
24013 The sixth can be configured to support
24014 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24015 not formally documented, but used by several MUAs. The seventh authenticator
24016 supports Microsoft's &'Secure Password Authentication'& mechanism.
24017
24018 The authenticators are configured using the same syntax as other drivers (see
24019 section &<<SECTfordricon>>&). If no authenticators are required, no
24020 authentication section need be present in the configuration file. Each
24021 authenticator can in principle have both server and client functions. When Exim
24022 is receiving SMTP mail, it is acting as a server; when it is sending out
24023 messages over SMTP, it is acting as a client. Authenticator configuration
24024 options are provided for use in both these circumstances.
24025
24026 To make it clear which options apply to which situation, the prefixes
24027 &%server_%& and &%client_%& are used on option names that are specific to
24028 either the server or the client function, respectively. Server and client
24029 functions are disabled if none of their options are set. If an authenticator is
24030 to be used for both server and client functions, a single definition, using
24031 both sets of options, is required. For example:
24032 .code
24033 cram:
24034   driver = cram_md5
24035   public_name = CRAM-MD5
24036   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24037   client_name = ph10
24038   client_secret = secret2
24039 .endd
24040 The &%server_%& option is used when Exim is acting as a server, and the
24041 &%client_%& options when it is acting as a client.
24042
24043 Descriptions of the individual authenticators are given in subsequent chapters.
24044 The remainder of this chapter covers the generic options for the
24045 authenticators, followed by general discussion of the way authentication works
24046 in Exim.
24047
24048 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24049 per-mechanism basis.  Please read carefully to determine which variables hold
24050 account labels such as usercodes and which hold passwords or other
24051 authenticating data.
24052
24053 Note that some mechanisms support two different identifiers for accounts: the
24054 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24055 and &'authz'& are commonly encountered.  The American spelling is standard here.
24056 Conceptually, authentication data such as passwords are tied to the identifier
24057 used to authenticate; servers may have rules to permit one user to act as a
24058 second user, so that after login the session is treated as though that second
24059 user had logged in.  That second user is the &'authorization id'&.  A robust
24060 configuration might confirm that the &'authz'& field is empty or matches the
24061 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24062 as verified data, the &'authz'& as an unverified request which the server might
24063 choose to honour.
24064
24065 A &'realm'& is a text string, typically a domain name, presented by a server
24066 to a client to help it select an account and credentials to use.  In some
24067 mechanisms, the client and server provably agree on the realm, but clients
24068 typically can not treat the realm as secure data to be blindly trusted.
24069
24070
24071
24072 .section "Generic options for authenticators" "SECID168"
24073 .cindex "authentication" "generic options"
24074 .cindex "options" "generic; for authenticators"
24075
24076 .option client_condition authenticators string&!! unset
24077 When Exim is authenticating as a client, it skips any authenticator whose
24078 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24079 used, for example, to skip plain text authenticators when the connection is not
24080 encrypted by a setting such as:
24081 .code
24082 client_condition = ${if !eq{$tls_out_cipher}{}}
24083 .endd
24084
24085
24086 .option client_set_id authenticators string&!! unset
24087 When client authentication succeeds, this condition is expanded; the
24088 result is used in the log lines for outbound messasges.
24089 Typically it will be the user name used for authentication.
24090
24091
24092 .option driver authenticators string unset
24093 This option must always be set. It specifies which of the available
24094 authenticators is to be used.
24095
24096
24097 .option public_name authenticators string unset
24098 This option specifies the name of the authentication mechanism that the driver
24099 implements, and by which it is known to the outside world. These names should
24100 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24101 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24102 defaults to the driver's instance name.
24103
24104
24105 .option server_advertise_condition authenticators string&!! unset
24106 When a server is about to advertise an authentication mechanism, the condition
24107 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24108 mechanism is not advertised.
24109 If the expansion fails, the mechanism is not advertised. If the failure was not
24110 forced, and was not caused by a lookup defer, the incident is logged.
24111 See section &<<SECTauthexiser>>& below for further discussion.
24112
24113
24114 .option server_condition authenticators string&!! unset
24115 This option must be set for a &%plaintext%& server authenticator, where it
24116 is used directly to control authentication. See section &<<SECTplainserver>>&
24117 for details.
24118
24119 For the &(gsasl)& authenticator, this option is required for various
24120 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24121
24122 For the other authenticators, &%server_condition%& can be used as an additional
24123 authentication or authorization mechanism that is applied after the other
24124 authenticator conditions succeed. If it is set, it is expanded when the
24125 authenticator would otherwise return a success code. If the expansion is forced
24126 to fail, authentication fails. Any other expansion failure causes a temporary
24127 error code to be returned. If the result of a successful expansion is an empty
24128 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24129 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24130 other result, a temporary error code is returned, with the expanded string as
24131 the error text.
24132
24133
24134 .option server_debug_print authenticators string&!! unset
24135 If this option is set and authentication debugging is enabled (see the &%-d%&
24136 command line option), the string is expanded and included in the debugging
24137 output when the authenticator is run as a server. This can help with checking
24138 out the values of variables.
24139 If expansion of the string fails, the error message is written to the debugging
24140 output, and Exim carries on processing.
24141
24142
24143 .option server_set_id authenticators string&!! unset
24144 .vindex "&$authenticated_id$&"
24145 When an Exim server successfully authenticates a client, this string is
24146 expanded using data from the authentication, and preserved for any incoming
24147 messages in the variable &$authenticated_id$&. It is also included in the log
24148 lines for incoming messages. For example, a user/password authenticator
24149 configuration might preserve the user name that was used to authenticate, and
24150 refer to it subsequently during delivery of the message.
24151 If expansion fails, the option is ignored.
24152
24153
24154 .option server_mail_auth_condition authenticators string&!! unset
24155 This option allows a server to discard authenticated sender addresses supplied
24156 as part of MAIL commands in SMTP connections that are authenticated by the
24157 driver on which &%server_mail_auth_condition%& is set. The option is not used
24158 as part of the authentication process; instead its (unexpanded) value is
24159 remembered for later use.
24160 How it is used is described in the following section.
24161
24162
24163
24164
24165
24166 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24167 .cindex "authentication" "sender; authenticated"
24168 .cindex "AUTH" "on MAIL command"
24169 When a client supplied an AUTH= item on a MAIL command, Exim applies
24170 the following checks before accepting it as the authenticated sender of the
24171 message:
24172
24173 .ilist
24174 If the connection is not using extended SMTP (that is, HELO was used rather
24175 than EHLO), the use of AUTH= is a syntax error.
24176 .next
24177 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24178 .next
24179 .vindex "&$authenticated_sender$&"
24180 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24181 running, the value of &$authenticated_sender$& is set to the value obtained
24182 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24183 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24184 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24185 given for the MAIL command.
24186 .next
24187 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24188 is accepted and placed in &$authenticated_sender$& only if the client has
24189 authenticated.
24190 .next
24191 If the AUTH= value was accepted by either of the two previous rules, and
24192 the client has authenticated, and the authenticator has a setting for the
24193 &%server_mail_auth_condition%&, the condition is checked at this point. The
24194 valued that was saved from the authenticator is expanded. If the expansion
24195 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24196 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24197 the value of &$authenticated_sender$& is retained and passed on with the
24198 message.
24199 .endlist
24200
24201
24202 When &$authenticated_sender$& is set for a message, it is passed on to other
24203 hosts to which Exim authenticates as a client. Do not confuse this value with
24204 &$authenticated_id$&, which is a string obtained from the authentication
24205 process, and which is not usually a complete email address.
24206
24207 .vindex "&$sender_address$&"
24208 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24209 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24210 therefore make use of &$authenticated_sender$&. The converse is not true: the
24211 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24212 ACL is run.
24213
24214
24215
24216 .section "Authentication on an Exim server" "SECTauthexiser"
24217 .cindex "authentication" "on an Exim server"
24218 When Exim receives an EHLO command, it advertises the public names of those
24219 authenticators that are configured as servers, subject to the following
24220 conditions:
24221
24222 .ilist
24223 The client host must match &%auth_advertise_hosts%& (default *).
24224 .next
24225 It the &%server_advertise_condition%& option is set, its expansion must not
24226 yield the empty string, &"0"&, &"no"&, or &"false"&.
24227 .endlist
24228
24229 The order in which the authenticators are defined controls the order in which
24230 the mechanisms are advertised.
24231
24232 Some mail clients (for example, some versions of Netscape) require the user to
24233 provide a name and password for authentication whenever AUTH is advertised,
24234 even though authentication may not in fact be needed (for example, Exim may be
24235 set up to allow unconditional relaying from the client by an IP address check).
24236 You can make such clients more friendly by not advertising AUTH to them.
24237 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24238 that runs for RCPT) to relay without authentication, you should set
24239 .code
24240 auth_advertise_hosts = ! 10.9.8.0/24
24241 .endd
24242 so that no authentication mechanisms are advertised to them.
24243
24244 The &%server_advertise_condition%& controls the advertisement of individual
24245 authentication mechanisms. For example, it can be used to restrict the
24246 advertisement of a particular mechanism to encrypted connections, by a setting
24247 such as:
24248 .code
24249 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24250 .endd
24251 .vindex "&$tls_in_cipher$&"
24252 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24253 yields &"yes"&, which allows the advertisement to happen.
24254
24255 When an Exim server receives an AUTH command from a client, it rejects it
24256 immediately if AUTH was not advertised in response to an earlier EHLO
24257 command. This is the case if
24258
24259 .ilist
24260 The client host does not match &%auth_advertise_hosts%&; or
24261 .next
24262 No authenticators are configured with server options; or
24263 .next
24264 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24265 server authenticators.
24266 .endlist
24267
24268
24269 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24270 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24271 AUTH is accepted from any client host.
24272
24273 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24274 server authentication mechanism that was advertised in response to EHLO and
24275 that matches the one named in the AUTH command. If it finds one, it runs
24276 the appropriate authentication protocol, and authentication either succeeds or
24277 fails. If there is no matching advertised mechanism, the AUTH command is
24278 rejected with a 504 error.
24279
24280 .vindex "&$received_protocol$&"
24281 .vindex "&$sender_host_authenticated$&"
24282 When a message is received from an authenticated host, the value of
24283 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24284 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24285 public name) of the authenticator driver that successfully authenticated the
24286 client from which the message was received. This variable is empty if there was
24287 no successful authentication.
24288
24289
24290
24291
24292 .section "Testing server authentication" "SECID169"
24293 .cindex "authentication" "testing a server"
24294 .cindex "AUTH" "testing a server"
24295 .cindex "base64 encoding" "creating authentication test data"
24296 Exim's &%-bh%& option can be useful for testing server authentication
24297 configurations. The data for the AUTH command has to be sent using base64
24298 encoding. A quick way to produce such data for testing is the following Perl
24299 script:
24300 .code
24301 use MIME::Base64;
24302 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24303 .endd
24304 .cindex "binary zero" "in authentication data"
24305 This interprets its argument as a Perl string, and then encodes it. The
24306 interpretation as a Perl string allows binary zeros, which are required for
24307 some kinds of authentication, to be included in the data. For example, a
24308 command line to run this script on such data might be
24309 .code
24310 encode '\0user\0password'
24311 .endd
24312 Note the use of single quotes to prevent the shell interpreting the
24313 backslashes, so that they can be interpreted by Perl to specify characters
24314 whose code value is zero.
24315
24316 &*Warning 1*&: If either of the user or password strings starts with an octal
24317 digit, you must use three zeros instead of one after the leading backslash. If
24318 you do not, the octal digit that starts your string will be incorrectly
24319 interpreted as part of the code for the first character.
24320
24321 &*Warning 2*&: If there are characters in the strings that Perl interprets
24322 specially, you must use a Perl escape to prevent them being misinterpreted. For
24323 example, a command such as
24324 .code
24325 encode '\0user@domain.com\0pas$$word'
24326 .endd
24327 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24328
24329 If you have the &%mimencode%& command installed, another way to do produce
24330 base64-encoded strings is to run the command
24331 .code
24332 echo -e -n `\0user\0password' | mimencode
24333 .endd
24334 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24335 in the argument, and the &%-n%& option specifies no newline at the end of its
24336 output. However, not all versions of &%echo%& recognize these options, so you
24337 should check your version before relying on this suggestion.
24338
24339
24340
24341 .section "Authentication by an Exim client" "SECID170"
24342 .cindex "authentication" "on an Exim client"
24343 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24344 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24345 announces support for authentication, and the host matches an entry in either
24346 of these options, Exim (as a client) tries to authenticate as follows:
24347
24348 .ilist
24349 For each authenticator that is configured as a client, in the order in which
24350 they are defined in the configuration, it searches the authentication
24351 mechanisms announced by the server for one whose name matches the public name
24352 of the authenticator.
24353 .next
24354 .vindex "&$host$&"
24355 .vindex "&$host_address$&"
24356 When it finds one that matches, it runs the authenticator's client code. The
24357 variables &$host$& and &$host_address$& are available for any string expansions
24358 that the client might do. They are set to the server's name and IP address. If
24359 any expansion is forced to fail, the authentication attempt is abandoned, and
24360 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24361 delivery to be deferred.
24362 .next
24363 If the result of the authentication attempt is a temporary error or a timeout,
24364 Exim abandons trying to send the message to the host for the moment. It will
24365 try again later. If there are any backup hosts available, they are tried in the
24366 usual way.
24367 .next
24368 If the response to authentication is a permanent error (5&'xx'& code), Exim
24369 carries on searching the list of authenticators and tries another one if
24370 possible. If all authentication attempts give permanent errors, or if there are
24371 no attempts because no mechanisms match (or option expansions force failure),
24372 what happens depends on whether the host matches &%hosts_require_auth%& or
24373 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24374 delivery is deferred. The error can be detected in the retry rules, and thereby
24375 turned into a permanent error if you wish. In the second case, Exim tries to
24376 deliver the message unauthenticated.
24377 .endlist
24378
24379 .cindex "AUTH" "on MAIL command"
24380 When Exim has authenticated itself to a remote server, it adds the AUTH
24381 parameter to the MAIL commands it sends, if it has an authenticated sender for
24382 the message. If the message came from a remote host, the authenticated sender
24383 is the one that was receiving on an incoming MAIL command, provided that the
24384 incoming connection was authenticated and the &%server_mail_auth%& condition
24385 allowed the authenticated sender to be retained. If a local process calls Exim
24386 to send a message, the sender address that is built from the login name and
24387 &%qualify_domain%& is treated as authenticated. However, if the
24388 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24389 the authenticated sender that was received with the message.
24390 .ecindex IIDauthconf1
24391 .ecindex IIDauthconf2
24392
24393
24394
24395
24396
24397
24398 . ////////////////////////////////////////////////////////////////////////////
24399 . ////////////////////////////////////////////////////////////////////////////
24400
24401 .chapter "The plaintext authenticator" "CHAPplaintext"
24402 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24403 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24404 The &(plaintext)& authenticator can be configured to support the PLAIN and
24405 LOGIN authentication mechanisms, both of which transfer authentication data as
24406 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24407 security risk; you are strongly advised to insist on the use of SMTP encryption
24408 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24409 use unencrypted plain text, you should not use the same passwords for SMTP
24410 connections as you do for login accounts.
24411
24412 .section "Plaintext options" "SECID171"
24413 .cindex "options" "&(plaintext)& authenticator (server)"
24414 When configured as a server, &(plaintext)& uses the following options:
24415
24416 .option server_condition authenticators string&!! unset
24417 This is actually a global authentication option, but it must be set in order to
24418 configure the &(plaintext)& driver as a server. Its use is described below.
24419
24420 .option server_prompts plaintext string&!! unset
24421 The contents of this option, after expansion, must be a colon-separated list of
24422 prompt strings. If expansion fails, a temporary authentication rejection is
24423 given.
24424
24425 .section "Using plaintext in a server" "SECTplainserver"
24426 .cindex "AUTH" "in &(plaintext)& authenticator"
24427 .cindex "binary zero" "in &(plaintext)& authenticator"
24428 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24429         "in &(plaintext)& authenticator"
24430 .vindex "&$auth1$&, &$auth2$&, etc"
24431 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24432
24433 When running as a server, &(plaintext)& performs the authentication test by
24434 expanding a string. The data sent by the client with the AUTH command, or in
24435 response to subsequent prompts, is base64 encoded, and so may contain any byte
24436 values when decoded. If any data is supplied with the command, it is treated as
24437 a list of strings, separated by NULs (binary zeros), the first three of which
24438 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24439 (neither LOGIN nor PLAIN uses more than three strings).
24440
24441 For compatibility with previous releases of Exim, the values are also placed in
24442 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24443 variables for this purpose is now deprecated, as it can lead to confusion in
24444 string expansions that also use them for other things.
24445
24446 If there are more strings in &%server_prompts%& than the number of strings
24447 supplied with the AUTH command, the remaining prompts are used to obtain more
24448 data. Each response from the client may be a list of NUL-separated strings.
24449
24450 .vindex "&$authenticated_id$&"
24451 Once a sufficient number of data strings have been received,
24452 &%server_condition%& is expanded. If the expansion is forced to fail,
24453 authentication fails. Any other expansion failure causes a temporary error code
24454 to be returned. If the result of a successful expansion is an empty string,
24455 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24456 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24457 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24458 For any other result, a temporary error code is returned, with the expanded
24459 string as the error text.
24460
24461 &*Warning*&: If you use a lookup in the expansion to find the user's
24462 password, be sure to make the authentication fail if the user is unknown.
24463 There are good and bad examples at the end of the next section.
24464
24465
24466
24467 .section "The PLAIN authentication mechanism" "SECID172"
24468 .cindex "PLAIN authentication mechanism"
24469 .cindex "authentication" "PLAIN mechanism"
24470 .cindex "binary zero" "in &(plaintext)& authenticator"
24471 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24472 sent as one item of data (that is, one combined string containing two NUL
24473 separators). The data is sent either as part of the AUTH command, or
24474 subsequently in response to an empty prompt from the server.
24475
24476 The second and third strings are a user name and a corresponding password.
24477 Using a single fixed user name and password as an example, this could be
24478 configured as follows:
24479 .code
24480 fixed_plain:
24481   driver = plaintext
24482   public_name = PLAIN
24483   server_prompts = :
24484   server_condition = \
24485     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24486   server_set_id = $auth2
24487 .endd
24488 Note that the default result strings from &%if%& (&"true"& or an empty string)
24489 are exactly what we want here, so they need not be specified. Obviously, if the
24490 password contains expansion-significant characters such as dollar, backslash,
24491 or closing brace, they have to be escaped.
24492
24493 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24494 the end of a string list are ignored). If all the data comes as part of the
24495 AUTH command, as is commonly the case, the prompt is not used. This
24496 authenticator is advertised in the response to EHLO as
24497 .code
24498 250-AUTH PLAIN
24499 .endd
24500 and a client host can authenticate itself by sending the command
24501 .code
24502 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24503 .endd
24504 As this contains three strings (more than the number of prompts), no further
24505 data is required from the client. Alternatively, the client may just send
24506 .code
24507 AUTH PLAIN
24508 .endd
24509 to initiate authentication, in which case the server replies with an empty
24510 prompt. The client must respond with the combined data string.
24511
24512 The data string is base64 encoded, as required by the RFC. This example,
24513 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24514 represents a zero byte. This is split up into three strings, the first of which
24515 is empty. The &%server_condition%& option in the authenticator checks that the
24516 second two are &`username`& and &`mysecret`& respectively.
24517
24518 Having just one fixed user name and password, as in this example, is not very
24519 realistic, though for a small organization with only a handful of
24520 authenticating clients it could make sense.
24521
24522 A more sophisticated instance of this authenticator could use the user name in
24523 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24524 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24525 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24526 This is an incorrect example:
24527 .code
24528 server_condition = \
24529   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24530 .endd
24531 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24532 which it then compares to the supplied password (&$auth3$&). Why is this example
24533 incorrect? It works fine for existing users, but consider what happens if a
24534 non-existent user name is given. The lookup fails, but as no success/failure
24535 strings are given for the lookup, it yields an empty string. Thus, to defeat
24536 the authentication, all a client has to do is to supply a non-existent user
24537 name and an empty password. The correct way of writing this test is:
24538 .code
24539 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24540   {${if eq{$value}{$auth3}}} {false}}
24541 .endd
24542 In this case, if the lookup succeeds, the result is checked; if the lookup
24543 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24544 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24545 always fails if its second argument is empty. However, the second way of
24546 writing the test makes the logic clearer.
24547
24548
24549 .section "The LOGIN authentication mechanism" "SECID173"
24550 .cindex "LOGIN authentication mechanism"
24551 .cindex "authentication" "LOGIN mechanism"
24552 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24553 in a number of programs. No data is sent with the AUTH command. Instead, a
24554 user name and password are supplied separately, in response to prompts. The
24555 plaintext authenticator can be configured to support this as in this example:
24556 .code
24557 fixed_login:
24558   driver = plaintext
24559   public_name = LOGIN
24560   server_prompts = User Name : Password
24561   server_condition = \
24562     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24563   server_set_id = $auth1
24564 .endd
24565 Because of the way plaintext operates, this authenticator accepts data supplied
24566 with the AUTH command (in contravention of the specification of LOGIN), but
24567 if the client does not supply it (as is the case for LOGIN clients), the prompt
24568 strings are used to obtain two data items.
24569
24570 Some clients are very particular about the precise text of the prompts. For
24571 example, Outlook Express is reported to recognize only &"Username:"& and
24572 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24573 strings. It uses the &%ldapauth%& expansion condition to check the user
24574 name and password by binding to an LDAP server:
24575 .code
24576 login:
24577   driver = plaintext
24578   public_name = LOGIN
24579   server_prompts = Username:: : Password::
24580   server_condition = ${if and{{ \
24581     !eq{}{$auth1} }{ \
24582     ldapauth{\
24583       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24584       pass=${quote:$auth2} \
24585       ldap://ldap.example.org/} }} }
24586   server_set_id = uid=$auth1,ou=people,o=example.org
24587 .endd
24588 We have to check that the username is not empty before using it, because LDAP
24589 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24590 operator to correctly quote the DN for authentication. However, the basic
24591 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24592 correct one to use for the password, because quoting is needed only to make
24593 the password conform to the Exim syntax. At the LDAP level, the password is an
24594 uninterpreted string.
24595
24596
24597 .section "Support for different kinds of authentication" "SECID174"
24598 A number of string expansion features are provided for the purpose of
24599 interfacing to different ways of user authentication. These include checking
24600 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24601 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24602 &<<SECTexpcond>>&.
24603
24604
24605
24606
24607 .section "Using plaintext in a client" "SECID175"
24608 .cindex "options" "&(plaintext)& authenticator (client)"
24609 The &(plaintext)& authenticator has two client options:
24610
24611 .option client_ignore_invalid_base64 plaintext boolean false
24612 If the client receives a server prompt that is not a valid base64 string,
24613 authentication is abandoned by default. However, if this option is set true,
24614 the error in the challenge is ignored and the client sends the response as
24615 usual.
24616
24617 .option client_send plaintext string&!! unset
24618 The string is a colon-separated list of authentication data strings. Each
24619 string is independently expanded before being sent to the server. The first
24620 string is sent with the AUTH command; any more strings are sent in response
24621 to prompts from the server. Before each string is expanded, the value of the
24622 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24623 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24624 way. Thus, the prompt that is received in response to sending the first string
24625 (with the AUTH command) can be used in the expansion of the second string, and
24626 so on. If an invalid base64 string is received when
24627 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24628 &$auth$&<&'n'&> variable.
24629
24630 &*Note*&: You cannot use expansion to create multiple strings, because
24631 splitting takes priority and happens first.
24632
24633 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24634 the data, further processing is applied to each string before it is sent. If
24635 there are any single circumflex characters in the string, they are converted to
24636 NULs. Should an actual circumflex be required as data, it must be doubled in
24637 the string.
24638
24639 This is an example of a client configuration that implements the PLAIN
24640 authentication mechanism with a fixed user name and password:
24641 .code
24642 fixed_plain:
24643   driver = plaintext
24644   public_name = PLAIN
24645   client_send = ^username^mysecret
24646 .endd
24647 The lack of colons means that the entire text is sent with the AUTH
24648 command, with the circumflex characters converted to NULs. A similar example
24649 that uses the LOGIN mechanism is:
24650 .code
24651 fixed_login:
24652   driver = plaintext
24653   public_name = LOGIN
24654   client_send = : username : mysecret
24655 .endd
24656 The initial colon means that the first string is empty, so no data is sent with
24657 the AUTH command itself. The remaining strings are sent in response to
24658 prompts.
24659 .ecindex IIDplaiauth1
24660 .ecindex IIDplaiauth2
24661
24662
24663
24664
24665 . ////////////////////////////////////////////////////////////////////////////
24666 . ////////////////////////////////////////////////////////////////////////////
24667
24668 .chapter "The cram_md5 authenticator" "CHID9"
24669 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24670 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24671 .cindex "CRAM-MD5 authentication mechanism"
24672 .cindex "authentication" "CRAM-MD5 mechanism"
24673 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24674 sends a challenge string to the client, and the response consists of a user
24675 name and the CRAM-MD5 digest of the challenge string combined with a secret
24676 string (password) which is known to both server and client. Thus, the secret
24677 is not sent over the network as plain text, which makes this authenticator more
24678 secure than &(plaintext)&. However, the downside is that the secret has to be
24679 available in plain text at either end.
24680
24681
24682 .section "Using cram_md5 as a server" "SECID176"
24683 .cindex "options" "&(cram_md5)& authenticator (server)"
24684 This authenticator has one server option, which must be set to configure the
24685 authenticator as a server:
24686
24687 .option server_secret cram_md5 string&!! unset
24688 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24689 When the server receives the client's response, the user name is placed in
24690 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24691 obtain the password for that user. The server then computes the CRAM-MD5 digest
24692 that the client should have sent, and checks that it received the correct
24693 string. If the expansion of &%server_secret%& is forced to fail, authentication
24694 fails. If the expansion fails for some other reason, a temporary error code is
24695 returned to the client.
24696
24697 For compatibility with previous releases of Exim, the user name is also placed
24698 in &$1$&. However, the use of this variables for this purpose is now
24699 deprecated, as it can lead to confusion in string expansions that also use
24700 numeric variables for other things.
24701
24702 For example, the following authenticator checks that the user name given by the
24703 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24704 user name, authentication fails.
24705 .code
24706 fixed_cram:
24707   driver = cram_md5
24708   public_name = CRAM-MD5
24709   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24710   server_set_id = $auth1
24711 .endd
24712 .vindex "&$authenticated_id$&"
24713 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24714 name in &$authenticated_id$&. A more typical configuration might look up the
24715 secret string in a file, using the user name as the key. For example:
24716 .code
24717 lookup_cram:
24718   driver = cram_md5
24719   public_name = CRAM-MD5
24720   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24721                   {$value}fail}
24722   server_set_id = $auth1
24723 .endd
24724 Note that this expansion explicitly forces failure if the lookup fails
24725 because &$auth1$& contains an unknown user name.
24726
24727 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24728 using the relevant libraries, you need to know the realm to specify in the
24729 lookup and then ask for the &"userPassword"& attribute for that user in that
24730 realm, with:
24731 .code
24732 cyrusless_crammd5:
24733   driver = cram_md5
24734   public_name = CRAM-MD5
24735   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24736                   dbmjz{/etc/sasldb2}}
24737   server_set_id = $auth1
24738 .endd
24739
24740 .section "Using cram_md5 as a client" "SECID177"
24741 .cindex "options" "&(cram_md5)& authenticator (client)"
24742 When used as a client, the &(cram_md5)& authenticator has two options:
24743
24744
24745
24746 .option client_name cram_md5 string&!! "the primary host name"
24747 This string is expanded, and the result used as the user name data when
24748 computing the response to the server's challenge.
24749
24750
24751 .option client_secret cram_md5 string&!! unset
24752 This option must be set for the authenticator to work as a client. Its value is
24753 expanded and the result used as the secret string when computing the response.
24754
24755
24756 .vindex "&$host$&"
24757 .vindex "&$host_address$&"
24758 Different user names and secrets can be used for different servers by referring
24759 to &$host$& or &$host_address$& in the options. Forced failure of either
24760 expansion string is treated as an indication that this authenticator is not
24761 prepared to handle this case. Exim moves on to the next configured client
24762 authenticator. Any other expansion failure causes Exim to give up trying to
24763 send the message to the current server.
24764
24765 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24766 strings, is:
24767 .code
24768 fixed_cram:
24769   driver = cram_md5
24770   public_name = CRAM-MD5
24771   client_name = ph10
24772   client_secret = secret
24773 .endd
24774 .ecindex IIDcramauth1
24775 .ecindex IIDcramauth2
24776
24777
24778
24779 . ////////////////////////////////////////////////////////////////////////////
24780 . ////////////////////////////////////////////////////////////////////////////
24781
24782 .chapter "The cyrus_sasl authenticator" "CHID10"
24783 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24784 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24785 .cindex "Cyrus" "SASL library"
24786 .cindex "Kerberos"
24787 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24788 Digital Ltd (&url(http://www.aldigital.co.uk)).
24789
24790 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24791 library implementation of the RFC 2222 (&"Simple Authentication and Security
24792 Layer"&). This library supports a number of authentication mechanisms,
24793 including PLAIN and LOGIN, but also several others that Exim does not support
24794 directly. In particular, there is support for Kerberos authentication.
24795
24796 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24797 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24798 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24799 name of the driver to determine which mechanism to support.
24800
24801 Where access to some kind of secret file is required, for example in GSSAPI
24802 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24803 user, and that the Cyrus SASL library has no way of escalating privileges
24804 by default. You may also find you need to set environment variables,
24805 depending on the driver you are using.
24806
24807 The application name provided by Exim is &"exim"&, so various SASL options may
24808 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24809 Kerberos, note that because of limitations in the GSSAPI interface,
24810 changing the server keytab might need to be communicated down to the Kerberos
24811 layer independently. The mechanism for doing so is dependent upon the Kerberos
24812 implementation.
24813
24814 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24815 may be set to point to an alternative keytab file. Exim will pass this
24816 variable through from its own inherited environment when started as root or the
24817 Exim user. The keytab file needs to be readable by the Exim user.
24818 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24819 environment variable.  In practice, for those releases, the Cyrus authenticator
24820 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24821 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24822
24823
24824 .section "Using cyrus_sasl as a server" "SECID178"
24825 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24826 (on a successful authentication) into &$auth1$&. For compatibility with
24827 previous releases of Exim, the username is also placed in &$1$&. However, the
24828 use of this variable for this purpose is now deprecated, as it can lead to
24829 confusion in string expansions that also use numeric variables for other
24830 things.
24831
24832
24833 .option server_hostname cyrus_sasl string&!! "see below"
24834 This option selects the hostname that is used when communicating with the
24835 library. The default value is &`$primary_hostname`&. It is up to the underlying
24836 SASL plug-in what it does with this data.
24837
24838
24839 .option server_mech cyrus_sasl string "see below"
24840 This option selects the authentication mechanism this driver should use. The
24841 default is the value of the generic &%public_name%& option. This option allows
24842 you to use a different underlying mechanism from the advertised name. For
24843 example:
24844 .code
24845 sasl:
24846   driver = cyrus_sasl
24847   public_name = X-ANYTHING
24848   server_mech = CRAM-MD5
24849   server_set_id = $auth1
24850 .endd
24851
24852 .option server_realm cyrus_sasl string&!! unset
24853 This specifies the SASL realm that the server claims to be in.
24854
24855
24856 .option server_service cyrus_sasl string &`smtp`&
24857 This is the SASL service that the server claims to implement.
24858
24859
24860 For straightforward cases, you do not need to set any of the authenticator's
24861 private options. All you need to do is to specify an appropriate mechanism as
24862 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24863 PLAIN, you could have two authenticators as follows:
24864 .code
24865 sasl_cram_md5:
24866   driver = cyrus_sasl
24867   public_name = CRAM-MD5
24868   server_set_id = $auth1
24869
24870 sasl_plain:
24871   driver = cyrus_sasl
24872   public_name = PLAIN
24873   server_set_id = $auth2
24874 .endd
24875 Cyrus SASL does implement the LOGIN authentication method, even though it is
24876 not a standard method. It is disabled by default in the source distribution,
24877 but it is present in many binary distributions.
24878 .ecindex IIDcyrauth1
24879 .ecindex IIDcyrauth2
24880
24881
24882
24883
24884 . ////////////////////////////////////////////////////////////////////////////
24885 . ////////////////////////////////////////////////////////////////////////////
24886 .chapter "The dovecot authenticator" "CHAPdovecot"
24887 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24888 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24889 This authenticator is an interface to the authentication facility of the
24890 Dovecot POP/IMAP server, which can support a number of authentication methods.
24891 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24892 to use the same mechanisms for SMTP authentication. This is a server
24893 authenticator only. There is only one option:
24894
24895 .option server_socket dovecot string unset
24896
24897 This option must specify the socket that is the interface to Dovecot
24898 authentication. The &%public_name%& option must specify an authentication
24899 mechanism that Dovecot is configured to support. You can have several
24900 authenticators for different mechanisms. For example:
24901 .code
24902 dovecot_plain:
24903   driver = dovecot
24904   public_name = PLAIN
24905   server_socket = /var/run/dovecot/auth-client
24906   server_set_id = $auth2
24907
24908 dovecot_ntlm:
24909   driver = dovecot
24910   public_name = NTLM
24911   server_socket = /var/run/dovecot/auth-client
24912   server_set_id = $auth1
24913 .endd
24914 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24915 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24916 option is passed in the Dovecot authentication command. If, for a TLS
24917 connection, a client certificate has been verified, the &"valid-client-cert"&
24918 option is passed. When authentication succeeds, the identity of the user
24919 who authenticated is placed in &$auth1$&.
24920 .ecindex IIDdcotauth1
24921 .ecindex IIDdcotauth2
24922
24923
24924 . ////////////////////////////////////////////////////////////////////////////
24925 . ////////////////////////////////////////////////////////////////////////////
24926 .chapter "The gsasl authenticator" "CHAPgsasl"
24927 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24928 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24929 .cindex "authentication" "GNU SASL"
24930 .cindex "authentication" "SASL"
24931 .cindex "authentication" "EXTERNAL"
24932 .cindex "authentication" "ANONYMOUS"
24933 .cindex "authentication" "PLAIN"
24934 .cindex "authentication" "LOGIN"
24935 .cindex "authentication" "DIGEST-MD5"
24936 .cindex "authentication" "CRAM-MD5"
24937 .cindex "authentication" "SCRAM-SHA-1"
24938 The &(gsasl)& authenticator provides server integration for the GNU SASL
24939 library and the mechanisms it provides.  This is new as of the 4.80 release
24940 and there are a few areas where the library does not let Exim smoothly
24941 scale to handle future authentication mechanisms, so no guarantee can be
24942 made that any particular new authentication mechanism will be supported
24943 without code changes in Exim.
24944
24945
24946 .option server_channelbinding gsasl boolean false
24947 Some authentication mechanisms are able to use external context at both ends
24948 of the session to bind the authentication to that context, and fail the
24949 authentication process if that context differs.  Specifically, some TLS
24950 ciphersuites can provide identifying information about the cryptographic
24951 context.
24952
24953 This means that certificate identity and verification becomes a non-issue,
24954 as a man-in-the-middle attack will cause the correct client and server to
24955 see different identifiers and authentication will fail.
24956
24957 This is currently only supported when using the GnuTLS library.  This is
24958 only usable by mechanisms which support "channel binding"; at time of
24959 writing, that's the SCRAM family.
24960
24961 This defaults off to ensure smooth upgrade across Exim releases, in case
24962 this option causes some clients to start failing.  Some future release
24963 of Exim may switch the default to be true.
24964
24965
24966 .option server_hostname gsasl string&!! "see below"
24967 This option selects the hostname that is used when communicating with the
24968 library. The default value is &`$primary_hostname`&.
24969 Some mechanisms will use this data.
24970
24971
24972 .option server_mech gsasl string "see below"
24973 This option selects the authentication mechanism this driver should use. The
24974 default is the value of the generic &%public_name%& option. This option allows
24975 you to use a different underlying mechanism from the advertised name. For
24976 example:
24977 .code
24978 sasl:
24979   driver = gsasl
24980   public_name = X-ANYTHING
24981   server_mech = CRAM-MD5
24982   server_set_id = $auth1
24983 .endd
24984
24985
24986 .option server_password gsasl string&!! unset
24987 Various mechanisms need access to the cleartext password on the server, so
24988 that proof-of-possession can be demonstrated on the wire, without sending
24989 the password itself.
24990
24991 The data available for lookup varies per mechanism.
24992 In all cases, &$auth1$& is set to the &'authentication id'&.
24993 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24994 if available, else the empty string.
24995 The &$auth3$& variable will always be the &'realm'& if available,
24996 else the empty string.
24997
24998 A forced failure will cause authentication to defer.
24999
25000 If using this option, it may make sense to set the &%server_condition%&
25001 option to be simply "true".
25002
25003
25004 .option server_realm gsasl string&!! unset
25005 This specifies the SASL realm that the server claims to be in.
25006 Some mechanisms will use this data.
25007
25008
25009 .option server_scram_iter gsasl string&!! unset
25010 This option provides data for the SCRAM family of mechanisms.
25011 &$auth1$& is not available at evaluation time.
25012 (This may change, as we receive feedback on use)
25013
25014
25015 .option server_scram_salt gsasl string&!! unset
25016 This option provides data for the SCRAM family of mechanisms.
25017 &$auth1$& is not available at evaluation time.
25018 (This may change, as we receive feedback on use)
25019
25020
25021 .option server_service gsasl string &`smtp`&
25022 This is the SASL service that the server claims to implement.
25023 Some mechanisms will use this data.
25024
25025
25026 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25027 .vindex "&$auth1$&, &$auth2$&, etc"
25028 These may be set when evaluating specific options, as detailed above.
25029 They will also be set when evaluating &%server_condition%&.
25030
25031 Unless otherwise stated below, the &(gsasl)& integration will use the following
25032 meanings for these variables:
25033
25034 .ilist
25035 .vindex "&$auth1$&"
25036 &$auth1$&: the &'authentication id'&
25037 .next
25038 .vindex "&$auth2$&"
25039 &$auth2$&: the &'authorization id'&
25040 .next
25041 .vindex "&$auth3$&"
25042 &$auth3$&: the &'realm'&
25043 .endlist
25044
25045 On a per-mechanism basis:
25046
25047 .ilist
25048 .cindex "authentication" "EXTERNAL"
25049 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25050 the &%server_condition%& option must be present.
25051 .next
25052 .cindex "authentication" "ANONYMOUS"
25053 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25054 the &%server_condition%& option must be present.
25055 .next
25056 .cindex "authentication" "GSSAPI"
25057 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25058 &$auth2$& will be set to the &'authorization id'&,
25059 the &%server_condition%& option must be present.
25060 .endlist
25061
25062 An &'anonymous token'& is something passed along as an unauthenticated
25063 identifier; this is analogous to FTP anonymous authentication passing an
25064 email address, or software-identifier@, as the "password".
25065
25066
25067 An example showing the password having the realm specified in the callback
25068 and demonstrating a Cyrus SASL to GSASL migration approach is:
25069 .code
25070 gsasl_cyrusless_crammd5:
25071   driver = gsasl
25072   public_name = CRAM-MD5
25073   server_realm = imap.example.org
25074   server_password = ${lookup{$auth1:$auth3:userPassword}\
25075                     dbmjz{/etc/sasldb2}{$value}fail}
25076   server_set_id = ${quote:$auth1}
25077   server_condition = yes
25078 .endd
25079
25080
25081 . ////////////////////////////////////////////////////////////////////////////
25082 . ////////////////////////////////////////////////////////////////////////////
25083
25084 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25085 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25086 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25087 .cindex "authentication" "GSSAPI"
25088 .cindex "authentication" "Kerberos"
25089 The &(heimdal_gssapi)& authenticator provides server integration for the
25090 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25091 reliably.
25092
25093 .option server_hostname heimdal_gssapi string&!! "see below"
25094 This option selects the hostname that is used, with &%server_service%&,
25095 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25096 identifier.  The default value is &`$primary_hostname`&.
25097
25098 .option server_keytab heimdal_gssapi string&!! unset
25099 If set, then Heimdal will not use the system default keytab (typically
25100 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25101 The value should be a pathname, with no &"file:"& prefix.
25102
25103 .option server_service heimdal_gssapi string&!! "smtp"
25104 This option specifies the service identifier used, in conjunction with
25105 &%server_hostname%&, for building the identifer for finding credentials
25106 from the keytab.
25107
25108
25109 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25110 Beware that these variables will typically include a realm, thus will appear
25111 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25112 not verified, so a malicious client can set it to anything.
25113
25114 The &$auth1$& field should be safely trustable as a value from the Key
25115 Distribution Center.  Note that these are not quite email addresses.
25116 Each identifier is for a role, and so the left-hand-side may include a
25117 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25118
25119 .vindex "&$auth1$&, &$auth2$&, etc"
25120 .ilist
25121 .vindex "&$auth1$&"
25122 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25123 .next
25124 .vindex "&$auth2$&"
25125 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25126 authentication.  If that was empty, this will also be set to the
25127 GSS Display Name.
25128 .endlist
25129
25130
25131 . ////////////////////////////////////////////////////////////////////////////
25132 . ////////////////////////////////////////////////////////////////////////////
25133
25134 .chapter "The spa authenticator" "CHAPspa"
25135 .scindex IIDspaauth1 "&(spa)& authenticator"
25136 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25137 .cindex "authentication" "Microsoft Secure Password"
25138 .cindex "authentication" "NTLM"
25139 .cindex "Microsoft Secure Password Authentication"
25140 .cindex "NTLM authentication"
25141 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25142 Password Authentication'& mechanism,
25143 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25144 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25145 taken from the Samba project (&url(http://www.samba.org)). The code for the
25146 server side was subsequently contributed by Tom Kistner. The mechanism works as
25147 follows:
25148
25149 .ilist
25150 After the AUTH command has been accepted, the client sends an SPA
25151 authentication request based on the user name and optional domain.
25152 .next
25153 The server sends back a challenge.
25154 .next
25155 The client builds a challenge response which makes use of the user's password
25156 and sends it to the server, which then accepts or rejects it.
25157 .endlist
25158
25159 Encryption is used to protect the password in transit.
25160
25161
25162
25163 .section "Using spa as a server" "SECID179"
25164 .cindex "options" "&(spa)& authenticator (server)"
25165 The &(spa)& authenticator has just one server option:
25166
25167 .option server_password spa string&!! unset
25168 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25169 This option is expanded, and the result must be the cleartext password for the
25170 authenticating user, whose name is at this point in &$auth1$&. For
25171 compatibility with previous releases of Exim, the user name is also placed in
25172 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25173 it can lead to confusion in string expansions that also use numeric variables
25174 for other things. For example:
25175 .code
25176 spa:
25177   driver = spa
25178   public_name = NTLM
25179   server_password = \
25180     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25181 .endd
25182 If the expansion is forced to fail, authentication fails. Any other expansion
25183 failure causes a temporary error code to be returned.
25184
25185
25186
25187
25188
25189 .section "Using spa as a client" "SECID180"
25190 .cindex "options" "&(spa)& authenticator (client)"
25191 The &(spa)& authenticator has the following client options:
25192
25193
25194
25195 .option client_domain spa string&!! unset
25196 This option specifies an optional domain for the authentication.
25197
25198
25199 .option client_password spa string&!! unset
25200 This option specifies the user's password, and must be set.
25201
25202
25203 .option client_username spa string&!! unset
25204 This option specifies the user name, and must be set. Here is an example of a
25205 configuration of this authenticator for use with the mail servers at
25206 &'msn.com'&:
25207 .code
25208 msn:
25209   driver = spa
25210   public_name = MSN
25211   client_username = msn/msn_username
25212   client_password = msn_plaintext_password
25213   client_domain = DOMAIN_OR_UNSET
25214 .endd
25215 .ecindex IIDspaauth1
25216 .ecindex IIDspaauth2
25217
25218
25219
25220
25221
25222 . ////////////////////////////////////////////////////////////////////////////
25223 . ////////////////////////////////////////////////////////////////////////////
25224
25225 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25226          "Encrypted SMTP connections"
25227 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25228 .scindex IIDencsmtp2 "SMTP" "encryption"
25229 .cindex "TLS" "on SMTP connection"
25230 .cindex "OpenSSL"
25231 .cindex "GnuTLS"
25232 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25233 Sockets Layer), is implemented by making use of the OpenSSL library or the
25234 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25235 cryptographic code in the Exim distribution itself for implementing TLS. In
25236 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25237 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25238 You also need to understand the basic concepts of encryption at a managerial
25239 level, and in particular, the way that public keys, private keys, and
25240 certificates are used.
25241
25242 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25243 connection is established, the client issues a STARTTLS command. If the
25244 server accepts this, the client and the server negotiate an encryption
25245 mechanism. If the negotiation succeeds, the data that subsequently passes
25246 between them is encrypted.
25247
25248 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25249 and if so, what cipher suite is in use, whether the client supplied a
25250 certificate, and whether or not that certificate was verified. This makes it
25251 possible for an Exim server to deny or accept certain commands based on the
25252 encryption state.
25253
25254 &*Warning*&: Certain types of firewall and certain anti-virus products can
25255 disrupt TLS connections. You need to turn off SMTP scanning for these products
25256 in order to get TLS to work.
25257
25258
25259
25260 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25261          "SECID284"
25262 .cindex "ssmtp protocol"
25263 .cindex "smtps protocol"
25264 .cindex "SMTP" "ssmtp protocol"
25265 .cindex "SMTP" "smtps protocol"
25266 Early implementations of encrypted SMTP used a different TCP port from normal
25267 SMTP, and expected an encryption negotiation to start immediately, instead of
25268 waiting for a STARTTLS command from the client using the standard SMTP
25269 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25270 allocated for this purpose.
25271
25272 This approach was abandoned when encrypted SMTP was standardized, but there are
25273 still some legacy clients that use it. Exim supports these clients by means of
25274 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25275 numbers; the most common use is expected to be:
25276 .code
25277 tls_on_connect_ports = 465
25278 .endd
25279 The port numbers specified by this option apply to all SMTP connections, both
25280 via the daemon and via &'inetd'&. You still need to specify all the ports that
25281 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25282 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25283 an extra port &-- rather, it specifies different behaviour on a port that is
25284 defined elsewhere.
25285
25286 There is also a &%-tls-on-connect%& command line option. This overrides
25287 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25288
25289
25290
25291
25292
25293
25294 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25295 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25296 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25297 followed later, when the first versions of GnuTLS were released. To build Exim
25298 to use GnuTLS, you need to set
25299 .code
25300 USE_GNUTLS=yes
25301 .endd
25302 in Local/Makefile, in addition to
25303 .code
25304 SUPPORT_TLS=yes
25305 .endd
25306 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25307 include files and libraries for GnuTLS can be found.
25308
25309 There are some differences in usage when using GnuTLS instead of OpenSSL:
25310
25311 .ilist
25312 The &%tls_verify_certificates%& option must contain the name of a file, not the
25313 name of a directory (for OpenSSL it can be either).
25314 .next
25315 The default value for &%tls_dhparam%& differs for historical reasons.
25316 .next
25317 .vindex "&$tls_in_peerdn$&"
25318 .vindex "&$tls_out_peerdn$&"
25319 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25320 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25321 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25322 .next
25323 OpenSSL identifies cipher suites using hyphens as separators, for example:
25324 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25325 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25326 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25327 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25328 to handle its own older variants) when processing lists of cipher suites in the
25329 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25330 option).
25331 .next
25332 The &%tls_require_ciphers%& options operate differently, as described in the
25333 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25334 .next
25335 .new
25336 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25337 When using OpenSSL, this option is ignored.
25338 (If an API is found to let OpenSSL be configured in this way,
25339 let the Exim Maintainers know and we'll likely use it).
25340 .wen
25341 .next
25342 Some other recently added features may only be available in one or the other.
25343 This should be documented with the feature.  If the documentation does not
25344 explicitly state that the feature is infeasible in the other TLS
25345 implementation, then patches are welcome.
25346 .endlist
25347
25348
25349 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25350 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25351 an explicit path; if the latter, then the text about generation still applies,
25352 but not the chosen filename.
25353 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25354 See the documentation of &%tls_dhparam%& for more information.
25355
25356 GnuTLS uses D-H parameters that may take a substantial amount of time
25357 to compute. It is unreasonable to re-compute them for every TLS session.
25358 Therefore, Exim keeps this data in a file in its spool directory, called
25359 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25360 of bits requested.
25361 The file is owned by the Exim user and is readable only by
25362 its owner. Every Exim process that start up GnuTLS reads the D-H
25363 parameters from this file. If the file does not exist, the first Exim process
25364 that needs it computes the data and writes it to a temporary file which is
25365 renamed once it is complete. It does not matter if several Exim processes do
25366 this simultaneously (apart from wasting a few resources). Once a file is in
25367 place, new Exim processes immediately start using it.
25368
25369 For maximum security, the parameters that are stored in this file should be
25370 recalculated periodically, the frequency depending on your paranoia level.
25371 If you are avoiding using the fixed D-H primes published in RFCs, then you
25372 are concerned about some advanced attacks and will wish to do this; if you do
25373 not regenerate then you might as well stick to the standard primes.
25374
25375 Arranging this is easy in principle; just delete the file when you want new
25376 values to be computed. However, there may be a problem. The calculation of new
25377 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25378 If the system is not very active, &_/dev/random_& may delay returning data
25379 until enough randomness (entropy) is available. This may cause Exim to hang for
25380 a substantial amount of time, causing timeouts on incoming connections.
25381
25382 The solution is to generate the parameters externally to Exim. They are stored
25383 in &_gnutls-params-N_& in PEM format, which means that they can be
25384 generated externally using the &(certtool)& command that is part of GnuTLS.
25385
25386 To replace the parameters with new ones, instead of deleting the file
25387 and letting Exim re-create it, you can generate new parameters using
25388 &(certtool)& and, when this has been done, replace Exim's cache file by
25389 renaming. The relevant commands are something like this:
25390 .code
25391 # ls
25392 [ look for file; assume gnutls-params-2236 is the most recent ]
25393 # rm -f new-params
25394 # touch new-params
25395 # chown exim:exim new-params
25396 # chmod 0600 new-params
25397 # certtool --generate-dh-params --bits 2236 >>new-params
25398 # openssl dhparam -noout -text -in new-params | head
25399 [ check the first line, make sure it's not more than 2236;
25400   if it is, then go back to the start ("rm") and repeat
25401   until the size generated is at most the size requested ]
25402 # chmod 0400 new-params
25403 # mv new-params gnutls-params-2236
25404 .endd
25405 If Exim never has to generate the parameters itself, the possibility of
25406 stalling is removed.
25407
25408 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25409 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25410 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25411 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25412 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25413 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25414 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25415 which applies to all D-H usage, client or server.  If the value returned by
25416 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25417 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25418 limit, which is still much higher than Exim historically used.
25419
25420 The filename and bits used will change as the GnuTLS maintainers change the
25421 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25422 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25423 2432 bits, while NSS is limited to 2236 bits.
25424
25425 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25426 increase the chance of the generated prime actually being within acceptable
25427 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25428 procedure above.  There is no sane procedure available to Exim to double-check
25429 the size of the generated prime, so it might still be too large.
25430
25431
25432 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25433 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25434 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25435 There is a function in the OpenSSL library that can be passed a list of cipher
25436 suites before the cipher negotiation takes place. This specifies which ciphers
25437 are acceptable. The list is colon separated and may contain names like
25438 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25439 directly to this function call.
25440 Many systems will install the OpenSSL manual-pages, so you may have
25441 &'ciphers(1)'& available to you.
25442 The following quotation from the OpenSSL
25443 documentation specifies what forms of item are allowed in the cipher string:
25444
25445 .ilist
25446 It can consist of a single cipher suite such as RC4-SHA.
25447 .next
25448 It can represent a list of cipher suites containing a certain algorithm,
25449 or cipher suites of a certain type. For example SHA1 represents all
25450 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25451 SSL v3 algorithms.
25452 .next
25453 Lists of cipher suites can be combined in a single cipher string using
25454 the + character. This is used as a logical and operation. For example
25455 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25456 algorithms.
25457 .endlist
25458
25459 Each cipher string can be optionally preceded by one of the characters &`!`&,
25460 &`-`& or &`+`&.
25461 .ilist
25462 If &`!`& is used, the ciphers are permanently deleted from the list. The
25463 ciphers deleted can never reappear in the list even if they are explicitly
25464 stated.
25465 .next
25466 If &`-`& is used, the ciphers are deleted from the list, but some or all
25467 of the ciphers can be added again by later options.
25468 .next
25469 If &`+`& is used, the ciphers are moved to the end of the list. This
25470 option does not add any new ciphers; it just moves matching existing ones.
25471 .endlist
25472
25473 If none of these characters is present, the string is interpreted as
25474 a list of ciphers to be appended to the current preference list. If the list
25475 includes any ciphers already present they will be ignored: that is, they will
25476 not be moved to the end of the list.
25477 .endlist
25478
25479 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25480 string:
25481 .code
25482 # note single-quotes to get ! past any shell history expansion
25483 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25484 .endd
25485
25486 This example will let the library defaults be permitted on the MX port, where
25487 there's probably no identity verification anyway, but ups the ante on the
25488 submission ports where the administrator might have some influence on the
25489 choice of clients used:
25490 .code
25491 # OpenSSL variant; see man ciphers(1)
25492 tls_require_ciphers = ${if =={$received_port}{25}\
25493                            {DEFAULT}\
25494                            {HIGH:!MD5:!SHA1}}
25495 .endd
25496
25497
25498
25499 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25500          "SECTreqciphgnu"
25501 .cindex "GnuTLS" "specifying parameters for"
25502 .cindex "TLS" "specifying ciphers (GnuTLS)"
25503 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25504 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25505 .cindex "TLS" "specifying protocols (GnuTLS)"
25506 .cindex "TLS" "specifying priority string (GnuTLS)"
25507 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25508 The GnuTLS library allows the caller to provide a "priority string", documented
25509 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25510 ciphersuite specification in OpenSSL.
25511
25512 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25513
25514 The &%tls_require_ciphers%& option is available both as an global option,
25515 controlling how Exim behaves as a server, and also as an option of the
25516 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25517 the value is string expanded.  The resulting string is not an Exim list and
25518 the string is given to the GnuTLS library, so that Exim does not need to be
25519 aware of future feature enhancements of GnuTLS.
25520
25521 Documentation of the strings accepted may be found in the GnuTLS manual, under
25522 "Priority strings".  This is online as
25523 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25524 but beware that this relates to GnuTLS 3, which may be newer than the version
25525 installed on your system.  If you are using GnuTLS 3,
25526 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25527 on that site can be used to test a given string.
25528
25529 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25530 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25531 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25532
25533 This example will let the library defaults be permitted on the MX port, where
25534 there's probably no identity verification anyway, and lowers security further
25535 by increasing compatibility; but this ups the ante on the submission ports
25536 where the administrator might have some influence on the choice of clients
25537 used:
25538 .code
25539 # GnuTLS variant
25540 tls_require_ciphers = ${if =={$received_port}{25}\
25541                            {NORMAL:%COMPAT}\
25542                            {SECURE128}}
25543 .endd
25544
25545
25546 .section "Configuring an Exim server to use TLS" "SECID182"
25547 .cindex "TLS" "configuring an Exim server"
25548 When Exim has been built with TLS support, it advertises the availability of
25549 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25550 but not to any others. The default value of this option is unset, which means
25551 that STARTTLS is not advertised at all. This default is chosen because you
25552 need to set some other options in order to make TLS available, and also it is
25553 sensible for systems that want to use TLS only as a client.
25554
25555 If a client issues a STARTTLS command and there is some configuration
25556 problem in the server, the command is rejected with a 454 error. If the client
25557 persists in trying to issue SMTP commands, all except QUIT are rejected
25558 with the error
25559 .code
25560 554 Security failure
25561 .endd
25562 If a STARTTLS command is issued within an existing TLS session, it is
25563 rejected with a 554 error code.
25564
25565 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25566 match some hosts. You can, of course, set it to * to match all hosts.
25567 However, this is not all you need to do. TLS sessions to a server won't work
25568 without some further configuration at the server end.
25569
25570 It is rumoured that all existing clients that support TLS/SSL use RSA
25571 encryption. To make this work you need to set, in the server,
25572 .code
25573 tls_certificate = /some/file/name
25574 tls_privatekey = /some/file/name
25575 .endd
25576 These options are, in fact, expanded strings, so you can make them depend on
25577 the identity of the client that is connected if you wish. The first file
25578 contains the server's X509 certificate, and the second contains the private key
25579 that goes with it. These files need to be readable by the Exim user, and must
25580 always be given as full path names. They can be the same file if both the
25581 certificate and the key are contained within it. If &%tls_privatekey%& is not
25582 set, or if its expansion is forced to fail or results in an empty string, this
25583 is assumed to be the case. The certificate file may also contain intermediate
25584 certificates that need to be sent to the client to enable it to authenticate
25585 the server's certificate.
25586
25587 If you do not understand about certificates and keys, please try to find a
25588 source of this background information, which is not Exim-specific. (There are a
25589 few comments below in section &<<SECTcerandall>>&.)
25590
25591 &*Note*&: These options do not apply when Exim is operating as a client &--
25592 they apply only in the case of a server. If you need to use a certificate in an
25593 Exim client, you must set the options of the same names in an &(smtp)&
25594 transport.
25595
25596 With just these options, an Exim server will be able to use TLS. It does not
25597 require the client to have a certificate (but see below for how to insist on
25598 this). There is one other option that may be needed in other situations. If
25599 .code
25600 tls_dhparam = /some/file/name
25601 .endd
25602 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25603 with the parameters contained in the file.
25604 Set this to &`none`& to disable use of DH entirely, by making no prime
25605 available:
25606 .code
25607 tls_dhparam = none
25608 .endd
25609 This may also be set to a string identifying a standard prime to be used for
25610 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25611 used is &`ike23`&.  There are a few standard primes available, see the
25612 documetnation for &%tls_dhparam%& for the complete list.
25613
25614 See the command
25615 .code
25616 openssl dhparam
25617 .endd
25618 for a way of generating file data.
25619
25620 The strings supplied for these three options are expanded every time a client
25621 host connects. It is therefore possible to use different certificates and keys
25622 for different hosts, if you so wish, by making use of the client's IP address
25623 in &$sender_host_address$& to control the expansion. If a string expansion is
25624 forced to fail, Exim behaves as if the option is not set.
25625
25626 .cindex "cipher" "logging"
25627 .cindex "log" "TLS cipher"
25628 .vindex "&$tls_in_cipher$&"
25629 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25630 an incoming TLS connection. It is included in the &'Received:'& header of an
25631 incoming message (by default &-- you can, of course, change this), and it is
25632 also included in the log line that records a message's arrival, keyed by
25633 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25634 condition can be used to test for specific cipher suites in ACLs.
25635
25636 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25637 can check the name of the cipher suite and vary their actions accordingly. The
25638 cipher suite names vary, depending on which TLS library is being used. For
25639 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25640 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25641 documentation for more details.
25642
25643 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25644 (again depending on the &%tls_cipher%& log selector).
25645
25646
25647 .section "Requesting and verifying client certificates" "SECID183"
25648 .cindex "certificate" "verification of client"
25649 .cindex "TLS" "client certificate verification"
25650 If you want an Exim server to request a certificate when negotiating a TLS
25651 session with a client, you must set either &%tls_verify_hosts%& or
25652 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25653 apply to all TLS connections. For any host that matches one of these options,
25654 Exim requests a certificate as part of the setup of the TLS session. The
25655 contents of the certificate are verified by comparing it with a list of
25656 expected certificates. These must be available in a file or,
25657 for OpenSSL only (not GnuTLS), a directory, identified by
25658 &%tls_verify_certificates%&.
25659
25660 A file can contain multiple certificates, concatenated end to end. If a
25661 directory is used
25662 (OpenSSL only),
25663 each certificate must be in a separate file, with a name (or a symbolic link)
25664 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25665 certificate. You can compute the relevant hash by running the command
25666 .code
25667 openssl x509 -hash -noout -in /cert/file
25668 .endd
25669 where &_/cert/file_& contains a single certificate.
25670
25671 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25672 what happens if the client does not supply a certificate, or if the certificate
25673 does not match any of the certificates in the collection named by
25674 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25675 attempt to set up a TLS session is aborted, and the incoming connection is
25676 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25677 session continues. ACLs that run for subsequent SMTP commands can detect the
25678 fact that no certificate was verified, and vary their actions accordingly. For
25679 example, you can insist on a certificate before accepting a message for
25680 relaying, but not when the message is destined for local delivery.
25681
25682 .vindex "&$tls_in_peerdn$&"
25683 When a client supplies a certificate (whether it verifies or not), the value of
25684 the Distinguished Name of the certificate is made available in the variable
25685 &$tls_in_peerdn$& during subsequent processing of the message.
25686
25687 .cindex "log" "distinguished name"
25688 Because it is often a long text string, it is not included in the log line or
25689 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25690 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25691 &%received_header_text%& to change the &'Received:'& header. When no
25692 certificate is supplied, &$tls_in_peerdn$& is empty.
25693
25694
25695 .section "Revoked certificates" "SECID184"
25696 .cindex "TLS" "revoked certificates"
25697 .cindex "revocation list"
25698 .cindex "certificate" "revocation list"
25699 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25700 certificates are revoked. If you have such a list, you can pass it to an Exim
25701 server using the global option called &%tls_crl%& and to an Exim client using
25702 an identically named option for the &(smtp)& transport. In each case, the value
25703 of the option is expanded and must then be the name of a file that contains a
25704 CRL in PEM format.
25705
25706
25707 .section "Configuring an Exim client to use TLS" "SECID185"
25708 .cindex "cipher" "logging"
25709 .cindex "log" "TLS cipher"
25710 .cindex "log" "distinguished name"
25711 .cindex "TLS" "configuring an Exim client"
25712 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25713 deliveries as well as to incoming, the latter one causing logging of the
25714 server certificate's DN. The remaining client configuration for TLS is all
25715 within the &(smtp)& transport.
25716
25717 It is not necessary to set any options to have TLS work in the &(smtp)&
25718 transport. If Exim is built with TLS support, and TLS is advertised by a
25719 server, the &(smtp)& transport always tries to start a TLS session. However,
25720 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25721 transport) to a list of server hosts for which TLS should not be used.
25722
25723 If you do not want Exim to attempt to send messages unencrypted when an attempt
25724 to set up an encrypted connection fails in any way, you can set
25725 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25726 those hosts, delivery is always deferred if an encrypted connection cannot be
25727 set up. If there are any other hosts for the address, they are tried in the
25728 usual way.
25729
25730 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25731 the message unencrypted. It always does this if the response to STARTTLS is
25732 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25733 session after a success response code, what happens is controlled by the
25734 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25735 delivery to this host is deferred, and other hosts (if available) are tried. If
25736 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25737 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25738 negotiation fails, Exim closes the current connection (because it is in an
25739 unknown state), opens a new one to the same host, and then tries the delivery
25740 unencrypted.
25741
25742 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25743 transport provide the client with a certificate, which is passed to the server
25744 if it requests it. If the server is Exim, it will request a certificate only if
25745 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25746
25747 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25748 must name a file or,
25749 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25750 expected server certificates. The client verifies the server's certificate
25751 against this collection, taking into account any revoked certificates that are
25752 in the list defined by &%tls_crl%&.
25753
25754 If
25755 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25756 list of permitted cipher suites. If either of these checks fails, delivery to
25757 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25758 alternative hosts, if any.
25759
25760  &*Note*&:
25761 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25762 is operating as a client. Exim does not assume that a server certificate (set
25763 by the global options of the same name) should also be used when operating as a
25764 client.
25765
25766 .vindex "&$host$&"
25767 .vindex "&$host_address$&"
25768 All the TLS options in the &(smtp)& transport are expanded before use, with
25769 &$host$& and &$host_address$& containing the name and address of the server to
25770 which the client is connected. Forced failure of an expansion causes Exim to
25771 behave as if the relevant option were unset.
25772
25773 .vindex &$tls_out_bits$&
25774 .vindex &$tls_out_cipher$&
25775 .vindex &$tls_out_peerdn$&
25776 .vindex &$tls_out_sni$&
25777 Before an SMTP connection is established, the
25778 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25779 variables are emptied. (Until the first connection, they contain the values
25780 that were set when the message was received.) If STARTTLS is subsequently
25781 successfully obeyed, these variables are set to the relevant values for the
25782 outgoing connection.
25783
25784
25785
25786 .section "Use of TLS Server Name Indication" "SECTtlssni"
25787 .cindex "TLS" "Server Name Indication"
25788 .vindex "&$tls_in_sni$&"
25789 .oindex "&%tls_in_sni%&"
25790 With TLS1.0 or above, there is an extension mechanism by which extra
25791 information can be included at various points in the protocol.  One of these
25792 extensions, documented in RFC 6066 (and before that RFC 4366) is
25793 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25794 client in the initial handshake, so that the server can examine the servername
25795 within and possibly choose to use different certificates and keys (and more)
25796 for this session.
25797
25798 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25799 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25800 address.
25801
25802 With SMTP to MX, there are the same problems here as in choosing the identity
25803 against which to validate a certificate: you can't rely on insecure DNS to
25804 provide the identity which you then cryptographically verify.  So this will
25805 be of limited use in that environment.
25806
25807 With SMTP to Submission, there is a well-defined hostname which clients are
25808 connecting to and can validate certificates against.  Thus clients &*can*&
25809 choose to include this information in the TLS negotiation.  If this becomes
25810 wide-spread, then hosters can choose to present different certificates to
25811 different clients.  Or even negotiate different cipher suites.
25812
25813 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25814 if not empty, will be sent on a TLS session as part of the handshake.  There's
25815 nothing more to it.  Choosing a sensible value not derived insecurely is the
25816 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25817 for the lifetime of the client connection (including during authentication).
25818
25819 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25820 received from a client.
25821 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25822
25823 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25824 option (prior to expansion) then the following options will be re-expanded
25825 during TLS session handshake, to permit alternative values to be chosen:
25826
25827 .ilist
25828 .vindex "&%tls_certificate%&"
25829 &%tls_certificate%&
25830 .next
25831 .vindex "&%tls_crl%&"
25832 &%tls_crl%&
25833 .next
25834 .vindex "&%tls_privatekey%&"
25835 &%tls_privatekey%&
25836 .next
25837 .vindex "&%tls_verify_certificates%&"
25838 &%tls_verify_certificates%&
25839 .endlist
25840
25841 Great care should be taken to deal with matters of case, various injection
25842 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25843 can always be referenced; it is important to remember that &$tls_sni$& is
25844 arbitrary unverified data provided prior to authentication.
25845
25846 The Exim developers are proceeding cautiously and so far no other TLS options
25847 are re-expanded.
25848
25849 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25850 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25851 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25852 see &`-servername`& in the output, then OpenSSL has support.
25853
25854 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25855 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25856 built, then you have SNI support).
25857
25858
25859
25860 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25861          "SECTmulmessam"
25862 .cindex "multiple SMTP deliveries with TLS"
25863 .cindex "TLS" "multiple message deliveries"
25864 Exim sends multiple messages down the same TCP/IP connection by starting up
25865 an entirely new delivery process for each message, passing the socket from
25866 one process to the next. This implementation does not fit well with the use
25867 of TLS, because there is quite a lot of state information associated with a TLS
25868 connection, not just a socket identification. Passing all the state information
25869 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25870 session before passing the socket to a new process. The new process may then
25871 try to start a new TLS session, and if successful, may try to re-authenticate
25872 if AUTH is in use, before sending the next message.
25873
25874 The RFC is not clear as to whether or not an SMTP session continues in clear
25875 after TLS has been shut down, or whether TLS may be restarted again later, as
25876 just described. However, if the server is Exim, this shutdown and
25877 reinitialization works. It is not known which (if any) other servers operate
25878 successfully if the client closes a TLS session and continues with unencrypted
25879 SMTP, but there are certainly some that do not work. For such servers, Exim
25880 should not pass the socket to another process, because the failure of the
25881 subsequent attempt to use it would cause Exim to record a temporary host error,
25882 and delay other deliveries to that host.
25883
25884 To test for this case, Exim sends an EHLO command to the server after
25885 closing down the TLS session. If this fails in any way, the connection is
25886 closed instead of being passed to a new delivery process, but no retry
25887 information is recorded.
25888
25889 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25890 &(smtp)& transport to match those hosts for which Exim should not pass
25891 connections to new processes if TLS has been used.
25892
25893
25894
25895
25896 .section "Certificates and all that" "SECTcerandall"
25897 .cindex "certificate" "references to discussion"
25898 In order to understand fully how TLS works, you need to know about
25899 certificates, certificate signing, and certificate authorities. This is not the
25900 place to give a tutorial, especially as I do not know very much about it
25901 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25902 to Apache, currently at
25903 .display
25904 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25905 .endd
25906 Other parts of the &'modssl'& documentation are also helpful, and have
25907 links to further files.
25908 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25909 0-201-61598-3), contains both introductory and more in-depth descriptions.
25910 Some sample programs taken from the book are available from
25911 .display
25912 &url(http://www.rtfm.com/openssl-examples/)
25913 .endd
25914
25915
25916 .section "Certificate chains" "SECID186"
25917 The file named by &%tls_certificate%& may contain more than one
25918 certificate. This is useful in the case where the certificate that is being
25919 sent is validated by an intermediate certificate which the other end does
25920 not have. Multiple certificates must be in the correct order in the file.
25921 First the host's certificate itself, then the first intermediate
25922 certificate to validate the issuer of the host certificate, then the next
25923 intermediate certificate to validate the issuer of the first intermediate
25924 certificate, and so on, until finally (optionally) the root certificate.
25925 The root certificate must already be trusted by the recipient for
25926 validation to succeed, of course, but if it's not preinstalled, sending the
25927 root certificate along with the rest makes it available for the user to
25928 install if the receiving end is a client MUA that can interact with a user.
25929
25930
25931 .section "Self-signed certificates" "SECID187"
25932 .cindex "certificate" "self-signed"
25933 You can create a self-signed certificate using the &'req'& command provided
25934 with OpenSSL, like this:
25935 . ==== Do not shorten the duration here without reading and considering
25936 . ==== the text below.  Please leave it at 9999 days.
25937 .code
25938 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25939             -days 9999 -nodes
25940 .endd
25941 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25942 delimited and so can be identified independently. The &%-days%& option
25943 specifies a period for which the certificate is valid. The &%-nodes%& option is
25944 important: if you do not set it, the key is encrypted with a passphrase
25945 that you are prompted for, and any use that is made of the key causes more
25946 prompting for the passphrase. This is not helpful if you are going to use
25947 this certificate and key in an MTA, where prompting is not possible.
25948
25949 . ==== I expect to still be working 26 years from now.  The less technical
25950 . ==== debt I create, in terms of storing up trouble for my later years, the
25951 . ==== happier I will be then.  We really have reached the point where we
25952 . ==== should start, at the very least, provoking thought and making folks
25953 . ==== pause before proceeding, instead of leaving all the fixes until two
25954 . ==== years before 2^31 seconds after the 1970 Unix epoch.
25955 . ==== -pdp, 2012
25956 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
25957 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
25958 the above command might produce a date in the past.  Think carefully about
25959 the lifetime of the systems you're deploying, and either reduce the duration
25960 of the certificate or reconsider your platform deployment.  (At time of
25961 writing, reducing the duration is the most likely choice, but the inexorable
25962 progression of time takes us steadily towards an era where this will not
25963 be a sensible resolution).
25964
25965 A self-signed certificate made in this way is sufficient for testing, and
25966 may be adequate for all your requirements if you are mainly interested in
25967 encrypting transfers, and not in secure identification.
25968
25969 However, many clients require that the certificate presented by the server be a
25970 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25971 certificate. In this situation, the self-signed certificate described above
25972 must be installed on the client host as a trusted root &'certification
25973 authority'& (CA), and the certificate used by Exim must be a user certificate
25974 signed with that self-signed certificate.
25975
25976 For information on creating self-signed CA certificates and using them to sign
25977 user certificates, see the &'General implementation overview'& chapter of the
25978 Open-source PKI book, available online at
25979 &url(http://ospkibook.sourceforge.net/).
25980 .ecindex IIDencsmtp1
25981 .ecindex IIDencsmtp2
25982
25983
25984
25985 . ////////////////////////////////////////////////////////////////////////////
25986 . ////////////////////////////////////////////////////////////////////////////
25987
25988 .chapter "Access control lists" "CHAPACL"
25989 .scindex IIDacl "&ACL;" "description"
25990 .cindex "control of incoming mail"
25991 .cindex "message" "controlling incoming"
25992 .cindex "policy control" "access control lists"
25993 Access Control Lists (ACLs) are defined in a separate section of the run time
25994 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25995 name, terminated by a colon. Here is a complete ACL section that contains just
25996 one very small ACL:
25997 .code
25998 begin acl
25999 small_acl:
26000   accept   hosts = one.host.only
26001 .endd
26002 You can have as many lists as you like in the ACL section, and the order in
26003 which they appear does not matter. The lists are self-terminating.
26004
26005 The majority of ACLs are used to control Exim's behaviour when it receives
26006 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26007 when a local process submits a message using SMTP by specifying the &%-bs%&
26008 option. The most common use is for controlling which recipients are accepted
26009 in incoming messages. In addition, you can define an ACL that is used to check
26010 local non-SMTP messages. The default configuration file contains an example of
26011 a realistic ACL for checking RCPT commands. This is discussed in chapter
26012 &<<CHAPdefconfil>>&.
26013
26014
26015 .section "Testing ACLs" "SECID188"
26016 The &%-bh%& command line option provides a way of testing your ACL
26017 configuration locally by running a fake SMTP session with which you interact.
26018 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26019 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26020
26021
26022
26023 .section "Specifying when ACLs are used" "SECID189"
26024 .cindex "&ACL;" "options for specifying"
26025 In order to cause an ACL to be used, you have to name it in one of the relevant
26026 options in the main part of the configuration. These options are:
26027 .cindex "AUTH" "ACL for"
26028 .cindex "DATA" "ACLs for"
26029 .cindex "ETRN" "ACL for"
26030 .cindex "EXPN" "ACL for"
26031 .cindex "HELO" "ACL for"
26032 .cindex "EHLO" "ACL for"
26033 .cindex "MAIL" "ACL for"
26034 .cindex "QUIT, ACL for"
26035 .cindex "RCPT" "ACL for"
26036 .cindex "STARTTLS, ACL for"
26037 .cindex "VRFY" "ACL for"
26038 .cindex "SMTP" "connection, ACL for"
26039 .cindex "non-SMTP messages" "ACLs for"
26040 .cindex "MIME content scanning" "ACL for"
26041
26042 .table2 140pt
26043 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26044 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26045 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26046 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26047 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26048 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26049 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26050 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26051 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26052 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26053 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26054 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26055 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26056 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26057 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26058 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26059 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26060 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26061 .endtable
26062
26063 For example, if you set
26064 .code
26065 acl_smtp_rcpt = small_acl
26066 .endd
26067 the little ACL defined above is used whenever Exim receives a RCPT command
26068 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26069 done when RCPT commands arrive. A rejection of RCPT should cause the
26070 sending MTA to give up on the recipient address contained in the RCPT
26071 command, whereas rejection at other times may cause the client MTA to keep on
26072 trying to deliver the message. It is therefore recommended that you do as much
26073 testing as possible at RCPT time.
26074
26075
26076 .section "The non-SMTP ACLs" "SECID190"
26077 .cindex "non-SMTP messages" "ACLs for"
26078 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26079 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26080 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26081 the state of the SMTP connection such as encryption and authentication) are not
26082 relevant and are forbidden in these ACLs. However, the sender and recipients
26083 are known, so the &%senders%& and &%sender_domains%& conditions and the
26084 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26085 &$authenticated_sender$& are also available. You can specify added header lines
26086 in any of these ACLs.
26087
26088 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26089 non-SMTP message, before any of the message has been read. (This is the
26090 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26091 batched SMTP input, it runs after the DATA command has been reached. The
26092 result of this ACL is ignored; it cannot be used to reject a message. If you
26093 really need to, you could set a value in an ACL variable here and reject based
26094 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26095 controls, and in particular, it can be used to set
26096 .code
26097 control = suppress_local_fixups
26098 .endd
26099 This cannot be used in the other non-SMTP ACLs because by the time they are
26100 run, it is too late.
26101
26102 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26103 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26104
26105 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26106 kind of rejection is treated as permanent, because there is no way of sending a
26107 temporary error for these kinds of message.
26108
26109
26110 .section "The SMTP connect ACL" "SECID191"
26111 .cindex "SMTP" "connection, ACL for"
26112 .oindex &%smtp_banner%&
26113 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26114 session, after the test specified by &%host_reject_connection%& (which is now
26115 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26116 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26117 the message override the banner message that is otherwise specified by the
26118 &%smtp_banner%& option.
26119
26120
26121 .section "The EHLO/HELO ACL" "SECID192"
26122 .cindex "EHLO" "ACL for"
26123 .cindex "HELO" "ACL for"
26124 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26125 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26126 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26127 Note that a client may issue more than one EHLO or HELO command in an SMTP
26128 session, and indeed is required to issue a new EHLO or HELO after successfully
26129 setting up encryption following a STARTTLS command.
26130
26131 If the command is accepted by an &%accept%& verb that has a &%message%&
26132 modifier, the message may not contain more than one line (it will be truncated
26133 at the first newline and a panic logged if it does). Such a message cannot
26134 affect the EHLO options that are listed on the second and subsequent lines of
26135 an EHLO response.
26136
26137
26138 .section "The DATA ACLs" "SECID193"
26139 .cindex "DATA" "ACLs for"
26140 Two ACLs are associated with the DATA command, because it is two-stage
26141 command, with two responses being sent to the client.
26142 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26143 is obeyed. This gives you control after all the RCPT commands, but before
26144 the message itself is received. It offers the opportunity to give a negative
26145 response to the DATA command before the data is transmitted. Header lines
26146 added by MAIL or RCPT ACLs are not visible at this time, but any that
26147 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26148
26149 You cannot test the contents of the message, for example, to verify addresses
26150 in the headers, at RCPT time or when the DATA command is received. Such
26151 tests have to appear in the ACL that is run after the message itself has been
26152 received, before the final response to the DATA command is sent. This is
26153 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26154 associated with the DATA command.
26155
26156 For both of these ACLs, it is not possible to reject individual recipients. An
26157 error response rejects the entire message. Unfortunately, it is known that some
26158 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26159 before or after the data) correctly &-- they keep the message on their queues
26160 and try again later, but that is their problem, though it does waste some of
26161 your resources.
26162
26163 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26164 the &%acl_smtp_mime%& ACLs.
26165
26166
26167 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26168 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26169 enabled (which is the default).
26170
26171 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26172 received, and is executed for each DKIM signature found in a message.  If not
26173 otherwise specified, the default action is to accept.
26174
26175 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26176
26177 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26178
26179
26180 .section "The SMTP MIME ACL" "SECID194"
26181 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26182 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26183
26184 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26185
26186
26187 .section "The QUIT ACL" "SECTQUITACL"
26188 .cindex "QUIT, ACL for"
26189 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26190 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26191 does not in fact control any access. For this reason, the only verbs that are
26192 permitted are &%accept%& and &%warn%&.
26193
26194 This ACL can be used for tasks such as custom logging at the end of an SMTP
26195 session. For example, you can use ACL variables in other ACLs to count
26196 messages, recipients, etc., and log the totals at QUIT time using one or
26197 more &%logwrite%& modifiers on a &%warn%& verb.
26198
26199 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26200 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26201
26202 You do not need to have a final &%accept%&, but if you do, you can use a
26203 &%message%& modifier to specify custom text that is sent as part of the 221
26204 response to QUIT.
26205
26206 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26207 failure (for example, failure to open a log file, or when Exim is bombing out
26208 because it has detected an unrecoverable error), all SMTP commands from the
26209 client are given temporary error responses until QUIT is received or the
26210 connection is closed. In these special cases, the QUIT ACL does not run.
26211
26212
26213 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26214 .vindex &$acl_smtp_notquit$&
26215 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26216 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26217 trouble, such as being unable to write to its log files, this ACL is not run,
26218 because it might try to do things (such as write to log files) that make the
26219 situation even worse.
26220
26221 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26222 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26223 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26224 and &%warn%&.
26225
26226 .vindex &$smtp_notquit_reason$&
26227 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26228 to a string that indicates the reason for the termination of the SMTP
26229 connection. The possible values are:
26230 .table2
26231 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26232 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26233 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26234 .irow &`connection-lost`&          "The SMTP connection has been lost"
26235 .irow &`data-timeout`&             "Timeout while reading message data"
26236 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26237 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26238 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26239 .irow &`synchronization-error`&    "SMTP synchronization error"
26240 .irow &`tls-failed`&               "TLS failed to start"
26241 .endtable
26242 In most cases when an SMTP connection is closed without having received QUIT,
26243 Exim sends an SMTP response message before actually closing the connection.
26244 With the exception of the &`acl-drop`& case, the default message can be
26245 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26246 &%drop%& verb in another ACL, it is the message from the other ACL that is
26247 used.
26248
26249
26250 .section "Finding an ACL to use" "SECID195"
26251 .cindex "&ACL;" "finding which to use"
26252 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26253 you can use different ACLs in different circumstances. For example,
26254 .code
26255 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26256                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26257 .endd
26258 In the default configuration file there are some example settings for
26259 providing an RFC 4409 message submission service on port 587 and a
26260 non-standard &"smtps"& service on port 465. You can use a string
26261 expansion like this to choose an ACL for MUAs on these ports which is
26262 more appropriate for this purpose than the default ACL on port 25.
26263
26264 The expanded string does not have to be the name of an ACL in the
26265 configuration file; there are other possibilities. Having expanded the
26266 string, Exim searches for an ACL as follows:
26267
26268 .ilist
26269 If the string begins with a slash, Exim uses it as a file name, and reads its
26270 contents as an ACL. The lines are processed in the same way as lines in the
26271 Exim configuration file. In particular, continuation lines are supported, blank
26272 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26273 If the file does not exist or cannot be read, an error occurs (typically
26274 causing a temporary failure of whatever caused the ACL to be run). For example:
26275 .code
26276 acl_smtp_data = /etc/acls/\
26277   ${lookup{$sender_host_address}lsearch\
26278   {/etc/acllist}{$value}{default}}
26279 .endd
26280 This looks up an ACL file to use on the basis of the host's IP address, falling
26281 back to a default if the lookup fails. If an ACL is successfully read from a
26282 file, it is retained in memory for the duration of the Exim process, so that it
26283 can be re-used without having to re-read the file.
26284 .next
26285 If the string does not start with a slash, and does not contain any spaces,
26286 Exim searches the ACL section of the configuration for an ACL whose name
26287 matches the string.
26288 .next
26289 If no named ACL is found, or if the string contains spaces, Exim parses
26290 the string as an inline ACL. This can save typing in cases where you just
26291 want to have something like
26292 .code
26293 acl_smtp_vrfy = accept
26294 .endd
26295 in order to allow free use of the VRFY command. Such a string may contain
26296 newlines; it is processed in the same way as an ACL that is read from a file.
26297 .endlist
26298
26299
26300
26301
26302 .section "ACL return codes" "SECID196"
26303 .cindex "&ACL;" "return codes"
26304 Except for the QUIT ACL, which does not affect the SMTP return code (see
26305 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26306 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26307 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26308 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26309 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26310 This also causes a 4&'xx'& return code.
26311
26312 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26313 &"deny"&, because there is no mechanism for passing temporary errors to the
26314 submitters of non-SMTP messages.
26315
26316
26317 ACLs that are relevant to message reception may also return &"discard"&. This
26318 has the effect of &"accept"&, but causes either the entire message or an
26319 individual recipient address to be discarded. In other words, it is a
26320 blackholing facility. Use it with care.
26321
26322 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26323 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26324 RCPT ACL is to discard just the one recipient address. If there are no
26325 recipients left when the message's data is received, the DATA ACL is not
26326 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26327 remaining recipients. The &"discard"& return is not permitted for the
26328 &%acl_smtp_predata%& ACL.
26329
26330
26331 .cindex "&[local_scan()]& function" "when all recipients discarded"
26332 The &[local_scan()]& function is always run, even if there are no remaining
26333 recipients; it may create new recipients.
26334
26335
26336
26337 .section "Unset ACL options" "SECID197"
26338 .cindex "&ACL;" "unset options"
26339 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26340 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26341 not defined at all. For any defined ACL, the default action when control
26342 reaches the end of the ACL statements is &"deny"&.
26343
26344 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26345 these two are ACLs that are used only for their side effects. They cannot be
26346 used to accept or reject anything.
26347
26348 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26349 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26350 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26351 when the ACL is not defined is &"accept"&.
26352
26353 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26354 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26355 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26356 messages over an SMTP connection. For an example, see the ACL in the default
26357 configuration file.
26358
26359
26360
26361
26362 .section "Data for message ACLs" "SECID198"
26363 .cindex "&ACL;" "data for message ACL"
26364 .vindex &$domain$&
26365 .vindex &$local_part$&
26366 .vindex &$sender_address$&
26367 .vindex &$sender_host_address$&
26368 .vindex &$smtp_command$&
26369 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26370 that contain information about the host and the message's sender (for example,
26371 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26372 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26373 &$local_part$& are set from the argument address. The entire SMTP command
26374 is available in &$smtp_command$&.
26375
26376 When an ACL for the AUTH parameter of MAIL is running, the variables that
26377 contain information about the host are set, but &$sender_address$& is not yet
26378 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26379 how it is used.
26380
26381 .vindex "&$message_size$&"
26382 The &$message_size$& variable is set to the value of the SIZE parameter on
26383 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26384 that parameter is not given. The value is updated to the true message size by
26385 the time the final DATA ACL is run (after the message data has been
26386 received).
26387
26388 .vindex "&$rcpt_count$&"
26389 .vindex "&$recipients_count$&"
26390 The &$rcpt_count$& variable increases by one for each RCPT command received.
26391 The &$recipients_count$& variable increases by one each time a RCPT command is
26392 accepted, so while an ACL for RCPT is being processed, it contains the number
26393 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26394 &$rcpt_count$& contains the total number of RCPT commands, and
26395 &$recipients_count$& contains the total number of accepted recipients.
26396
26397
26398
26399
26400
26401 .section "Data for non-message ACLs" "SECTdatfornon"
26402 .cindex "&ACL;" "data for non-message ACL"
26403 .vindex &$smtp_command_argument$&
26404 .vindex &$smtp_command$&
26405 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26406 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26407 and the entire SMTP command is available in &$smtp_command$&.
26408 These variables can be tested using a &%condition%& condition. For example,
26409 here is an ACL for use with AUTH, which insists that either the session is
26410 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26411 does not permit authentication methods that use cleartext passwords on
26412 unencrypted connections.
26413 .code
26414 acl_check_auth:
26415   accept encrypted = *
26416   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26417                      {CRAM-MD5}}
26418   deny   message   = TLS encryption or CRAM-MD5 required
26419 .endd
26420 (Another way of applying this restriction is to arrange for the authenticators
26421 that use cleartext passwords not to be advertised when the connection is not
26422 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26423 option to do this.)
26424
26425
26426
26427 .section "Format of an ACL" "SECID199"
26428 .cindex "&ACL;" "format of"
26429 .cindex "&ACL;" "verbs, definition of"
26430 An individual ACL consists of a number of statements. Each statement starts
26431 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26432 Modifiers can change the way the verb operates, define error and log messages,
26433 set variables, insert delays, and vary the processing of accepted messages.
26434
26435 If all the conditions are met, the verb is obeyed. The same condition may be
26436 used (with different arguments) more than once in the same statement. This
26437 provides a means of specifying an &"and"& conjunction between conditions. For
26438 example:
26439 .code
26440 deny  dnslists = list1.example
26441 dnslists = list2.example
26442 .endd
26443 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26444 the conditions and modifiers when it reaches a condition that fails. What
26445 happens then depends on the verb (and in one case, on a special modifier). Not
26446 all the conditions make sense at every testing point. For example, you cannot
26447 test a sender address in the ACL that is run for a VRFY command.
26448
26449
26450 .section "ACL verbs" "SECID200"
26451 The ACL verbs are as follows:
26452
26453 .ilist
26454 .cindex "&%accept%& ACL verb"
26455 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26456 of the conditions are not met, what happens depends on whether &%endpass%&
26457 appears among the conditions (for syntax see below). If the failing condition
26458 is before &%endpass%&, control is passed to the next ACL statement; if it is
26459 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26460 check a RCPT command:
26461 .code
26462 accept domains = +local_domains
26463 endpass
26464 verify = recipient
26465 .endd
26466 If the recipient domain does not match the &%domains%& condition, control
26467 passes to the next statement. If it does match, the recipient is verified, and
26468 the command is accepted if verification succeeds. However, if verification
26469 fails, the ACL yields &"deny"&, because the failing condition is after
26470 &%endpass%&.
26471
26472 The &%endpass%& feature has turned out to be confusing to many people, so its
26473 use is not recommended nowadays. It is always possible to rewrite an ACL so
26474 that &%endpass%& is not needed, and it is no longer used in the default
26475 configuration.
26476
26477 .cindex "&%message%& ACL modifier" "with &%accept%&"
26478 If a &%message%& modifier appears on an &%accept%& statement, its action
26479 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26480 (when an &%accept%& verb either accepts or passes control to the next
26481 statement), &%message%& can be used to vary the message that is sent when an
26482 SMTP command is accepted. For example, in a RCPT ACL you could have:
26483 .display
26484 &`accept  `&<&'some conditions'&>
26485 &`        message = OK, I will allow you through today`&
26486 .endd
26487 You can specify an SMTP response code, optionally followed by an &"extended
26488 response code"& at the start of the message, but the first digit must be the
26489 same as would be sent by default, which is 2 for an &%accept%& verb.
26490
26491 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26492 an error message that is used when access is denied. This behaviour is retained
26493 for backward compatibility, but current &"best practice"& is to avoid the use
26494 of &%endpass%&.
26495
26496
26497 .next
26498 .cindex "&%defer%& ACL verb"
26499 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26500 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26501 &%defer%& is the same as &%deny%&, because there is no way of sending a
26502 temporary error. For a RCPT command, &%defer%& is much the same as using a
26503 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26504 be used in any ACL, and even for a recipient it might be a simpler approach.
26505
26506
26507 .next
26508 .cindex "&%deny%& ACL verb"
26509 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26510 the conditions are not met, control is passed to the next ACL statement. For
26511 example,
26512 .code
26513 deny dnslists = blackholes.mail-abuse.org
26514 .endd
26515 rejects commands from hosts that are on a DNS black list.
26516
26517
26518 .next
26519 .cindex "&%discard%& ACL verb"
26520 &%discard%&: This verb behaves like &%accept%&, except that it returns
26521 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26522 that are concerned with receiving messages. When all the conditions are true,
26523 the sending entity receives a &"success"& response. However, &%discard%& causes
26524 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26525 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26526 message's recipients are discarded. Recipients that are discarded before DATA
26527 do not appear in the log line when the &%received_recipients%& log selector is set.
26528
26529 If the &%log_message%& modifier is set when &%discard%& operates,
26530 its contents are added to the line that is automatically written to the log.
26531 The &%message%& modifier operates exactly as it does for &%accept%&.
26532
26533
26534 .next
26535 .cindex "&%drop%& ACL verb"
26536 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26537 forcibly closed after the 5&'xx'& error message has been sent. For example:
26538 .code
26539 drop   message   = I don't take more than 20 RCPTs
26540        condition = ${if > {$rcpt_count}{20}}
26541 .endd
26542 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26543 The connection is always dropped after sending a 550 response.
26544
26545 .next
26546 .cindex "&%require%& ACL verb"
26547 &%require%&: If all the conditions are met, control is passed to the next ACL
26548 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26549 example, when checking a RCPT command,
26550 .code
26551 require message = Sender did not verify
26552         verify  = sender
26553 .endd
26554 passes control to subsequent statements only if the message's sender can be
26555 verified. Otherwise, it rejects the command. Note the positioning of the
26556 &%message%& modifier, before the &%verify%& condition. The reason for this is
26557 discussed in section &<<SECTcondmodproc>>&.
26558
26559 .next
26560 .cindex "&%warn%& ACL verb"
26561 &%warn%&: If all the conditions are true, a line specified by the
26562 &%log_message%& modifier is written to Exim's main log. Control always passes
26563 to the next ACL statement. If any condition is false, the log line is not
26564 written. If an identical log line is requested several times in the same
26565 message, only one copy is actually written to the log. If you want to force
26566 duplicates to be written, use the &%logwrite%& modifier instead.
26567
26568 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26569 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26570 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26571 first failing condition. There is more about adding header lines in section
26572 &<<SECTaddheadacl>>&.
26573
26574 If any condition on a &%warn%& statement cannot be completed (that is, there is
26575 some sort of defer), the log line specified by &%log_message%& is not written.
26576 This does not include the case of a forced failure from a lookup, which
26577 is considered to be a successful completion. After a defer, no further
26578 conditions or modifiers in the &%warn%& statement are processed. The incident
26579 is logged, and the ACL continues to be processed, from the next statement
26580 onwards.
26581
26582
26583 .vindex "&$acl_verify_message$&"
26584 When one of the &%warn%& conditions is an address verification that fails, the
26585 text of the verification failure message is in &$acl_verify_message$&. If you
26586 want this logged, you must set it up explicitly. For example:
26587 .code
26588 warn   !verify = sender
26589        log_message = sender verify failed: $acl_verify_message
26590 .endd
26591 .endlist
26592
26593 At the end of each ACL there is an implicit unconditional &%deny%&.
26594
26595 As you can see from the examples above, the conditions and modifiers are
26596 written one to a line, with the first one on the same line as the verb, and
26597 subsequent ones on following lines. If you have a very long condition, you can
26598 continue it onto several physical lines by the usual backslash continuation
26599 mechanism. It is conventional to align the conditions vertically.
26600
26601
26602
26603 .section "ACL variables" "SECTaclvariables"
26604 .cindex "&ACL;" "variables"
26605 There are some special variables that can be set during ACL processing. They
26606 can be used to pass information between different ACLs, different invocations
26607 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26608 transports, and filters that are used to deliver a message. The names of these
26609 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26610 an underscore, but the remainder of the name can be any sequence of
26611 alphanumeric characters and underscores that you choose. There is no limit on
26612 the number of ACL variables. The two sets act as follows:
26613 .ilist
26614 The values of those variables whose names begin with &$acl_c$& persist
26615 throughout an SMTP connection. They are never reset. Thus, a value that is set
26616 while receiving one message is still available when receiving the next message
26617 on the same SMTP connection.
26618 .next
26619 The values of those variables whose names begin with &$acl_m$& persist only
26620 while a message is being received. They are reset afterwards. They are also
26621 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26622 .endlist
26623
26624 When a message is accepted, the current values of all the ACL variables are
26625 preserved with the message and are subsequently made available at delivery
26626 time. The ACL variables are set by a modifier called &%set%&. For example:
26627 .code
26628 accept hosts = whatever
26629        set acl_m4 = some value
26630 accept authenticated = *
26631        set acl_c_auth = yes
26632 .endd
26633 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26634 be set. If you want to set a variable without taking any action, you can use a
26635 &%warn%& verb without any other modifiers or conditions.
26636
26637 .oindex &%strict_acl_vars%&
26638 What happens if a syntactically valid but undefined ACL variable is
26639 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26640 false (the default), an empty string is substituted; if it is true, an
26641 error is generated.
26642
26643 Versions of Exim before 4.64 have a limited set of numbered variables, but
26644 their names are compatible, so there is no problem with upgrading.
26645
26646
26647 .section "Condition and modifier processing" "SECTcondmodproc"
26648 .cindex "&ACL;" "conditions; processing"
26649 .cindex "&ACL;" "modifiers; processing"
26650 An exclamation mark preceding a condition negates its result. For example:
26651 .code
26652 deny   domains = *.dom.example
26653       !verify  = recipient
26654 .endd
26655 causes the ACL to return &"deny"& if the recipient domain ends in
26656 &'dom.example'& and the recipient address cannot be verified. Sometimes
26657 negation can be used on the right-hand side of a condition. For example, these
26658 two statements are equivalent:
26659 .code
26660 deny  hosts = !192.168.3.4
26661 deny !hosts =  192.168.3.4
26662 .endd
26663 However, for many conditions (&%verify%& being a good example), only left-hand
26664 side negation of the whole condition is possible.
26665
26666 The arguments of conditions and modifiers are expanded. A forced failure
26667 of an expansion causes a condition to be ignored, that is, it behaves as if the
26668 condition is true. Consider these two statements:
26669 .code
26670 accept  senders = ${lookup{$host_name}lsearch\
26671                   {/some/file}{$value}fail}
26672 accept  senders = ${lookup{$host_name}lsearch\
26673                   {/some/file}{$value}{}}
26674 .endd
26675 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26676 the returned list is searched, but if the lookup fails the behaviour is
26677 different in the two cases. The &%fail%& in the first statement causes the
26678 condition to be ignored, leaving no further conditions. The &%accept%& verb
26679 therefore succeeds. The second statement, however, generates an empty list when
26680 the lookup fails. No sender can match an empty list, so the condition fails,
26681 and therefore the &%accept%& also fails.
26682
26683 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26684 specify actions that are taken as the conditions for a statement are checked;
26685 others specify text for messages that are used when access is denied or a
26686 warning is generated. The &%control%& modifier affects the way an incoming
26687 message is handled.
26688
26689 The positioning of the modifiers in an ACL statement is important, because the
26690 processing of a verb ceases as soon as its outcome is known. Only those
26691 modifiers that have already been encountered will take effect. For example,
26692 consider this use of the &%message%& modifier:
26693 .code
26694 require message = Can't verify sender
26695         verify  = sender
26696         message = Can't verify recipient
26697         verify  = recipient
26698         message = This message cannot be used
26699 .endd
26700 If sender verification fails, Exim knows that the result of the statement is
26701 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26702 so its text is used as the error message. If sender verification succeeds, but
26703 recipient verification fails, the second message is used. If recipient
26704 verification succeeds, the third message becomes &"current"&, but is never used
26705 because there are no more conditions to cause failure.
26706
26707 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26708 modifier that is used, because all the conditions must be true for rejection to
26709 happen. Specifying more than one &%message%& modifier does not make sense, and
26710 the message can even be specified after all the conditions. For example:
26711 .code
26712 deny   hosts = ...
26713       !senders = *@my.domain.example
26714        message = Invalid sender from client host
26715 .endd
26716 The &"deny"& result does not happen until the end of the statement is reached,
26717 by which time Exim has set up the message.
26718
26719
26720
26721 .section "ACL modifiers" "SECTACLmodi"
26722 .cindex "&ACL;" "modifiers; list of"
26723 The ACL modifiers are as follows:
26724
26725 .vlist
26726 .vitem &*add_header*&&~=&~<&'text'&>
26727 This modifier specifies one or more header lines that are to be added to an
26728 incoming message, assuming, of course, that the message is ultimately
26729 accepted. For details, see section &<<SECTaddheadacl>>&.
26730
26731 .vitem &*continue*&&~=&~<&'text'&>
26732 .cindex "&%continue%& ACL modifier"
26733 .cindex "database" "updating in ACL"
26734 This modifier does nothing of itself, and processing of the ACL always
26735 continues with the next condition or modifier. The value of &%continue%& is in
26736 the side effects of expanding its argument. Typically this could be used to
26737 update a database. It is really just a syntactic tidiness, to avoid having to
26738 write rather ugly lines like this:
26739 .display
26740 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26741 .endd
26742 Instead, all you need is
26743 .display
26744 &`continue = `&<&'some expansion'&>
26745 .endd
26746
26747 .vitem &*control*&&~=&~<&'text'&>
26748 .cindex "&%control%& ACL modifier"
26749 This modifier affects the subsequent processing of the SMTP connection or of an
26750 incoming message that is accepted. The effect of the first type of control
26751 lasts for the duration of the connection, whereas the effect of the second type
26752 lasts only until the current message has been received. The message-specific
26753 controls always apply to the whole message, not to individual recipients,
26754 even if the &%control%& modifier appears in a RCPT ACL.
26755
26756 As there are now quite a few controls that can be applied, they are described
26757 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26758 in several different ways. For example:
26759
26760 . ==== As this is a nested list, any displays it contains must be indented
26761 . ==== as otherwise they are too far to the left. That comment applies only
26762 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26763 . ==== way.
26764
26765 .ilist
26766 It can be at the end of an &%accept%& statement:
26767 .code
26768     accept  ...some conditions
26769             control = queue_only
26770 .endd
26771 In this case, the control is applied when this statement yields &"accept"&, in
26772 other words, when the conditions are all true.
26773
26774 .next
26775 It can be in the middle of an &%accept%& statement:
26776 .code
26777     accept  ...some conditions...
26778             control = queue_only
26779             ...some more conditions...
26780 .endd
26781 If the first set of conditions are true, the control is applied, even if the
26782 statement does not accept because one of the second set of conditions is false.
26783 In this case, some subsequent statement must yield &"accept"& for the control
26784 to be relevant.
26785
26786 .next
26787 It can be used with &%warn%& to apply the control, leaving the
26788 decision about accepting or denying to a subsequent verb. For
26789 example:
26790 .code
26791     warn    ...some conditions...
26792             control = freeze
26793     accept  ...
26794 .endd
26795 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26796 &%logwrite%&, so it does not add anything to the message and does not write a
26797 log entry.
26798
26799 .next
26800 If you want to apply a control unconditionally, you can use it with a
26801 &%require%& verb. For example:
26802 .code
26803     require  control = no_multiline_responses
26804 .endd
26805 .endlist
26806
26807 .vitem &*delay*&&~=&~<&'time'&>
26808 .cindex "&%delay%& ACL modifier"
26809 .oindex "&%-bh%&"
26810 This modifier may appear in any ACL except notquit. It causes Exim to wait for
26811 the time interval before proceeding. However, when testing Exim using the
26812 &%-bh%& option, the delay is not actually imposed (an appropriate message is
26813 output instead). The time is given in the usual Exim notation, and the delay
26814 happens as soon as the modifier is processed. In an SMTP session, pending
26815 output is flushed before the delay is imposed.
26816
26817 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26818 example:
26819 .code
26820 deny    ...some conditions...
26821         delay = 30s
26822 .endd
26823 The delay happens if all the conditions are true, before the statement returns
26824 &"deny"&. Compare this with:
26825 .code
26826 deny    delay = 30s
26827         ...some conditions...
26828 .endd
26829 which waits for 30s before processing the conditions. The &%delay%& modifier
26830 can also be used with &%warn%& and together with &%control%&:
26831 .code
26832 warn    ...some conditions...
26833         delay = 2m
26834         control = freeze
26835 accept  ...
26836 .endd
26837
26838 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26839 responses to several commands are no longer buffered and sent in one packet (as
26840 they would normally be) because all output is flushed before imposing the
26841 delay. This optimization is disabled so that a number of small delays do not
26842 appear to the client as one large aggregated delay that might provoke an
26843 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26844 using a &%control%& modifier to set &%no_delay_flush%&.
26845
26846
26847 .vitem &*endpass*&
26848 .cindex "&%endpass%& ACL modifier"
26849 This modifier, which has no argument, is recognized only in &%accept%& and
26850 &%discard%& statements. It marks the boundary between the conditions whose
26851 failure causes control to pass to the next statement, and the conditions whose
26852 failure causes the ACL to return &"deny"&. This concept has proved to be
26853 confusing to some people, so the use of &%endpass%& is no longer recommended as
26854 &"best practice"&. See the description of &%accept%& above for more details.
26855
26856
26857 .vitem &*log_message*&&~=&~<&'text'&>
26858 .cindex "&%log_message%& ACL modifier"
26859 This modifier sets up a message that is used as part of the log message if the
26860 ACL denies access or a &%warn%& statement's conditions are true. For example:
26861 .code
26862 require log_message = wrong cipher suite $tls_in_cipher
26863         encrypted   = DES-CBC3-SHA
26864 .endd
26865 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26866 example:
26867 .display
26868 &`discard `&<&'some conditions'&>
26869 &`        log_message = Discarded $local_part@$domain because...`&
26870 .endd
26871 When access is denied, &%log_message%& adds to any underlying error message
26872 that may exist because of a condition failure. For example, while verifying a
26873 recipient address, a &':fail:'& redirection might have already set up a
26874 message.
26875
26876 The message may be defined before the conditions to which it applies, because
26877 the string expansion does not happen until Exim decides that access is to be
26878 denied. This means that any variables that are set by the condition are
26879 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26880 variables are set after a DNS black list lookup succeeds. If the expansion of
26881 &%log_message%& fails, or if the result is an empty string, the modifier is
26882 ignored.
26883
26884 .vindex "&$acl_verify_message$&"
26885 If you want to use a &%warn%& statement to log the result of an address
26886 verification, you can use &$acl_verify_message$& to include the verification
26887 error message.
26888
26889 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26890 the start of the logged message. If the same warning log message is requested
26891 more than once while receiving  a single email message, only one copy is
26892 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26893 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26894 is logged for a successful &%warn%& statement.
26895
26896 If &%log_message%& is not present and there is no underlying error message (for
26897 example, from the failure of address verification), but &%message%& is present,
26898 the &%message%& text is used for logging rejections. However, if any text for
26899 logging contains newlines, only the first line is logged. In the absence of
26900 both &%log_message%& and &%message%&, a default built-in message is used for
26901 logging rejections.
26902
26903
26904 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26905 .cindex "&%log_reject_target%& ACL modifier"
26906 .cindex "logging in ACL" "specifying which log"
26907 This modifier makes it possible to specify which logs are used for messages
26908 about ACL rejections. Its argument is a colon-separated list of words that can
26909 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26910 may be empty, in which case a rejection is not logged at all. For example, this
26911 ACL fragment writes no logging information when access is denied:
26912 .display
26913 &`deny `&<&'some conditions'&>
26914 &`     log_reject_target =`&
26915 .endd
26916 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26917 permanent and temporary rejections. Its effect lasts for the rest of the
26918 current ACL.
26919
26920
26921 .vitem &*logwrite*&&~=&~<&'text'&>
26922 .cindex "&%logwrite%& ACL modifier"
26923 .cindex "logging in ACL" "immediate"
26924 This modifier writes a message to a log file as soon as it is encountered when
26925 processing an ACL. (Compare &%log_message%&, which, except in the case of
26926 &%warn%& and &%discard%&, is used only if the ACL statement denies
26927 access.) The &%logwrite%& modifier can be used to log special incidents in
26928 ACLs. For example:
26929 .display
26930 &`accept `&<&'some special conditions'&>
26931 &`       control  = freeze`&
26932 &`       logwrite = froze message because ...`&
26933 .endd
26934 By default, the message is written to the main log. However, it may begin
26935 with a colon, followed by a comma-separated list of log names, and then
26936 another colon, to specify exactly which logs are to be written. For
26937 example:
26938 .code
26939 logwrite = :main,reject: text for main and reject logs
26940 logwrite = :panic: text for panic log only
26941 .endd
26942
26943
26944 .vitem &*message*&&~=&~<&'text'&>
26945 .cindex "&%message%& ACL modifier"
26946 This modifier sets up a text string that is expanded and used as a response
26947 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26948 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26949 there is some complication if &%endpass%& is involved; see the description of
26950 &%accept%& for details.)
26951
26952 The expansion of the message happens at the time Exim decides that the ACL is
26953 to end, not at the time it processes &%message%&. If the expansion fails, or
26954 generates an empty string, the modifier is ignored. Here is an example where
26955 &%message%& must be specified first, because the ACL ends with a rejection if
26956 the &%hosts%& condition fails:
26957 .code
26958 require  message = Host not recognized
26959          hosts = 10.0.0.0/8
26960 .endd
26961 (Once a condition has failed, no further conditions or modifiers are
26962 processed.)
26963
26964 .cindex "SMTP" "error codes"
26965 .oindex "&%smtp_banner%&
26966 For ACLs that are triggered by SMTP commands, the message is returned as part
26967 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26968 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26969 is accepted. In the case of the connect ACL, accepting with a message modifier
26970 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26971 accept message may not contain more than one line (otherwise it will be
26972 truncated at the first newline and a panic logged), and it cannot affect the
26973 EHLO options.
26974
26975 When SMTP is involved, the message may begin with an overriding response code,
26976 consisting of three digits optionally followed by an &"extended response code"&
26977 of the form &'n.n.n'&, each code being followed by a space. For example:
26978 .code
26979 deny  message = 599 1.2.3 Host not welcome
26980       hosts = 192.168.34.0/24
26981 .endd
26982 The first digit of the supplied response code must be the same as would be sent
26983 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26984 access, but for the predata ACL, note that the default success code is 354, not
26985 2&'xx'&.
26986
26987 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26988 the message modifier cannot override the 221 response code.
26989
26990 The text in a &%message%& modifier is literal; any quotes are taken as
26991 literals, but because the string is expanded, backslash escapes are processed
26992 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26993 response.
26994
26995 .vindex "&$acl_verify_message$&"
26996 If &%message%& is used on a statement that verifies an address, the message
26997 specified overrides any message that is generated by the verification process.
26998 However, the original message is available in the variable
26999 &$acl_verify_message$&, so you can incorporate it into your message if you
27000 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27001 routers to be passed back as part of the SMTP response, you should either not
27002 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27003
27004 For compatibility with previous releases of Exim, a &%message%& modifier that
27005 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27006 modifier, but this usage is now deprecated. However, &%message%& acts only when
27007 all the conditions are true, wherever it appears in an ACL command, whereas
27008 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27009 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27010 effect.
27011
27012
27013 .vitem &*remove_header*&&~=&~<&'text'&>
27014 This modifier specifies one or more header names in a colon-separated list
27015  that are to be removed from an incoming message, assuming, of course, that
27016 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27017
27018
27019 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27020 .cindex "&%set%& ACL modifier"
27021 This modifier puts a value into one of the ACL variables (see section
27022 &<<SECTaclvariables>>&).
27023 .endlist
27024
27025
27026
27027
27028
27029 .section "Use of the control modifier" "SECTcontrols"
27030 .cindex "&%control%& ACL modifier"
27031 The &%control%& modifier supports the following settings:
27032
27033 .vlist
27034 .vitem &*control&~=&~allow_auth_unadvertised*&
27035 This modifier allows a client host to use the SMTP AUTH command even when it
27036 has not been advertised in response to EHLO. Furthermore, because there are
27037 apparently some really broken clients that do this, Exim will accept AUTH after
27038 HELO (rather than EHLO) when this control is set. It should be used only if you
27039 really need it, and you should limit its use to those broken clients that do
27040 not work without it. For example:
27041 .code
27042 warn hosts   = 192.168.34.25
27043      control = allow_auth_unadvertised
27044 .endd
27045 Normally, when an Exim server receives an AUTH command, it checks the name of
27046 the authentication mechanism that is given in the command to ensure that it
27047 matches an advertised mechanism. When this control is set, the check that a
27048 mechanism has been advertised is bypassed. Any configured mechanism can be used
27049 by the client. This control is permitted only in the connection and HELO ACLs.
27050
27051
27052 .vitem &*control&~=&~caseful_local_part*& &&&
27053        &*control&~=&~caselower_local_part*&
27054 .cindex "&ACL;" "case of local part in"
27055 .cindex "case of local parts"
27056 .vindex "&$local_part$&"
27057 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27058 (that is, during RCPT processing). By default, the contents of &$local_part$&
27059 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27060 any uppercase letters in the original local part are restored in &$local_part$&
27061 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27062 is encountered.
27063
27064 These controls affect only the current recipient. Moreover, they apply only to
27065 local part handling that takes place directly in the ACL (for example, as a key
27066 in lookups). If a test to verify the recipient is obeyed, the case-related
27067 handling of the local part during the verification is controlled by the router
27068 configuration (see the &%caseful_local_part%& generic router option).
27069
27070 This facility could be used, for example, to add a spam score to local parts
27071 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27072 spam score:
27073 .code
27074 warn  control = caseful_local_part
27075       set acl_m4 = ${eval:\
27076                      $acl_m4 + \
27077                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27078                     }
27079       control = caselower_local_part
27080 .endd
27081 Notice that we put back the lower cased version afterwards, assuming that
27082 is what is wanted for subsequent tests.
27083
27084
27085 .new
27086 .vitem &*control&~=&~cutthrough_delivery*&
27087 .cindex "&ACL;" "cutthrough routing"
27088 .cindex "cutthrough" "requesting"
27089 This option requests delivery be attempted while the item is being received.
27090 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27091 from one SMTP connection to another.  If a recipient-verify callout connection is
27092 requested in the same ACL it is held open and used for the data, otherwise one is made
27093 after the ACL completes.  Note that routers are used in verify mode.
27094
27095 Should the ultimate destination system positively accept or reject the mail,
27096 a corresponding indication is given to the source system and nothing is queued.
27097 If there is a temporary error the item is queued for later delivery in the
27098 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27099 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27100 line.
27101
27102 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27103 sender when the destination system is doing content-scan based rejection.
27104 .wen
27105
27106
27107 .new
27108 .vitem &*control&~=&~debug/*&<&'options'&>
27109 .cindex "&ACL;" "enabling debug logging"
27110 .cindex "debugging" "enabling from an ACL"
27111 This control turns on debug logging, almost as though Exim had been invoked
27112 with &`-d`&, with the output going to a new logfile, by default called
27113 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27114 may access any variables already defined.  The logging may be adjusted with
27115 the &'opts'& option, which takes the same values as the &`-d`& command-line
27116 option.  Some examples (which depend on variables that don't exist in all
27117 contexts):
27118 .code
27119       control = debug
27120       control = debug/tag=.$sender_host_address
27121       control = debug/opts=+expand+acl
27122       control = debug/tag=.$message_exim_id/opts=+expand
27123 .endd
27124 .wen
27125
27126
27127 .new
27128 .vitem &*control&~=&~dkim_disable_verify*&
27129 .cindex "disable DKIM verify"
27130 .cindex "DKIM" "disable verify"
27131 This control turns off DKIM verification processing entirely.  For details on
27132 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27133 .wen
27134
27135
27136 .new
27137 .vitem &*control&~=&~dscp/*&<&'value'&>
27138 .cindex "&ACL;" "setting DSCP value"
27139 .cindex "DSCP" "inbound"
27140 This option causes the DSCP value associated with the socket for the inbound
27141 connection to be adjusted to a given value, given as one of a number of fixed
27142 strings or to numeric value.
27143 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27144 Common values include &`throughput`&, &`mincost`&, and on newer systems
27145 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27146
27147 The outbound packets from Exim will be marked with this value in the header
27148 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27149 that these values will have any effect, not be stripped by networking
27150 equipment, or do much of anything without cooperation with your Network
27151 Engineer and those of all network operators between the source and destination.
27152 .wen
27153
27154
27155 .vitem &*control&~=&~enforce_sync*& &&&
27156        &*control&~=&~no_enforce_sync*&
27157 .cindex "SMTP" "synchronization checking"
27158 .cindex "synchronization checking in SMTP"
27159 These controls make it possible to be selective about when SMTP synchronization
27160 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27161 state of the switch (it is true by default). See the description of this option
27162 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27163
27164 The effect of these two controls lasts for the remainder of the SMTP
27165 connection. They can appear in any ACL except the one for the non-SMTP
27166 messages. The most straightforward place to put them is in the ACL defined by
27167 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27168 before the first synchronization check. The expected use is to turn off the
27169 synchronization checks for badly-behaved hosts that you nevertheless need to
27170 work with.
27171
27172
27173 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27174 .cindex "fake defer"
27175 .cindex "defer, fake"
27176 This control works in exactly the same way as &%fakereject%& (described below)
27177 except that it causes an SMTP 450 response after the message data instead of a
27178 550 response. You must take care when using &%fakedefer%& because it causes the
27179 messages to be duplicated when the sender retries. Therefore, you should not
27180 use &%fakedefer%& if the message is to be delivered normally.
27181
27182 .vitem &*control&~=&~fakereject/*&<&'message'&>
27183 .cindex "fake rejection"
27184 .cindex "rejection, fake"
27185 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27186 words, only when an SMTP message is being received. If Exim accepts the
27187 message, instead the final 250 response, a 550 rejection message is sent.
27188 However, Exim proceeds to deliver the message as normal. The control applies
27189 only to the current message, not to any subsequent ones that may be received in
27190 the same SMTP connection.
27191
27192 The text for the 550 response is taken from the &%control%& modifier. If no
27193 message is supplied, the following is used:
27194 .code
27195 550-Your message has been rejected but is being
27196 550-kept for evaluation.
27197 550-If it was a legitimate message, it may still be
27198 550 delivered to the target recipient(s).
27199 .endd
27200 This facility should be used with extreme caution.
27201
27202 .vitem &*control&~=&~freeze*&
27203 .cindex "frozen messages" "forcing in ACL"
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 frozen. The control applies only to the
27207 current message, not to any subsequent ones that may be received in the same
27208 SMTP connection.
27209
27210 This modifier can optionally be followed by &`/no_tell`&. If the global option
27211 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27212 is told about the freezing), provided all the &*control=freeze*& modifiers that
27213 are obeyed for the current message have the &`/no_tell`& option.
27214
27215 .vitem &*control&~=&~no_delay_flush*&
27216 .cindex "SMTP" "output flushing, disabling for delay"
27217 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27218 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27219 use. This control, as long as it is encountered before the &%delay%& modifier,
27220 disables such output flushing.
27221
27222 .vitem &*control&~=&~no_callout_flush*&
27223 .cindex "SMTP" "output flushing, disabling for callout"
27224 Exim normally flushes SMTP output before performing a callout in an ACL, to
27225 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27226 use. This control, as long as it is encountered before the &%verify%& condition
27227 that causes the callout, disables such output flushing.
27228
27229 .vitem &*control&~=&~no_mbox_unspool*&
27230 This control is available when Exim is compiled with the content scanning
27231 extension. Content scanning may require a copy of the current message, or parts
27232 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27233 or spam scanner. Normally, such copies are deleted when they are no longer
27234 needed. If this control is set, the copies are not deleted. The control applies
27235 only to the current message, not to any subsequent ones that may be received in
27236 the same SMTP connection. It is provided for debugging purposes and is unlikely
27237 to be useful in production.
27238
27239 .vitem &*control&~=&~no_multiline_responses*&
27240 .cindex "multiline responses, suppressing"
27241 This control is permitted for any ACL except the one for non-SMTP messages.
27242 It seems that there are broken clients in use that cannot handle multiline
27243 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27244
27245 If this control is set, multiline SMTP responses from ACL rejections are
27246 suppressed. One way of doing this would have been to put out these responses as
27247 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27248 (&"use multiline responses for more"& it says &-- ha!), and some of the
27249 responses might get close to that. So this facility, which is after all only a
27250 sop to broken clients, is implemented by doing two very easy things:
27251
27252 .ilist
27253 Extra information that is normally output as part of a rejection caused by
27254 sender verification failure is omitted. Only the final line (typically &"sender
27255 verification failed"&) is sent.
27256 .next
27257 If a &%message%& modifier supplies a multiline response, only the first
27258 line is output.
27259 .endlist
27260
27261 The setting of the switch can, of course, be made conditional on the
27262 calling host. Its effect lasts until the end of the SMTP connection.
27263
27264 .vitem &*control&~=&~no_pipelining*&
27265 .cindex "PIPELINING" "suppressing advertising"
27266 This control turns off the advertising of the PIPELINING extension to SMTP in
27267 the current session. To be useful, it must be obeyed before Exim sends its
27268 response to an EHLO command. Therefore, it should normally appear in an ACL
27269 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27270 &%pipelining_advertise_hosts%&.
27271
27272 .vitem &*control&~=&~queue_only*&
27273 .oindex "&%queue_only%&"
27274 .cindex "queueing incoming messages"
27275 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27276 other words, only when a message is being received. If the message is accepted,
27277 it is placed on Exim's queue and left there for delivery by a subsequent queue
27278 runner. No immediate delivery process is started. In other words, it has the
27279 effect as the &%queue_only%& global option. However, the control applies only
27280 to the current message, not to any subsequent ones that may be received in the
27281 same SMTP connection.
27282
27283 .vitem &*control&~=&~submission/*&<&'options'&>
27284 .cindex "message" "submission"
27285 .cindex "submission mode"
27286 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27287 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27288 the current message is a submission from a local MUA. In this case, Exim
27289 operates in &"submission mode"&, and applies certain fixups to the message if
27290 necessary. For example, it adds a &'Date:'& header line if one is not present.
27291 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27292 late (the message has already been created).
27293
27294 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27295 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27296 submission mode; the available options for this control are described there.
27297 The control applies only to the current message, not to any subsequent ones
27298 that may be received in the same SMTP connection.
27299
27300 .vitem &*control&~=&~suppress_local_fixups*&
27301 .cindex "submission fixups, suppressing"
27302 This control applies to locally submitted (non TCP/IP) messages, and is the
27303 complement of &`control = submission`&. It disables the fixups that are
27304 normally applied to locally-submitted messages. Specifically:
27305
27306 .ilist
27307 Any &'Sender:'& header line is left alone (in this respect, it is a
27308 dynamic version of &%local_sender_retain%&).
27309 .next
27310 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27311 .next
27312 There is no check that &'From:'& corresponds to the actual sender.
27313 .endlist ilist
27314
27315 This control may be useful when a remotely-originated message is accepted,
27316 passed to some scanning program, and then re-submitted for delivery. It can be
27317 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27318 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27319 data is read.
27320
27321 &*Note:*& This control applies only to the current message, not to any others
27322 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27323 .endlist vlist
27324
27325
27326 .section "Summary of message fixup control" "SECTsummesfix"
27327 All four possibilities for message fixups can be specified:
27328
27329 .ilist
27330 Locally submitted, fixups applied: the default.
27331 .next
27332 Locally submitted, no fixups applied: use
27333 &`control = suppress_local_fixups`&.
27334 .next
27335 Remotely submitted, no fixups applied: the default.
27336 .next
27337 Remotely submitted, fixups applied: use &`control = submission`&.
27338 .endlist
27339
27340
27341
27342 .section "Adding header lines in ACLs" "SECTaddheadacl"
27343 .cindex "header lines" "adding in an ACL"
27344 .cindex "header lines" "position of added lines"
27345 .cindex "&%add_header%& ACL modifier"
27346 The &%add_header%& modifier can be used to add one or more extra header lines
27347 to an incoming message, as in this example:
27348 .code
27349 warn dnslists = sbl.spamhaus.org : \
27350                 dialup.mail-abuse.org
27351      add_header = X-blacklisted-at: $dnslist_domain
27352 .endd
27353 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27354 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27355 receiving a message). The message must ultimately be accepted for
27356 &%add_header%& to have any significant effect. You can use &%add_header%& with
27357 any ACL verb, including &%deny%& (though this is potentially useful only in a
27358 RCPT ACL).
27359
27360 Leading and trailing newlines are removed from
27361 the data for the &%add_header%& modifier; if it then
27362 contains one or more newlines that
27363 are not followed by a space or a tab, it is assumed to contain multiple header
27364 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27365 front of any line that is not a valid header line.
27366
27367 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27368 They are added to the message before processing the DATA and MIME ACLs.
27369 However, if an identical header line is requested more than once, only one copy
27370 is actually added to the message. Further header lines may be accumulated
27371 during the DATA and MIME ACLs, after which they are added to the message, again
27372 with duplicates suppressed. Thus, it is possible to add two identical header
27373 lines to an SMTP message, but only if one is added before DATA and one after.
27374 In the case of non-SMTP messages, new headers are accumulated during the
27375 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27376 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27377 are included in the entry that is written to the reject log.
27378
27379 .cindex "header lines" "added; visibility of"
27380 Header lines are not visible in string expansions
27381 of message headers
27382 until they are added to the
27383 message. It follows that header lines defined in the MAIL, RCPT, and predata
27384 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27385 header lines that are added by the DATA or MIME ACLs are not visible in those
27386 ACLs. Because of this restriction, you cannot use header lines as a way of
27387 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27388 this, you can use ACL variables, as described in section
27389 &<<SECTaclvariables>>&.
27390
27391 The list of headers yet to be added is given by the &%$headers_added%& variable.
27392
27393 The &%add_header%& modifier acts immediately as it is encountered during the
27394 processing of an ACL. Notice the difference between these two cases:
27395 .display
27396 &`accept add_header = ADDED: some text`&
27397 &`       `&<&'some condition'&>
27398
27399 &`accept `&<&'some condition'&>
27400 &`       add_header = ADDED: some text`&
27401 .endd
27402 In the first case, the header line is always added, whether or not the
27403 condition is true. In the second case, the header line is added only if the
27404 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27405 ACL statement. All those that are encountered before a condition fails are
27406 honoured.
27407
27408 .cindex "&%warn%& ACL verb"
27409 For compatibility with previous versions of Exim, a &%message%& modifier for a
27410 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27411 effect only if all the conditions are true, even if it appears before some of
27412 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27413 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27414 are present on a &%warn%& verb, both are processed according to their
27415 specifications.
27416
27417 By default, new header lines are added to a message at the end of the existing
27418 header lines. However, you can specify that any particular header line should
27419 be added right at the start (before all the &'Received:'& lines), immediately
27420 after the first block of &'Received:'& lines, or immediately before any line
27421 that is not a &'Received:'& or &'Resent-something:'& header.
27422
27423 This is done by specifying &":at_start:"&, &":after_received:"&, or
27424 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27425 header line, respectively. (Header text cannot start with a colon, as there has
27426 to be a header name first.) For example:
27427 .code
27428 warn add_header = \
27429        :after_received:X-My-Header: something or other...
27430 .endd
27431 If more than one header line is supplied in a single &%add_header%& modifier,
27432 each one is treated independently and can therefore be placed differently. If
27433 you add more than one line at the start, or after the Received: block, they end
27434 up in reverse order.
27435
27436 &*Warning*&: This facility currently applies only to header lines that are
27437 added in an ACL. It does NOT work for header lines that are added in a
27438 system filter or in a router or transport.
27439
27440
27441
27442 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27443 .cindex "header lines" "removing in an ACL"
27444 .cindex "header lines" "position of removed lines"
27445 .cindex "&%remove_header%& ACL modifier"
27446 The &%remove_header%& modifier can be used to remove one or more header lines
27447 from an incoming message, as in this example:
27448 .code
27449 warn   message        = Remove internal headers
27450        remove_header  = x-route-mail1 : x-route-mail2
27451 .endd
27452 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27453 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27454 receiving a message). The message must ultimately be accepted for
27455 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27456 with any ACL verb, including &%deny%&, though this is really not useful for
27457 any verb that doesn't result in a delivered message.
27458
27459 More than one header can be removed at the same time by using a colon separated
27460 list of header names. The header matching is case insensitive. Wildcards are
27461 not permitted, nor is list expansion performed, so you cannot use hostlists to
27462 create a list of headers, however both connection and message variable expansion
27463 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27464 .code
27465 warn   hosts           = +internal_hosts
27466        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27467 warn   message         = Remove internal headers
27468        remove_header   = $acl_c_ihdrs
27469 .endd
27470 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27471 They are removed from the message before processing the DATA and MIME ACLs.
27472 There is no harm in attempting to remove the same header twice nor is removing
27473 a non-existent header. Further header lines to be removed may be accumulated
27474 during the DATA and MIME ACLs, after which they are removed from the message,
27475 if present. In the case of non-SMTP messages, headers to be removed are
27476 accumulated during the non-SMTP ACLs, and are removed from the message after
27477 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27478 ACL, there really is no effect because there is no logging of what headers
27479 would have been removed.
27480
27481 .cindex "header lines" "removed; visibility of"
27482 Header lines are not visible in string expansions until the DATA phase when it
27483 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27484 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27485 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27486 this restriction, you cannot use header lines as a way of controlling data
27487 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27488 you should instead use ACL variables, as described in section
27489 &<<SECTaclvariables>>&.
27490
27491 The &%remove_header%& modifier acts immediately as it is encountered during the
27492 processing of an ACL. Notice the difference between these two cases:
27493 .display
27494 &`accept remove_header = X-Internal`&
27495 &`       `&<&'some condition'&>
27496
27497 &`accept `&<&'some condition'&>
27498 &`       remove_header = X-Internal`&
27499 .endd
27500 In the first case, the header line is always removed, whether or not the
27501 condition is true. In the second case, the header line is removed only if the
27502 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27503 same ACL statement. All those that are encountered before a condition fails
27504 are honoured.
27505
27506 &*Warning*&: This facility currently applies only to header lines that are
27507 present during ACL processing. It does NOT remove header lines that are added
27508 in a system filter or in a router or transport.
27509
27510
27511
27512
27513
27514 .section "ACL conditions" "SECTaclconditions"
27515 .cindex "&ACL;" "conditions; list of"
27516 Some of the conditions listed in this section are available only when Exim is
27517 compiled with the content-scanning extension. They are included here briefly
27518 for completeness. More detailed descriptions can be found in the discussion on
27519 content scanning in chapter &<<CHAPexiscan>>&.
27520
27521 Not all conditions are relevant in all circumstances. For example, testing
27522 senders and recipients does not make sense in an ACL that is being run as the
27523 result of the arrival of an ETRN command, and checks on message headers can be
27524 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27525 can use the same condition (with different parameters) more than once in the
27526 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27527 The conditions are as follows:
27528
27529
27530 .vlist
27531 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27532 .cindex "&ACL;" "nested"
27533 .cindex "&ACL;" "indirect"
27534 .cindex "&ACL;" "arguments"
27535 .cindex "&%acl%& ACL condition"
27536 The possible values of the argument are the same as for the
27537 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27538 &"accept"& the condition is true; if it returns &"deny"& the condition is
27539 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27540 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27541 condition false. This means that further processing of the &%warn%& verb
27542 ceases, but processing of the ACL continues.
27543
27544 If the argument is a named ACL, up to nine space-separated optional values
27545 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27546 and $acl_narg is set to the count of values.
27547 Previous values of these variables are restored after the call returns.
27548 The name and values are expanded separately.
27549
27550 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27551 the connection is dropped. If it returns &"discard"&, the verb must be
27552 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27553 conditions are tested.
27554
27555 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27556 loops. This condition allows you to use different ACLs in different
27557 circumstances. For example, different ACLs can be used to handle RCPT commands
27558 for different local users or different local domains.
27559
27560 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27561 .cindex "&%authenticated%& ACL condition"
27562 .cindex "authentication" "ACL checking"
27563 .cindex "&ACL;" "testing for authentication"
27564 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27565 the name of the authenticator is tested against the list. To test for
27566 authentication by any authenticator, you can set
27567 .code
27568 authenticated = *
27569 .endd
27570
27571 .vitem &*condition&~=&~*&<&'string'&>
27572 .cindex "&%condition%& ACL condition"
27573 .cindex "customizing" "ACL condition"
27574 .cindex "&ACL;" "customized test"
27575 .cindex "&ACL;" "testing, customized"
27576 This feature allows you to make up custom conditions. If the result of
27577 expanding the string is an empty string, the number zero, or one of the strings
27578 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27579 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27580 any other value, some error is assumed to have occurred, and the ACL returns
27581 &"defer"&. However, if the expansion is forced to fail, the condition is
27582 ignored. The effect is to treat it as true, whether it is positive or
27583 negative.
27584
27585 .vitem &*decode&~=&~*&<&'location'&>
27586 .cindex "&%decode%& ACL condition"
27587 This condition is available only when Exim is compiled with the
27588 content-scanning extension, and it is allowed only in the ACL defined by
27589 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27590 If all goes well, the condition is true. It is false only if there are
27591 problems such as a syntax error or a memory shortage. For more details, see
27592 chapter &<<CHAPexiscan>>&.
27593
27594 .vitem &*demime&~=&~*&<&'extension&~list'&>
27595 .cindex "&%demime%& ACL condition"
27596 This condition is available only when Exim is compiled with the
27597 content-scanning extension. Its use is described in section
27598 &<<SECTdemimecond>>&.
27599
27600 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27601 .cindex "&%dnslists%& ACL condition"
27602 .cindex "DNS list" "in ACL"
27603 .cindex "black list (DNS)"
27604 .cindex "&ACL;" "testing a DNS list"
27605 This condition checks for entries in DNS black lists. These are also known as
27606 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27607 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27608 different variants of this condition to describe briefly here. See sections
27609 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27610
27611 .vitem &*domains&~=&~*&<&'domain&~list'&>
27612 .cindex "&%domains%& ACL condition"
27613 .cindex "domain" "ACL checking"
27614 .cindex "&ACL;" "testing a recipient domain"
27615 .vindex "&$domain_data$&"
27616 This condition is relevant only after a RCPT command. It checks that the domain
27617 of the recipient address is in the domain list. If percent-hack processing is
27618 enabled, it is done before this test is done. If the check succeeds with a
27619 lookup, the result of the lookup is placed in &$domain_data$& until the next
27620 &%domains%& test.
27621
27622 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27623 use &%domains%& in a DATA ACL.
27624
27625
27626 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27627 .cindex "&%encrypted%& ACL condition"
27628 .cindex "encryption" "checking in an ACL"
27629 .cindex "&ACL;" "testing for encryption"
27630 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27631 name of the cipher suite in use is tested against the list. To test for
27632 encryption without testing for any specific cipher suite(s), set
27633 .code
27634 encrypted = *
27635 .endd
27636
27637
27638 .vitem &*hosts&~=&~*&<&'host&~list'&>
27639 .cindex "&%hosts%& ACL condition"
27640 .cindex "host" "ACL checking"
27641 .cindex "&ACL;" "testing the client host"
27642 This condition tests that the calling host matches the host list. If you have
27643 name lookups or wildcarded host names and IP addresses in the same host list,
27644 you should normally put the IP addresses first. For example, you could have:
27645 .code
27646 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27647 .endd
27648 The lookup in this example uses the host name for its key. This is implied by
27649 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27650 and it wouldn't matter which way round you had these two items.)
27651
27652 The reason for the problem with host names lies in the left-to-right way that
27653 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27654 but when it reaches an item that requires a host name, it fails if it cannot
27655 find a host name to compare with the pattern. If the above list is given in the
27656 opposite order, the &%accept%& statement fails for a host whose name cannot be
27657 found, even if its IP address is 10.9.8.7.
27658
27659 If you really do want to do the name check first, and still recognize the IP
27660 address even if the name lookup fails, you can rewrite the ACL like this:
27661 .code
27662 accept hosts = dbm;/etc/friendly/hosts
27663 accept hosts = 10.9.8.7
27664 .endd
27665 The default action on failing to find the host name is to assume that the host
27666 is not in the list, so the first &%accept%& statement fails. The second
27667 statement can then check the IP address.
27668
27669 .vindex "&$host_data$&"
27670 If a &%hosts%& condition is satisfied by means of a lookup, the result
27671 of the lookup is made available in the &$host_data$& variable. This
27672 allows you, for example, to set up a statement like this:
27673 .code
27674 deny  hosts = net-lsearch;/some/file
27675 message = $host_data
27676 .endd
27677 which gives a custom error message for each denied host.
27678
27679 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27680 .cindex "&%local_parts%& ACL condition"
27681 .cindex "local part" "ACL checking"
27682 .cindex "&ACL;" "testing a local part"
27683 .vindex "&$local_part_data$&"
27684 This condition is relevant only after a RCPT command. It checks that the local
27685 part of the recipient address is in the list. If percent-hack processing is
27686 enabled, it is done before this test. If the check succeeds with a lookup, the
27687 result of the lookup is placed in &$local_part_data$&, which remains set until
27688 the next &%local_parts%& test.
27689
27690 .vitem &*malware&~=&~*&<&'option'&>
27691 .cindex "&%malware%& ACL condition"
27692 .cindex "&ACL;" "virus scanning"
27693 .cindex "&ACL;" "scanning for viruses"
27694 This condition is available only when Exim is compiled with the
27695 content-scanning extension. It causes the incoming message to be scanned for
27696 viruses. For details, see chapter &<<CHAPexiscan>>&.
27697
27698 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27699 .cindex "&%mime_regex%& ACL condition"
27700 .cindex "&ACL;" "testing by regex matching"
27701 This condition is available only when Exim is compiled with the
27702 content-scanning extension, and it is allowed only in the ACL defined by
27703 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27704 with any of the regular expressions. For details, see chapter
27705 &<<CHAPexiscan>>&.
27706
27707 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27708 .cindex "rate limiting"
27709 This condition can be used to limit the rate at which a user or host submits
27710 messages. Details are given in section &<<SECTratelimiting>>&.
27711
27712 .vitem &*recipients&~=&~*&<&'address&~list'&>
27713 .cindex "&%recipients%& ACL condition"
27714 .cindex "recipient" "ACL checking"
27715 .cindex "&ACL;" "testing a recipient"
27716 This condition is relevant only after a RCPT command. It checks the entire
27717 recipient address against a list of recipients.
27718
27719 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27720 .cindex "&%regex%& ACL condition"
27721 .cindex "&ACL;" "testing by regex matching"
27722 This condition is available only when Exim is compiled with the
27723 content-scanning extension, and is available only in the DATA, MIME, and
27724 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27725 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27726
27727 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27728 .cindex "&%sender_domains%& ACL condition"
27729 .cindex "sender" "ACL checking"
27730 .cindex "&ACL;" "testing a sender domain"
27731 .vindex "&$domain$&"
27732 .vindex "&$sender_address_domain$&"
27733 This condition tests the domain of the sender of the message against the given
27734 domain list. &*Note*&: The domain of the sender address is in
27735 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27736 of this condition. This is an exception to the general rule for testing domain
27737 lists. It is done this way so that, if this condition is used in an ACL for a
27738 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27739 influence the sender checking.
27740
27741 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27742 relaying, because sender addresses are easily, and commonly, forged.
27743
27744 .vitem &*senders&~=&~*&<&'address&~list'&>
27745 .cindex "&%senders%& ACL condition"
27746 .cindex "sender" "ACL checking"
27747 .cindex "&ACL;" "testing a sender"
27748 This condition tests the sender of the message against the given list. To test
27749 for a bounce message, which has an empty sender, set
27750 .code
27751 senders = :
27752 .endd
27753 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27754 relaying, because sender addresses are easily, and commonly, forged.
27755
27756 .vitem &*spam&~=&~*&<&'username'&>
27757 .cindex "&%spam%& ACL condition"
27758 .cindex "&ACL;" "scanning for spam"
27759 This condition is available only when Exim is compiled with the
27760 content-scanning extension. It causes the incoming message to be scanned by
27761 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27762
27763 .vitem &*verify&~=&~certificate*&
27764 .cindex "&%verify%& ACL condition"
27765 .cindex "TLS" "client certificate verification"
27766 .cindex "certificate" "verification of client"
27767 .cindex "&ACL;" "certificate verification"
27768 .cindex "&ACL;" "testing a TLS certificate"
27769 This condition is true in an SMTP session if the session is encrypted, and a
27770 certificate was received from the client, and the certificate was verified. The
27771 server requests a certificate only if the client matches &%tls_verify_hosts%&
27772 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27773
27774 .vitem &*verify&~=&~csa*&
27775 .cindex "CSA verification"
27776 This condition checks whether the sending host (the client) is authorized to
27777 send email. Details of how this works are given in section
27778 &<<SECTverifyCSA>>&.
27779
27780 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27781 .cindex "&%verify%& ACL condition"
27782 .cindex "&ACL;" "verifying sender in the header"
27783 .cindex "header lines" "verifying the sender in"
27784 .cindex "sender" "verifying in header"
27785 .cindex "verifying" "sender in header"
27786 This condition is relevant only in an ACL that is run after a message has been
27787 received, that is, in an ACL specified by &%acl_smtp_data%& or
27788 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27789 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27790 is loosely thought of as a &"sender"& address (hence the name of the test).
27791 However, an address that appears in one of these headers need not be an address
27792 that accepts bounce messages; only sender addresses in envelopes are required
27793 to accept bounces. Therefore, if you use the callout option on this check, you
27794 might want to arrange for a non-empty address in the MAIL command.
27795
27796 Details of address verification and the options are given later, starting at
27797 section &<<SECTaddressverification>>& (callouts are described in section
27798 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27799 condition to restrict it to bounce messages only:
27800 .code
27801 deny    senders = :
27802         message = A valid sender header is required for bounces
27803        !verify  = header_sender
27804 .endd
27805
27806 .vitem &*verify&~=&~header_syntax*&
27807 .cindex "&%verify%& ACL condition"
27808 .cindex "&ACL;" "verifying header syntax"
27809 .cindex "header lines" "verifying syntax"
27810 .cindex "verifying" "header syntax"
27811 This condition is relevant only in an ACL that is run after a message has been
27812 received, that is, in an ACL specified by &%acl_smtp_data%& or
27813 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27814 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27815 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27816 permitted only in locally generated messages and from hosts that match
27817 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27818 appropriate.
27819
27820 Note that this condition is a syntax check only. However, a common spamming
27821 ploy used to be to send syntactically invalid headers such as
27822 .code
27823 To: @
27824 .endd
27825 and this condition can be used to reject such messages, though they are not as
27826 common as they used to be.
27827
27828 .vitem &*verify&~=&~helo*&
27829 .cindex "&%verify%& ACL condition"
27830 .cindex "&ACL;" "verifying HELO/EHLO"
27831 .cindex "HELO" "verifying"
27832 .cindex "EHLO" "verifying"
27833 .cindex "verifying" "EHLO"
27834 .cindex "verifying" "HELO"
27835 This condition is true if a HELO or EHLO command has been received from the
27836 client host, and its contents have been verified. If there has been no previous
27837 attempt to verify the HELO/EHLO contents, it is carried out when this
27838 condition is encountered. See the description of the &%helo_verify_hosts%& and
27839 &%helo_try_verify_hosts%& options for details of how to request verification
27840 independently of this condition.
27841
27842 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27843 option), this condition is always true.
27844
27845
27846 .vitem &*verify&~=&~not_blind*&
27847 .cindex "verifying" "not blind"
27848 .cindex "bcc recipients, verifying none"
27849 This condition checks that there are no blind (bcc) recipients in the message.
27850 Every envelope recipient must appear either in a &'To:'& header line or in a
27851 &'Cc:'& header line for this condition to be true. Local parts are checked
27852 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27853 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27854 used only in a DATA or non-SMTP ACL.
27855
27856 There are, of course, many legitimate messages that make use of blind (bcc)
27857 recipients. This check should not be used on its own for blocking messages.
27858
27859
27860 .vitem &*verify&~=&~recipient/*&<&'options'&>
27861 .cindex "&%verify%& ACL condition"
27862 .cindex "&ACL;" "verifying recipient"
27863 .cindex "recipient" "verifying"
27864 .cindex "verifying" "recipient"
27865 .vindex "&$address_data$&"
27866 This condition is relevant only after a RCPT command. It verifies the current
27867 recipient. Details of address verification are given later, starting at section
27868 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27869 of &$address_data$& is the last value that was set while routing the address.
27870 This applies even if the verification fails. When an address that is being
27871 verified is redirected to a single address, verification continues with the new
27872 address, and in that case, the subsequent value of &$address_data$& is the
27873 value for the child address.
27874
27875 .vitem &*verify&~=&~reverse_host_lookup*&
27876 .cindex "&%verify%& ACL condition"
27877 .cindex "&ACL;" "verifying host reverse lookup"
27878 .cindex "host" "verifying reverse lookup"
27879 This condition ensures that a verified host name has been looked up from the IP
27880 address of the client host. (This may have happened already if the host name
27881 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27882 Verification ensures that the host name obtained from a reverse DNS lookup, or
27883 one of its aliases, does, when it is itself looked up in the DNS, yield the
27884 original IP address.
27885
27886 If this condition is used for a locally generated message (that is, when there
27887 is no client host involved), it always succeeds.
27888
27889 .vitem &*verify&~=&~sender/*&<&'options'&>
27890 .cindex "&%verify%& ACL condition"
27891 .cindex "&ACL;" "verifying sender"
27892 .cindex "sender" "verifying"
27893 .cindex "verifying" "sender"
27894 This condition is relevant only after a MAIL or RCPT command, or after a
27895 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27896 the message's sender is empty (that is, this is a bounce message), the
27897 condition is true. Otherwise, the sender address is verified.
27898
27899 .vindex "&$address_data$&"
27900 .vindex "&$sender_address_data$&"
27901 If there is data in the &$address_data$& variable at the end of routing, its
27902 value is placed in &$sender_address_data$& at the end of verification. This
27903 value can be used in subsequent conditions and modifiers in the same ACL
27904 statement. It does not persist after the end of the current statement. If you
27905 want to preserve the value for longer, you can save it in an ACL variable.
27906
27907 Details of verification are given later, starting at section
27908 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27909 to avoid doing it more than once per message.
27910
27911 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27912 .cindex "&%verify%& ACL condition"
27913 This is a variation of the previous option, in which a modified address is
27914 verified as a sender.
27915 .endlist
27916
27917
27918
27919 .section "Using DNS lists" "SECTmorednslists"
27920 .cindex "DNS list" "in ACL"
27921 .cindex "black list (DNS)"
27922 .cindex "&ACL;" "testing a DNS list"
27923 In its simplest form, the &%dnslists%& condition tests whether the calling host
27924 is on at least one of a number of DNS lists by looking up the inverted IP
27925 address in one or more DNS domains. (Note that DNS list domains are not mail
27926 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27927 special options instead.) For example, if the calling host's IP
27928 address is 192.168.62.43, and the ACL statement is
27929 .code
27930 deny dnslists = blackholes.mail-abuse.org : \
27931                 dialups.mail-abuse.org
27932 .endd
27933 the following records are looked up:
27934 .code
27935 43.62.168.192.blackholes.mail-abuse.org
27936 43.62.168.192.dialups.mail-abuse.org
27937 .endd
27938 As soon as Exim finds an existing DNS record, processing of the list stops.
27939 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27940 to test that a host is on more than one list (an &"and"& conjunction), you can
27941 use two separate conditions:
27942 .code
27943 deny dnslists = blackholes.mail-abuse.org
27944      dnslists = dialups.mail-abuse.org
27945 .endd
27946 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27947 behaves as if the host does not match the list item, that is, as if the DNS
27948 record does not exist. If there are further items in the DNS list, they are
27949 processed.
27950
27951 This is usually the required action when &%dnslists%& is used with &%deny%&
27952 (which is the most common usage), because it prevents a DNS failure from
27953 blocking mail. However, you can change this behaviour by putting one of the
27954 following special items in the list:
27955 .display
27956 &`+include_unknown `&   behave as if the item is on the list
27957 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27958 &`+defer_unknown   `&   give a temporary error
27959 .endd
27960 .cindex "&`+include_unknown`&"
27961 .cindex "&`+exclude_unknown`&"
27962 .cindex "&`+defer_unknown`&"
27963 Each of these applies to any subsequent items on the list. For example:
27964 .code
27965 deny dnslists = +defer_unknown : foo.bar.example
27966 .endd
27967 Testing the list of domains stops as soon as a match is found. If you want to
27968 warn for one list and block for another, you can use two different statements:
27969 .code
27970 deny  dnslists = blackholes.mail-abuse.org
27971 warn  message  = X-Warn: sending host is on dialups list
27972       dnslists = dialups.mail-abuse.org
27973 .endd
27974 DNS list lookups are cached by Exim for the duration of the SMTP session,
27975 so a lookup based on the IP address is done at most once for any incoming
27976 connection. Exim does not share information between multiple incoming
27977 connections (but your local name server cache should be active).
27978
27979
27980
27981 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27982 .cindex "DNS list" "keyed by explicit IP address"
27983 By default, the IP address that is used in a DNS list lookup is the IP address
27984 of the calling host. However, you can specify another IP address by listing it
27985 after the domain name, introduced by a slash. For example:
27986 .code
27987 deny dnslists = black.list.tld/192.168.1.2
27988 .endd
27989 This feature is not very helpful with explicit IP addresses; it is intended for
27990 use with IP addresses that are looked up, for example, the IP addresses of the
27991 MX hosts or nameservers of an email sender address. For an example, see section
27992 &<<SECTmulkeyfor>>& below.
27993
27994
27995
27996
27997 .section "DNS lists keyed on domain names" "SECID202"
27998 .cindex "DNS list" "keyed by domain name"
27999 There are some lists that are keyed on domain names rather than inverted IP
28000 addresses (see for example the &'domain based zones'& link at
28001 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28002 with these lists. You can change the name that is looked up in a DNS list by
28003 listing it after the domain name, introduced by a slash. For example,
28004 .code
28005 deny  message  = Sender's domain is listed at $dnslist_domain
28006       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28007 .endd
28008 This particular example is useful only in ACLs that are obeyed after the
28009 RCPT or DATA commands, when a sender address is available. If (for
28010 example) the message's sender is &'user@tld.example'& the name that is looked
28011 up by this example is
28012 .code
28013 tld.example.dsn.rfc-ignorant.org
28014 .endd
28015 A single &%dnslists%& condition can contain entries for both names and IP
28016 addresses. For example:
28017 .code
28018 deny dnslists = sbl.spamhaus.org : \
28019                 dsn.rfc-ignorant.org/$sender_address_domain
28020 .endd
28021 The first item checks the sending host's IP address; the second checks a domain
28022 name. The whole condition is true if either of the DNS lookups succeeds.
28023
28024
28025
28026
28027 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28028 .cindex "DNS list" "multiple keys for"
28029 The syntax described above for looking up explicitly-defined values (either
28030 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28031 name for the DNS list, what follows the slash can in fact be a list of items.
28032 As with all lists in Exim, the default separator is a colon. However, because
28033 this is a sublist within the list of DNS blacklist domains, it is necessary
28034 either to double the separators like this:
28035 .code
28036 dnslists = black.list.tld/name.1::name.2
28037 .endd
28038 or to change the separator character, like this:
28039 .code
28040 dnslists = black.list.tld/<;name.1;name.2
28041 .endd
28042 If an item in the list is an IP address, it is inverted before the DNS
28043 blacklist domain is appended. If it is not an IP address, no inversion
28044 occurs. Consider this condition:
28045 .code
28046 dnslists = black.list.tld/<;192.168.1.2;a.domain
28047 .endd
28048 The DNS lookups that occur are:
28049 .code
28050 2.1.168.192.black.list.tld
28051 a.domain.black.list.tld
28052 .endd
28053 Once a DNS record has been found (that matches a specific IP return
28054 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28055 are done. If there is a temporary DNS error, the rest of the sublist of domains
28056 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28057 only if no other DNS lookup in this sublist succeeds. In other words, a
28058 successful lookup for any of the items in the sublist overrides a temporary
28059 error for a previous item.
28060
28061 The ability to supply a list of items after the slash is in some sense just a
28062 syntactic convenience. These two examples have the same effect:
28063 .code
28064 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28065 dnslists = black.list.tld/a.domain::b.domain
28066 .endd
28067 However, when the data for the list is obtained from a lookup, the second form
28068 is usually much more convenient. Consider this example:
28069 .code
28070 deny message  = The mail servers for the domain \
28071                 $sender_address_domain \
28072                 are listed at $dnslist_domain ($dnslist_value); \
28073                 see $dnslist_text.
28074      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28075                                    ${lookup dnsdb {>|mxh=\
28076                                    $sender_address_domain} }} }
28077 .endd
28078 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28079 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28080 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28081 of expanding the condition might be something like this:
28082 .code
28083 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28084 .endd
28085 Thus, this example checks whether or not the IP addresses of the sender
28086 domain's mail servers are on the Spamhaus black list.
28087
28088 The key that was used for a successful DNS list lookup is put into the variable
28089 &$dnslist_matched$& (see section &<<SECID204>>&).
28090
28091
28092
28093
28094 .section "Data returned by DNS lists" "SECID203"
28095 .cindex "DNS list" "data returned from"
28096 DNS lists are constructed using address records in the DNS. The original RBL
28097 just used the address 127.0.0.1 on the right hand side of each record, but the
28098 RBL+ list and some other lists use a number of values with different meanings.
28099 The values used on the RBL+ list are:
28100 .display
28101 127.1.0.1  RBL
28102 127.1.0.2  DUL
28103 127.1.0.3  DUL and RBL
28104 127.1.0.4  RSS
28105 127.1.0.5  RSS and RBL
28106 127.1.0.6  RSS and DUL
28107 127.1.0.7  RSS and DUL and RBL
28108 .endd
28109 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28110 different values. Some DNS lists may return more than one address record;
28111 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28112
28113
28114 .section "Variables set from DNS lists" "SECID204"
28115 .cindex "expansion" "variables, set from DNS list"
28116 .cindex "DNS list" "variables set from"
28117 .vindex "&$dnslist_domain$&"
28118 .vindex "&$dnslist_matched$&"
28119 .vindex "&$dnslist_text$&"
28120 .vindex "&$dnslist_value$&"
28121 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28122 the name of the overall domain that matched (for example,
28123 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28124 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28125 the DNS record. When the key is an IP address, it is not reversed in
28126 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28127 cases, for example:
28128 .code
28129 deny dnslists = spamhaus.example
28130 .endd
28131 the key is also available in another variable (in this case,
28132 &$sender_host_address$&). In more complicated cases, however, this is not true.
28133 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28134 might generate a dnslists lookup like this:
28135 .code
28136 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28137 .endd
28138 If this condition succeeds, the value in &$dnslist_matched$& might be
28139 &`192.168.6.7`& (for example).
28140
28141 If more than one address record is returned by the DNS lookup, all the IP
28142 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28143 The variable &$dnslist_text$& contains the contents of any associated TXT
28144 record. For lists such as RBL+ the TXT record for a merged entry is often not
28145 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28146 information.
28147
28148 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28149 &-- although these appear before the condition in the ACL, they are not
28150 expanded until after it has failed. For example:
28151 .code
28152 deny    hosts = !+local_networks
28153         message = $sender_host_address is listed \
28154                   at $dnslist_domain
28155         dnslists = rbl-plus.mail-abuse.example
28156 .endd
28157
28158
28159
28160 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28161 .cindex "DNS list" "matching specific returned data"
28162 You can add an equals sign and an IP address after a &%dnslists%& domain name
28163 in order to restrict its action to DNS records with a matching right hand side.
28164 For example,
28165 .code
28166 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28167 .endd
28168 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28169 any address record is considered to be a match. For the moment, we assume
28170 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28171 describes how multiple records are handled.
28172
28173 More than one IP address may be given for checking, using a comma as a
28174 separator. These are alternatives &-- if any one of them matches, the
28175 &%dnslists%& condition is true. For example:
28176 .code
28177 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28178 .endd
28179 If you want to specify a constraining address list and also specify names or IP
28180 addresses to be looked up, the constraining address list must be specified
28181 first. For example:
28182 .code
28183 deny dnslists = dsn.rfc-ignorant.org\
28184                 =127.0.0.2/$sender_address_domain
28185 .endd
28186
28187 If the character &`&&`& is used instead of &`=`&, the comparison for each
28188 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28189 In other words, the listed addresses are used as bit masks. The comparison is
28190 true if all the bits in the mask are present in the address that is being
28191 tested. For example:
28192 .code
28193 dnslists = a.b.c&0.0.0.3
28194 .endd
28195 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28196 want to test whether one bit or another bit is present (as opposed to both
28197 being present), you must use multiple values. For example:
28198 .code
28199 dnslists = a.b.c&0.0.0.1,0.0.0.2
28200 .endd
28201 matches if the final component of the address is an odd number or two times
28202 an odd number.
28203
28204
28205
28206 .section "Negated DNS matching conditions" "SECID205"
28207 You can supply a negative list of IP addresses as part of a &%dnslists%&
28208 condition. Whereas
28209 .code
28210 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28211 .endd
28212 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28213 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28214 .code
28215 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28216 .endd
28217 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28218 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28219 words, the result of the test is inverted if an exclamation mark appears before
28220 the &`=`& (or the &`&&`&) sign.
28221
28222 &*Note*&: This kind of negation is not the same as negation in a domain,
28223 host, or address list (which is why the syntax is different).
28224
28225 If you are using just one list, the negation syntax does not gain you much. The
28226 previous example is precisely equivalent to
28227 .code
28228 deny  dnslists = a.b.c
28229      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28230 .endd
28231 However, if you are using multiple lists, the negation syntax is clearer.
28232 Consider this example:
28233 .code
28234 deny  dnslists = sbl.spamhaus.org : \
28235                  list.dsbl.org : \
28236                  dnsbl.njabl.org!=127.0.0.3 : \
28237                  relays.ordb.org
28238 .endd
28239 Using only positive lists, this would have to be:
28240 .code
28241 deny  dnslists = sbl.spamhaus.org : \
28242                  list.dsbl.org
28243 deny  dnslists = dnsbl.njabl.org
28244      !dnslists = dnsbl.njabl.org=127.0.0.3
28245 deny  dnslists = relays.ordb.org
28246 .endd
28247 which is less clear, and harder to maintain.
28248
28249
28250
28251
28252 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28253 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28254 thereby providing more than one IP address. When an item in a &%dnslists%& list
28255 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28256 the match to specific results from the DNS lookup, there are two ways in which
28257 the checking can be handled. For example, consider the condition:
28258 .code
28259 dnslists = a.b.c=127.0.0.1
28260 .endd
28261 What happens if the DNS lookup for the incoming IP address yields both
28262 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28263 condition true because at least one given value was found, or is it false
28264 because at least one of the found values was not listed? And how does this
28265 affect negated conditions? Both possibilities are provided for with the help of
28266 additional separators &`==`& and &`=&&`&.
28267
28268 .ilist
28269 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28270 IP addresses matches one of the listed addresses. For the example above, the
28271 condition is true because 127.0.0.1 matches.
28272 .next
28273 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28274 looked up IP addresses matches one of the listed addresses. If the condition is
28275 changed to:
28276 .code
28277 dnslists = a.b.c==127.0.0.1
28278 .endd
28279 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28280 false because 127.0.0.2 is not listed. You would need to have:
28281 .code
28282 dnslists = a.b.c==127.0.0.1,127.0.0.2
28283 .endd
28284 for the condition to be true.
28285 .endlist
28286
28287 When &`!`& is used to negate IP address matching, it inverts the result, giving
28288 the precise opposite of the behaviour above. Thus:
28289 .ilist
28290 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28291 addresses matches one of the listed addresses. Consider:
28292 .code
28293 dnslists = a.b.c!&0.0.0.1
28294 .endd
28295 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28296 false because 127.0.0.1 matches.
28297 .next
28298 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28299 looked up IP address that does not match. Consider:
28300 .code
28301 dnslists = a.b.c!=&0.0.0.1
28302 .endd
28303 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28304 true, because 127.0.0.2 does not match. You would need to have:
28305 .code
28306 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28307 .endd
28308 for the condition to be false.
28309 .endlist
28310 When the DNS lookup yields only a single IP address, there is no difference
28311 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28312
28313
28314
28315
28316 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28317 .cindex "DNS list" "information from merged"
28318 When the facility for restricting the matching IP values in a DNS list is used,
28319 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28320 the true reason for rejection. This happens when lists are merged and the IP
28321 address in the A record is used to distinguish them; unfortunately there is
28322 only one TXT record. One way round this is not to use merged lists, but that
28323 can be inefficient because it requires multiple DNS lookups where one would do
28324 in the vast majority of cases when the host of interest is not on any of the
28325 lists.
28326
28327 A less inefficient way of solving this problem is available. If
28328 two domain names, comma-separated, are given, the second is used first to
28329 do an initial check, making use of any IP value restrictions that are set.
28330 If there is a match, the first domain is used, without any IP value
28331 restrictions, to get the TXT record. As a byproduct of this, there is also
28332 a check that the IP being tested is indeed on the first list. The first
28333 domain is the one that is put in &$dnslist_domain$&. For example:
28334 .code
28335 reject message  = \
28336          rejected because $sender_host_address is blacklisted \
28337          at $dnslist_domain\n$dnslist_text
28338        dnslists = \
28339          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28340          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28341 .endd
28342 For the first blacklist item, this starts by doing a lookup in
28343 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28344 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28345 value, and as long as something is found, it looks for the corresponding TXT
28346 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28347 The second blacklist item is processed similarly.
28348
28349 If you are interested in more than one merged list, the same list must be
28350 given several times, but because the results of the DNS lookups are cached,
28351 the DNS calls themselves are not repeated. For example:
28352 .code
28353 reject dnslists = \
28354          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28355          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28356          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28357          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28358 .endd
28359 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28360 values matches (or if no record is found), this is the only lookup that is
28361 done. Only if there is a match is one of the more specific lists consulted.
28362
28363
28364
28365 .section "DNS lists and IPv6" "SECTmorednslistslast"
28366 .cindex "IPv6" "DNS black lists"
28367 .cindex "DNS list" "IPv6 usage"
28368 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28369 nibble by nibble. For example, if the calling host's IP address is
28370 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28371 .code
28372 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28373   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28374 .endd
28375 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28376 lists contain wildcard records, intended for IPv4, that interact badly with
28377 IPv6. For example, the DNS entry
28378 .code
28379 *.3.some.list.example.    A    127.0.0.1
28380 .endd
28381 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28382 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28383
28384 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28385 &%condition%& condition, as in this example:
28386 .code
28387 deny   condition = ${if isip4{$sender_host_address}}
28388        dnslists  = some.list.example
28389 .endd
28390
28391 .section "Rate limiting incoming messages" "SECTratelimiting"
28392 .cindex "rate limiting" "client sending"
28393 .cindex "limiting client sending rates"
28394 .oindex "&%smtp_ratelimit_*%&"
28395 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28396 which clients can send email. This is more powerful than the
28397 &%smtp_ratelimit_*%& options, because those options control the rate of
28398 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28399 works across all connections (concurrent and sequential) from the same client
28400 host. The syntax of the &%ratelimit%& condition is:
28401 .display
28402 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28403 .endd
28404 If the average client sending rate is less than &'m'& messages per time
28405 period &'p'& then the condition is false; otherwise it is true.
28406
28407 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28408 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28409 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28410 of &'p'&.
28411
28412 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28413 time interval, for example, &`8h`& for eight hours. A larger time constant
28414 means that it takes Exim longer to forget a client's past behaviour. The
28415 parameter &'m'& is the maximum number of messages that a client is permitted to
28416 send in each time interval. It also specifies the number of messages permitted
28417 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28418 constant, you can allow a client to send more messages in a burst without
28419 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28420 both small, messages must be sent at an even rate.
28421
28422 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28423 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28424 when deploying the &%ratelimit%& ACL condition. The script prints usage
28425 instructions when it is run with no arguments.
28426
28427 The key is used to look up the data for calculating the client's average
28428 sending rate. This data is stored in Exim's spool directory, alongside the
28429 retry and other hints databases. The default key is &$sender_host_address$&,
28430 which means Exim computes the sending rate of each client host IP address.
28431 By changing the key you can change how Exim identifies clients for the purpose
28432 of ratelimiting. For example, to limit the sending rate of each authenticated
28433 user, independent of the computer they are sending from, set the key to
28434 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28435 example, &$authenticated_id$& is only meaningful if the client has
28436 authenticated (which you can check with the &%authenticated%& ACL condition).
28437
28438 The lookup key does not have to identify clients: If you want to limit the
28439 rate at which a recipient receives messages, you can use the key
28440 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28441 ACL.
28442
28443 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28444 specifies what Exim measures the rate of, for example messages or recipients
28445 or bytes. You can adjust the measurement using the &%unique=%& and/or
28446 &%count=%& options. You can also control when Exim updates the recorded rate
28447 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28448 separated by a slash, like the other parameters. They may appear in any order.
28449
28450 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28451 any options that alter the meaning of the stored data. The limit &'m'& is not
28452 stored, so you can alter the configured maximum rate and Exim will still
28453 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28454 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28455 behaviour. The lookup key is not affected by changes to the update mode and
28456 the &%count=%& option.
28457
28458
28459 .section "Ratelimit options for what is being measured" "ratoptmea"
28460 .cindex "rate limiting" "per_* options"
28461 The &%per_conn%& option limits the client's connection rate. It is not
28462 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28463 &%acl_not_smtp_start%& ACLs.
28464
28465 The &%per_mail%& option limits the client's rate of sending messages. This is
28466 the default if none of the &%per_*%& options is specified. It can be used in
28467 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28468 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28469
28470 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28471 the same ACLs as the &%per_mail%& option, though it is best to use this option
28472 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28473 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28474 in its MAIL command, which may be inaccurate or completely missing. You can
28475 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28476 in kilobytes, megabytes, or gigabytes, respectively.
28477
28478 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28479 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28480 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28481 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28482 ACLs the rate is updated with the total recipient count in one go. Note that
28483 in either case the rate limiting engine will see a message with many
28484 recipients as a large high-speed burst.
28485
28486 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28487 number of different recipients that the client has sent messages to in the
28488 last time period. That is, if the client repeatedly sends messages to the same
28489 recipient, its measured rate is not increased. This option can only be used in
28490 &%acl_smtp_rcpt%&.
28491
28492 The &%per_cmd%& option causes Exim to recompute the rate every time the
28493 condition is processed. This can be used to limit the rate of any SMTP
28494 command. If it is used in multiple ACLs it can limit the aggregate rate of
28495 multiple different commands.
28496
28497 The &%count=%& option can be used to alter how much Exim adds to the client's
28498 measured rate. For example, the &%per_byte%& option is equivalent to
28499 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28500 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28501 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28502
28503 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28504
28505
28506 .section "Ratelimit update modes" "ratoptupd"
28507 .cindex "rate limiting" "reading data without updating"
28508 You can specify one of three options with the &%ratelimit%& condition to
28509 control when its database is updated. This section describes the &%readonly%&
28510 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28511
28512 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28513 previously-computed rate to check against the limit.
28514
28515 For example, you can test the client's sending rate and deny it access (when
28516 it is too fast) in the connect ACL. If the client passes this check then it
28517 can go on to send a message, in which case its recorded rate will be updated
28518 in the MAIL ACL. Subsequent connections from the same client will check this
28519 new rate.
28520 .code
28521 acl_check_connect:
28522  deny ratelimit = 100 / 5m / readonly
28523     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28524                   (max $sender_rate_limit)
28525 # ...
28526 acl_check_mail:
28527  warn ratelimit = 100 / 5m / strict
28528     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28529                   (max $sender_rate_limit)
28530 .endd
28531
28532 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28533 processing a message then it may increase the client's measured rate more than
28534 it should. For example, this will happen if you check the &%per_rcpt%& option
28535 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28536 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28537 multiple update problems by using the &%readonly%& option on later ratelimit
28538 checks.
28539
28540 The &%per_*%& options described above do not make sense in some ACLs. If you
28541 use a &%per_*%& option in an ACL where it is not normally permitted then the
28542 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28543 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28544 next section) so you must specify the &%readonly%& option explicitly.
28545
28546
28547 .section "Ratelimit options for handling fast clients" "ratoptfast"
28548 .cindex "rate limiting" "strict and leaky modes"
28549 If a client's average rate is greater than the maximum, the rate limiting
28550 engine can react in two possible ways, depending on the presence of the
28551 &%strict%& or &%leaky%& update modes. This is independent of the other
28552 counter-measures (such as rejecting the message) that may be specified by the
28553 rest of the ACL.
28554
28555 The &%leaky%& (default) option means that the client's recorded rate is not
28556 updated if it is above the limit. The effect of this is that Exim measures the
28557 client's average rate of successfully sent email, which cannot be greater than
28558 the maximum allowed. If the client is over the limit it may suffer some
28559 counter-measures (as specified in the ACL), but it will still be able to send
28560 email at the configured maximum rate, whatever the rate of its attempts. This
28561 is generally the better choice if you have clients that retry automatically.
28562 For example, it does not prevent a sender with an over-aggressive retry rate
28563 from getting any email through.
28564
28565 The &%strict%& option means that the client's recorded rate is always
28566 updated. The effect of this is that Exim measures the client's average rate
28567 of attempts to send email, which can be much higher than the maximum it is
28568 actually allowed. If the client is over the limit it may be subjected to
28569 counter-measures by the ACL. It must slow down and allow sufficient time to
28570 pass that its computed rate falls below the maximum before it can send email
28571 again. The time (the number of smoothing periods) it must wait and not
28572 attempt to send mail can be calculated with this formula:
28573 .code
28574         ln(peakrate/maxrate)
28575 .endd
28576
28577
28578 .section "Limiting the rate of different events" "ratoptuniq"
28579 .cindex "rate limiting" "counting unique events"
28580 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28581 rate of different events. For example, the &%per_addr%& option uses this
28582 mechanism to count the number of different recipients that the client has
28583 sent messages to in the last time period; it is equivalent to
28584 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28585 measure the rate that a client uses different sender addresses with the
28586 options &`per_mail/unique=$sender_address`&.
28587
28588 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28589 has seen for that key. The whole set is thrown away when it is older than the
28590 rate smoothing period &'p'&, so each different event is counted at most once
28591 per period. In the &%leaky%& update mode, an event that causes the client to
28592 go over the limit is not added to the set, in the same way that the client's
28593 recorded rate is not updated in the same situation.
28594
28595 When you combine the &%unique=%& and &%readonly%& options, the specific
28596 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28597 rate.
28598
28599 The &%unique=%& mechanism needs more space in the ratelimit database than the
28600 other &%ratelimit%& options in order to store the event set. The number of
28601 unique values is potentially as large as the rate limit, so the extra space
28602 required increases with larger limits.
28603
28604 The uniqueification is not perfect: there is a small probability that Exim
28605 will think a new event has happened before. If the sender's rate is less than
28606 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28607 the measured rate can go above the limit, in which case Exim may under-count
28608 events by a significant margin. Fortunately, if the rate is high enough (2.7
28609 times the limit) that the false positive rate goes above 9%, then Exim will
28610 throw away the over-full event set before the measured rate falls below the
28611 limit. Therefore the only harm should be that exceptionally high sending rates
28612 are logged incorrectly; any countermeasures you configure will be as effective
28613 as intended.
28614
28615
28616 .section "Using rate limiting" "useratlim"
28617 Exim's other ACL facilities are used to define what counter-measures are taken
28618 when the rate limit is exceeded. This might be anything from logging a warning
28619 (for example, while measuring existing sending rates in order to define
28620 policy), through time delays to slow down fast senders, up to rejecting the
28621 message. For example:
28622 .code
28623 # Log all senders' rates
28624 warn ratelimit = 0 / 1h / strict
28625      log_message = Sender rate $sender_rate / $sender_rate_period
28626
28627 # Slow down fast senders; note the need to truncate $sender_rate
28628 # at the decimal point.
28629 warn ratelimit = 100 / 1h / per_rcpt / strict
28630      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28631                    $sender_rate_limit }s
28632
28633 # Keep authenticated users under control
28634 deny authenticated = *
28635      ratelimit = 100 / 1d / strict / $authenticated_id
28636
28637 # System-wide rate limit
28638 defer message = Sorry, too busy. Try again later.
28639      ratelimit = 10 / 1s / $primary_hostname
28640
28641 # Restrict incoming rate from each host, with a default
28642 # set using a macro and special cases looked up in a table.
28643 defer message = Sender rate exceeds $sender_rate_limit \
28644                messages per $sender_rate_period
28645      ratelimit = ${lookup {$sender_host_address} \
28646                    cdb {DB/ratelimits.cdb} \
28647                    {$value} {RATELIMIT} }
28648 .endd
28649 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28650 especially with the &%per_rcpt%& option, you may suffer from a performance
28651 bottleneck caused by locking on the ratelimit hints database. Apart from
28652 making your ACLs less complicated, you can reduce the problem by using a
28653 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28654 this means that Exim will lose its hints data after a reboot (including retry
28655 hints, the callout cache, and ratelimit data).
28656
28657
28658
28659 .section "Address verification" "SECTaddressverification"
28660 .cindex "verifying address" "options for"
28661 .cindex "policy control" "address verification"
28662 Several of the &%verify%& conditions described in section
28663 &<<SECTaclconditions>>& cause addresses to be verified. Section
28664 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28665 The verification conditions can be followed by options that modify the
28666 verification process. The options are separated from the keyword and from each
28667 other by slashes, and some of them contain parameters. For example:
28668 .code
28669 verify = sender/callout
28670 verify = recipient/defer_ok/callout=10s,defer_ok
28671 .endd
28672 The first stage of address verification, which always happens, is to run the
28673 address through the routers, in &"verify mode"&. Routers can detect the
28674 difference between verification and routing for delivery, and their actions can
28675 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28676 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28677 The available options are as follows:
28678
28679 .ilist
28680 If the &%callout%& option is specified, successful routing to one or more
28681 remote hosts is followed by a &"callout"& to those hosts as an additional
28682 check. Callouts and their sub-options are discussed in the next section.
28683 .next
28684 If there is a defer error while doing verification routing, the ACL
28685 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28686 options, the condition is forced to be true instead. Note that this is a main
28687 verification option as well as a suboption for callouts.
28688 .next
28689 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28690 discusses the reporting of sender address verification failures.
28691 .next
28692 The &%success_on_redirect%& option causes verification always to succeed
28693 immediately after a successful redirection. By default, if a redirection
28694 generates just one address, that address is also verified. See further
28695 discussion in section &<<SECTredirwhilveri>>&.
28696 .endlist
28697
28698 .cindex "verifying address" "differentiating failures"
28699 .vindex "&$recipient_verify_failure$&"
28700 .vindex "&$sender_verify_failure$&"
28701 .vindex "&$acl_verify_message$&"
28702 After an address verification failure, &$acl_verify_message$& contains the
28703 error message that is associated with the failure. It can be preserved by
28704 coding like this:
28705 .code
28706 warn  !verify = sender
28707        set acl_m0 = $acl_verify_message
28708 .endd
28709 If you are writing your own custom rejection message or log message when
28710 denying access, you can use this variable to include information about the
28711 verification failure.
28712
28713 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28714 appropriate) contains one of the following words:
28715
28716 .ilist
28717 &%qualify%&: The address was unqualified (no domain), and the message
28718 was neither local nor came from an exempted host.
28719 .next
28720 &%route%&: Routing failed.
28721 .next
28722 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28723 occurred at or before the MAIL command (that is, on initial
28724 connection, HELO, or MAIL).
28725 .next
28726 &%recipient%&: The RCPT command in a callout was rejected.
28727 .next
28728 &%postmaster%&: The postmaster check in a callout was rejected.
28729 .endlist
28730
28731 The main use of these variables is expected to be to distinguish between
28732 rejections of MAIL and rejections of RCPT in callouts.
28733
28734
28735
28736
28737 .section "Callout verification" "SECTcallver"
28738 .cindex "verifying address" "by callout"
28739 .cindex "callout" "verification"
28740 .cindex "SMTP" "callout verification"
28741 For non-local addresses, routing verifies the domain, but is unable to do any
28742 checking of the local part. There are situations where some means of verifying
28743 the local part is desirable. One way this can be done is to make an SMTP
28744 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28745 a subsequent host for a recipient address, to see if the host accepts the
28746 address. We use the term &'callout'& to cover both cases. Note that for a
28747 sender address, the callback is not to the client host that is trying to
28748 deliver the message, but to one of the hosts that accepts incoming mail for the
28749 sender's domain.
28750
28751 Exim does not do callouts by default. If you want them to happen, you must
28752 request them by setting appropriate options on the &%verify%& condition, as
28753 described below. This facility should be used with care, because it can add a
28754 lot of resource usage to the cost of verifying an address. However, Exim does
28755 cache the results of callouts, which helps to reduce the cost. Details of
28756 caching are in section &<<SECTcallvercache>>&.
28757
28758 Recipient callouts are usually used only between hosts that are controlled by
28759 the same administration. For example, a corporate gateway host could use
28760 callouts to check for valid recipients on an internal mailserver. A successful
28761 callout does not guarantee that a real delivery to the address would succeed;
28762 on the other hand, a failing callout does guarantee that a delivery would fail.
28763
28764 If the &%callout%& option is present on a condition that verifies an address, a
28765 second stage of verification occurs if the address is successfully routed to
28766 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28767 &(manualroute)& router, where the router specifies the hosts. However, if a
28768 router that does not set up hosts routes to an &(smtp)& transport with a
28769 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28770 &%hosts_override%& set, its hosts are always used, whether or not the router
28771 supplies a host list.
28772
28773 The port that is used is taken from the transport, if it is specified and is a
28774 remote transport. (For routers that do verification only, no transport need be
28775 specified.) Otherwise, the default SMTP port is used. If a remote transport
28776 specifies an outgoing interface, this is used; otherwise the interface is not
28777 specified. Likewise, the text that is used for the HELO command is taken from
28778 the transport's &%helo_data%& option; if there is no transport, the value of
28779 &$smtp_active_hostname$& is used.
28780
28781 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28782 test whether a bounce message could be delivered to the sender address. The
28783 following SMTP commands are sent:
28784 .display
28785 &`HELO `&<&'local host name'&>
28786 &`MAIL FROM:<>`&
28787 &`RCPT TO:`&<&'the address to be tested'&>
28788 &`QUIT`&
28789 .endd
28790 LHLO is used instead of HELO if the transport's &%protocol%& option is
28791 set to &"lmtp"&.
28792
28793 A recipient callout check is similar. By default, it also uses an empty address
28794 for the sender. This default is chosen because most hosts do not make use of
28795 the sender address when verifying a recipient. Using the same address means
28796 that a single cache entry can be used for each recipient. Some sites, however,
28797 do make use of the sender address when verifying. These are catered for by the
28798 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28799
28800 If the response to the RCPT command is a 2&'xx'& code, the verification
28801 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28802 Exim tries the next host, if any. If there is a problem with all the remote
28803 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28804 &%callout%& option is given, in which case the condition is forced to succeed.
28805
28806 .cindex "SMTP" "output flushing, disabling for callout"
28807 A callout may take a little time. For this reason, Exim normally flushes SMTP
28808 output before performing a callout in an ACL, to avoid unexpected timeouts in
28809 clients when the SMTP PIPELINING extension is in use. The flushing can be
28810 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28811
28812
28813
28814
28815 .section "Additional parameters for callouts" "CALLaddparcall"
28816 .cindex "callout" "additional parameters for"
28817 The &%callout%& option can be followed by an equals sign and a number of
28818 optional parameters, separated by commas. For example:
28819 .code
28820 verify = recipient/callout=10s,defer_ok
28821 .endd
28822 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28823 separate verify options, is retained for backwards compatibility, but is now
28824 deprecated. The additional parameters for &%callout%& are as follows:
28825
28826
28827 .vlist
28828 .vitem <&'a&~time&~interval'&>
28829 .cindex "callout" "timeout, specifying"
28830 This specifies the timeout that applies for the callout attempt to each host.
28831 For example:
28832 .code
28833 verify = sender/callout=5s
28834 .endd
28835 The default is 30 seconds. The timeout is used for each response from the
28836 remote host. It is also used for the initial connection, unless overridden by
28837 the &%connect%& parameter.
28838
28839
28840 .vitem &*connect&~=&~*&<&'time&~interval'&>
28841 .cindex "callout" "connection timeout, specifying"
28842 This parameter makes it possible to set a different (usually smaller) timeout
28843 for making the SMTP connection. For example:
28844 .code
28845 verify = sender/callout=5s,connect=1s
28846 .endd
28847 If not specified, this timeout defaults to the general timeout value.
28848
28849 .vitem &*defer_ok*&
28850 .cindex "callout" "defer, action on"
28851 When this parameter is present, failure to contact any host, or any other kind
28852 of temporary error, is treated as success by the ACL. However, the cache is not
28853 updated in this circumstance.
28854
28855 .vitem &*fullpostmaster*&
28856 .cindex "callout" "full postmaster check"
28857 This operates like the &%postmaster%& option (see below), but if the check for
28858 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28859 accordance with the specification in RFC 2821. The RFC states that the
28860 unqualified address &'postmaster'& should be accepted.
28861
28862
28863 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28864 .cindex "callout" "sender when verifying header"
28865 When verifying addresses in header lines using the &%header_sender%&
28866 verification option, Exim behaves by default as if the addresses are envelope
28867 sender addresses from a message. Callout verification therefore tests to see
28868 whether a bounce message could be delivered, by using an empty address in the
28869 MAIL command. However, it is arguable that these addresses might never be used
28870 as envelope senders, and could therefore justifiably reject bounce messages
28871 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28872 address to use in the MAIL command. For example:
28873 .code
28874 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28875 .endd
28876 This parameter is available only for the &%header_sender%& verification option.
28877
28878
28879 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28880 .cindex "callout" "overall timeout, specifying"
28881 This parameter sets an overall timeout for performing a callout verification.
28882 For example:
28883 .code
28884 verify = sender/callout=5s,maxwait=30s
28885 .endd
28886 This timeout defaults to four times the callout timeout for individual SMTP
28887 commands. The overall timeout applies when there is more than one host that can
28888 be tried. The timeout is checked before trying the next host. This prevents
28889 very long delays if there are a large number of hosts and all are timing out
28890 (for example, when network connections are timing out).
28891
28892
28893 .vitem &*no_cache*&
28894 .cindex "callout" "cache, suppressing"
28895 .cindex "caching callout, suppressing"
28896 When this parameter is given, the callout cache is neither read nor updated.
28897
28898 .vitem &*postmaster*&
28899 .cindex "callout" "postmaster; checking"
28900 When this parameter is set, a successful callout check is followed by a similar
28901 check for the local part &'postmaster'& at the same domain. If this address is
28902 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28903 the postmaster check is recorded in a cache record; if it is a failure, this is
28904 used to fail subsequent callouts for the domain without a connection being
28905 made, until the cache record expires.
28906
28907 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28908 The postmaster check uses an empty sender in the MAIL command by default.
28909 You can use this parameter to do a postmaster check using a different address.
28910 For example:
28911 .code
28912 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28913 .endd
28914 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28915 one overrides. The &%postmaster%& parameter is equivalent to this example:
28916 .code
28917 require  verify = sender/callout=postmaster_mailfrom=
28918 .endd
28919 &*Warning*&: The caching arrangements for postmaster checking do not take
28920 account of the sender address. It is assumed that either the empty address or
28921 a fixed non-empty address will be used. All that Exim remembers is that the
28922 postmaster check for the domain succeeded or failed.
28923
28924
28925 .vitem &*random*&
28926 .cindex "callout" "&""random""& check"
28927 When this parameter is set, before doing the normal callout check, Exim does a
28928 check for a &"random"& local part at the same domain. The local part is not
28929 really random &-- it is defined by the expansion of the option
28930 &%callout_random_local_part%&, which defaults to
28931 .code
28932 $primary_hostname-$tod_epoch-testing
28933 .endd
28934 The idea here is to try to determine whether the remote host accepts all local
28935 parts without checking. If it does, there is no point in doing callouts for
28936 specific local parts. If the &"random"& check succeeds, the result is saved in
28937 a cache record, and used to force the current and subsequent callout checks to
28938 succeed without a connection being made, until the cache record expires.
28939
28940 .vitem &*use_postmaster*&
28941 .cindex "callout" "sender for recipient check"
28942 This parameter applies to recipient callouts only. For example:
28943 .code
28944 deny  !verify = recipient/callout=use_postmaster
28945 .endd
28946 .vindex "&$qualify_domain$&"
28947 It causes a non-empty postmaster address to be used in the MAIL command when
28948 performing the callout for the recipient, and also for a &"random"& check if
28949 that is configured. The local part of the address is &`postmaster`& and the
28950 domain is the contents of &$qualify_domain$&.
28951
28952 .vitem &*use_sender*&
28953 This option applies to recipient callouts only. For example:
28954 .code
28955 require  verify = recipient/callout=use_sender
28956 .endd
28957 It causes the message's actual sender address to be used in the MAIL
28958 command when performing the callout, instead of an empty address. There is no
28959 need to use this option unless you know that the called hosts make use of the
28960 sender when checking recipients. If used indiscriminately, it reduces the
28961 usefulness of callout caching.
28962 .endlist
28963
28964 If you use any of the parameters that set a non-empty sender for the MAIL
28965 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28966 &%use_sender%&), you should think about possible loops. Recipient checking is
28967 usually done between two hosts that are under the same management, and the host
28968 that receives the callouts is not normally configured to do callouts itself.
28969 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28970 these circumstances.
28971
28972 However, if you use a non-empty sender address for a callout to an arbitrary
28973 host, there is the likelihood that the remote host will itself initiate a
28974 callout check back to your host. As it is checking what appears to be a message
28975 sender, it is likely to use an empty address in MAIL, thus avoiding a
28976 callout loop. However, to be on the safe side it would be best to set up your
28977 own ACLs so that they do not do sender verification checks when the recipient
28978 is the address you use for header sender or postmaster callout checking.
28979
28980 Another issue to think about when using non-empty senders for callouts is
28981 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28982 by the sender/recipient combination; thus, for any given recipient, many more
28983 actual callouts are performed than when an empty sender or postmaster is used.
28984
28985
28986
28987
28988 .section "Callout caching" "SECTcallvercache"
28989 .cindex "hints database" "callout cache"
28990 .cindex "callout" "cache, description of"
28991 .cindex "caching" "callout"
28992 Exim caches the results of callouts in order to reduce the amount of resources
28993 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28994 option. A hints database called &"callout"& is used for the cache. Two
28995 different record types are used: one records the result of a callout check for
28996 a specific address, and the other records information that applies to the
28997 entire domain (for example, that it accepts the local part &'postmaster'&).
28998
28999 When an original callout fails, a detailed SMTP error message is given about
29000 the failure. However, for subsequent failures use the cache data, this message
29001 is not available.
29002
29003 The expiry times for negative and positive address cache records are
29004 independent, and can be set by the global options &%callout_negative_expire%&
29005 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29006
29007 If a host gives a negative response to an SMTP connection, or rejects any
29008 commands up to and including
29009 .code
29010 MAIL FROM:<>
29011 .endd
29012 (but not including the MAIL command with a non-empty address),
29013 any callout attempt is bound to fail. Exim remembers such failures in a
29014 domain cache record, which it uses to fail callouts for the domain without
29015 making new connections, until the domain record times out. There are two
29016 separate expiry times for domain cache records:
29017 &%callout_domain_negative_expire%& (default 3h) and
29018 &%callout_domain_positive_expire%& (default 7d).
29019
29020 Domain records expire when the negative expiry time is reached if callouts
29021 cannot be made for the domain, or if the postmaster check failed.
29022 Otherwise, they expire when the positive expiry time is reached. This
29023 ensures that, for example, a host that stops accepting &"random"& local parts
29024 will eventually be noticed.
29025
29026 The callout caching mechanism is based on the domain of the address that is
29027 being tested. If the domain routes to several hosts, it is assumed that their
29028 behaviour will be the same.
29029
29030
29031
29032 .section "Sender address verification reporting" "SECTsenaddver"
29033 .cindex "verifying" "suppressing error details"
29034 See section &<<SECTaddressverification>>& for a general discussion of
29035 verification. When sender verification fails in an ACL, the details of the
29036 failure are given as additional output lines before the 550 response to the
29037 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29038 you might see:
29039 .code
29040 MAIL FROM:<xyz@abc.example>
29041 250 OK
29042 RCPT TO:<pqr@def.example>
29043 550-Verification failed for <xyz@abc.example>
29044 550-Called:   192.168.34.43
29045 550-Sent:     RCPT TO:<xyz@abc.example>
29046 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29047 550 Sender verification failed
29048 .endd
29049 If more than one RCPT command fails in the same way, the details are given
29050 only for the first of them. However, some administrators do not want to send
29051 out this much information. You can suppress the details by adding
29052 &`/no_details`& to the ACL statement that requests sender verification. For
29053 example:
29054 .code
29055 verify = sender/no_details
29056 .endd
29057
29058 .section "Redirection while verifying" "SECTredirwhilveri"
29059 .cindex "verifying" "redirection while"
29060 .cindex "address redirection" "while verifying"
29061 A dilemma arises when a local address is redirected by aliasing or forwarding
29062 during verification: should the generated addresses themselves be verified,
29063 or should the successful expansion of the original address be enough to verify
29064 it? By default, Exim takes the following pragmatic approach:
29065
29066 .ilist
29067 When an incoming address is redirected to just one child address, verification
29068 continues with the child address, and if that fails to verify, the original
29069 verification also fails.
29070 .next
29071 When an incoming address is redirected to more than one child address,
29072 verification does not continue. A success result is returned.
29073 .endlist
29074
29075 This seems the most reasonable behaviour for the common use of aliasing as a
29076 way of redirecting different local parts to the same mailbox. It means, for
29077 example, that a pair of alias entries of the form
29078 .code
29079 A.Wol:   aw123
29080 aw123:   :fail: Gone away, no forwarding address
29081 .endd
29082 work as expected, with both local parts causing verification failure. When a
29083 redirection generates more than one address, the behaviour is more like a
29084 mailing list, where the existence of the alias itself is sufficient for
29085 verification to succeed.
29086
29087 It is possible, however, to change the default behaviour so that all successful
29088 redirections count as successful verifications, however many new addresses are
29089 generated. This is specified by the &%success_on_redirect%& verification
29090 option. For example:
29091 .code
29092 require verify = recipient/success_on_redirect/callout=10s
29093 .endd
29094 In this example, verification succeeds if a router generates a new address, and
29095 the callout does not occur, because no address was routed to a remote host.
29096
29097 When verification is being tested via the &%-bv%& option, the treatment of
29098 redirections is as just described, unless the &%-v%& or any debugging option is
29099 also specified. In that case, full verification is done for every generated
29100 address and a report is output for each of them.
29101
29102
29103
29104 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29105 .cindex "CSA" "verifying"
29106 Client SMTP Authorization is a system that allows a site to advertise
29107 which machines are and are not permitted to send email. This is done by placing
29108 special SRV records in the DNS; these are looked up using the client's HELO
29109 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29110 Authorization checks in Exim are performed by the ACL condition:
29111 .code
29112 verify = csa
29113 .endd
29114 This fails if the client is not authorized. If there is a DNS problem, or if no
29115 valid CSA SRV record is found, or if the client is authorized, the condition
29116 succeeds. These three cases can be distinguished using the expansion variable
29117 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29118 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29119 be likely to cause problems for legitimate email.
29120
29121 The error messages produced by the CSA code include slightly more
29122 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29123 looking up the CSA SRV record, or problems looking up the CSA target
29124 address record. There are four reasons for &$csa_status$& being &"fail"&:
29125
29126 .ilist
29127 The client's host name is explicitly not authorized.
29128 .next
29129 The client's IP address does not match any of the CSA target IP addresses.
29130 .next
29131 The client's host name is authorized but it has no valid target IP addresses
29132 (for example, the target's addresses are IPv6 and the client is using IPv4).
29133 .next
29134 The client's host name has no CSA SRV record but a parent domain has asserted
29135 that all subdomains must be explicitly authorized.
29136 .endlist
29137
29138 The &%csa%& verification condition can take an argument which is the domain to
29139 use for the DNS query. The default is:
29140 .code
29141 verify = csa/$sender_helo_name
29142 .endd
29143 This implementation includes an extension to CSA. If the query domain
29144 is an address literal such as [192.0.2.95], or if it is a bare IP
29145 address, Exim searches for CSA SRV records in the reverse DNS as if
29146 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29147 meaningful to say:
29148 .code
29149 verify = csa/$sender_host_address
29150 .endd
29151 In fact, this is the check that Exim performs if the client does not say HELO.
29152 This extension can be turned off by setting the main configuration option
29153 &%dns_csa_use_reverse%& to be false.
29154
29155 If a CSA SRV record is not found for the domain itself, a search
29156 is performed through its parent domains for a record which might be
29157 making assertions about subdomains. The maximum depth of this search is limited
29158 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29159 default. Exim does not look for CSA SRV records in a top level domain, so the
29160 default settings handle HELO domains as long as seven
29161 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29162 of legitimate HELO domains.
29163
29164 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29165 direct SRV lookups, this is not sufficient because of the extra parent domain
29166 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29167 addresses into lookups in the reverse DNS space. The result of a successful
29168 lookup such as:
29169 .code
29170 ${lookup dnsdb {csa=$sender_helo_name}}
29171 .endd
29172 has two space-separated fields: an authorization code and a target host name.
29173 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29174 authorization required but absent, or &"?"& for unknown.
29175
29176
29177
29178
29179 .section "Bounce address tag validation" "SECTverifyPRVS"
29180 .cindex "BATV, verifying"
29181 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29182 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29183 Genuine incoming bounce messages should therefore always be addressed to
29184 recipients that have a valid tag. This scheme is a way of detecting unwanted
29185 bounce messages caused by sender address forgeries (often called &"collateral
29186 spam"&), because the recipients of such messages do not include valid tags.
29187
29188 There are two expansion items to help with the implementation of the BATV
29189 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29190 the original envelope sender address by using a simple key to add a hash of the
29191 address and some time-based randomizing information. The &%prvs%& expansion
29192 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29193 The syntax of these expansion items is described in section
29194 &<<SECTexpansionitems>>&.
29195
29196 As an example, suppose the secret per-address keys are stored in an MySQL
29197 database. A query to look up the key for an address could be defined as a macro
29198 like this:
29199 .code
29200 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29201                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29202                 }{$value}}
29203 .endd
29204 Suppose also that the senders who make use of BATV are defined by an address
29205 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29206 use this:
29207 .code
29208 # Bounces: drop unsigned addresses for BATV senders
29209 deny message = This address does not send an unsigned reverse path
29210      senders = :
29211      recipients = +batv_senders
29212
29213 # Bounces: In case of prvs-signed address, check signature.
29214 deny message = Invalid reverse path signature.
29215      senders = :
29216      condition  = ${prvscheck {$local_part@$domain}\
29217                   {PRVSCHECK_SQL}{1}}
29218      !condition = $prvscheck_result
29219 .endd
29220 The first statement rejects recipients for bounce messages that are addressed
29221 to plain BATV sender addresses, because it is known that BATV senders do not
29222 send out messages with plain sender addresses. The second statement rejects
29223 recipients that are prvs-signed, but with invalid signatures (either because
29224 the key is wrong, or the signature has timed out).
29225
29226 A non-prvs-signed address is not rejected by the second statement, because the
29227 &%prvscheck%& expansion yields an empty string if its first argument is not a
29228 prvs-signed address, thus causing the &%condition%& condition to be false. If
29229 the first argument is a syntactically valid prvs-signed address, the yield is
29230 the third string (in this case &"1"&), whether or not the cryptographic and
29231 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29232 of the checks (empty for failure, &"1"& for success).
29233
29234 There is one more issue you must consider when implementing prvs-signing:
29235 you have to ensure that the routers accept prvs-signed addresses and
29236 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29237 router to remove the signature with a configuration along these lines:
29238 .code
29239 batv_redirect:
29240   driver = redirect
29241   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29242 .endd
29243 This works because, if the third argument of &%prvscheck%& is empty, the result
29244 of the expansion of a prvs-signed address is the decoded value of the original
29245 address. This router should probably be the first of your routers that handles
29246 local addresses.
29247
29248 To create BATV-signed addresses in the first place, a transport of this form
29249 can be used:
29250 .code
29251 external_smtp_batv:
29252   driver = smtp
29253   return_path = ${prvs {$return_path} \
29254                        {${lookup mysql{SELECT \
29255                        secret FROM batv_prvs WHERE \
29256                        sender='${quote_mysql:$sender_address}'} \
29257                        {$value}fail}}}
29258 .endd
29259 If no key can be found for the existing return path, no signing takes place.
29260
29261
29262
29263 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29264 .cindex "&ACL;" "relay control"
29265 .cindex "relaying" "control by ACL"
29266 .cindex "policy control" "relay control"
29267 An MTA is said to &'relay'& a message if it receives it from some host and
29268 delivers it directly to another host as a result of a remote address contained
29269 within it. Redirecting a local address via an alias or forward file and then
29270 passing the message on to another host is not relaying,
29271 .cindex "&""percent hack""&"
29272 but a redirection as a result of the &"percent hack"& is.
29273
29274 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29275 A host which is acting as a gateway or an MX backup is concerned with incoming
29276 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29277 a host which is acting as a smart host for a number of clients is concerned
29278 with outgoing relaying from those clients to the Internet at large. Often the
29279 same host is fulfilling both functions,
29280 . ///
29281 . as illustrated in the diagram below,
29282 . ///
29283 but in principle these two kinds of relaying are entirely independent. What is
29284 not wanted is the transmission of mail from arbitrary remote hosts through your
29285 system to arbitrary domains.
29286
29287
29288 You can implement relay control by means of suitable statements in the ACL that
29289 runs for each RCPT command. For convenience, it is often easiest to use
29290 Exim's named list facility to define the domains and hosts involved. For
29291 example, suppose you want to do the following:
29292
29293 .ilist
29294 Deliver a number of domains to mailboxes on the local host (or process them
29295 locally in some other way). Let's say these are &'my.dom1.example'& and
29296 &'my.dom2.example'&.
29297 .next
29298 Relay mail for a number of other domains for which you are the secondary MX.
29299 These might be &'friend1.example'& and &'friend2.example'&.
29300 .next
29301 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29302 Suppose your LAN is 192.168.45.0/24.
29303 .endlist
29304
29305
29306 In the main part of the configuration, you put the following definitions:
29307 .code
29308 domainlist local_domains    = my.dom1.example : my.dom2.example
29309 domainlist relay_to_domains = friend1.example : friend2.example
29310 hostlist   relay_from_hosts = 192.168.45.0/24
29311 .endd
29312 Now you can use these definitions in the ACL that is run for every RCPT
29313 command:
29314 .code
29315 acl_check_rcpt:
29316   accept domains = +local_domains : +relay_to_domains
29317   accept hosts   = +relay_from_hosts
29318 .endd
29319 The first statement accepts any RCPT command that contains an address in
29320 the local or relay domains. For any other domain, control passes to the second
29321 statement, which accepts the command only if it comes from one of the relay
29322 hosts. In practice, you will probably want to make your ACL more sophisticated
29323 than this, for example, by including sender and recipient verification. The
29324 default configuration includes a more comprehensive example, which is described
29325 in chapter &<<CHAPdefconfil>>&.
29326
29327
29328
29329 .section "Checking a relay configuration" "SECTcheralcon"
29330 .cindex "relaying" "checking control of"
29331 You can check the relay characteristics of your configuration in the same way
29332 that you can test any ACL behaviour for an incoming SMTP connection, by using
29333 the &%-bh%& option to run a fake SMTP session with which you interact.
29334
29335 For specifically testing for unwanted relaying, the host
29336 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29337 host from the host on which Exim is running, using the normal telnet port, you
29338 will see a normal telnet connection message and then quite a long delay. Be
29339 patient. The remote host is making an SMTP connection back to your host, and
29340 trying a number of common probes to test for open relay vulnerability. The
29341 results of the tests will eventually appear on your terminal.
29342 .ecindex IIDacl
29343
29344
29345
29346 . ////////////////////////////////////////////////////////////////////////////
29347 . ////////////////////////////////////////////////////////////////////////////
29348
29349 .chapter "Content scanning at ACL time" "CHAPexiscan"
29350 .scindex IIDcosca "content scanning" "at ACL time"
29351 The extension of Exim to include content scanning at ACL time, formerly known
29352 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29353 was integrated into the main source for Exim release 4.50, and Tom continues to
29354 maintain it. Most of the wording of this chapter is taken from Tom's
29355 specification.
29356
29357 It is also possible to scan the content of messages at other times. The
29358 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29359 scanning after all the ACLs have run. A transport filter can be used to scan
29360 messages at delivery time (see the &%transport_filter%& option, described in
29361 chapter &<<CHAPtransportgeneric>>&).
29362
29363 If you want to include the ACL-time content-scanning features when you compile
29364 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29365 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29366
29367 .ilist
29368 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29369 for all MIME parts for SMTP and non-SMTP messages, respectively.
29370 .next
29371 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29372 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29373 run at the end of message reception (the &%acl_smtp_data%& ACL).
29374 .next
29375 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29376 of messages, or parts of messages, for debugging purposes.
29377 .next
29378 Additional expansion variables that are set in the new ACL and by the new
29379 conditions.
29380 .next
29381 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29382 .endlist
29383
29384 There is another content-scanning configuration option for &_Local/Makefile_&,
29385 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29386 condition is compiled, in addition to all the other content-scanning features.
29387
29388 Content-scanning is continually evolving, and new features are still being
29389 added. While such features are still unstable and liable to incompatible
29390 changes, they are made available in Exim by setting options whose names begin
29391 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29392 this manual. You can find out about them by reading the file called
29393 &_doc/experimental.txt_&.
29394
29395 All the content-scanning facilities work on a MBOX copy of the message that is
29396 temporarily created in a file called:
29397 .display
29398 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29399 .endd
29400 The &_.eml_& extension is a friendly hint to virus scanners that they can
29401 expect an MBOX-like structure inside that file. The file is created when the
29402 first content scanning facility is called. Subsequent calls to content
29403 scanning conditions open the same file again. The directory is recursively
29404 removed when the &%acl_smtp_data%& ACL has finished running, unless
29405 .code
29406 control = no_mbox_unspool
29407 .endd
29408 has been encountered. When the MIME ACL decodes files, they are put into the
29409 same directory by default.
29410
29411
29412
29413 .section "Scanning for viruses" "SECTscanvirus"
29414 .cindex "virus scanning"
29415 .cindex "content scanning" "for viruses"
29416 .cindex "content scanning" "the &%malware%& condition"
29417 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29418 It supports a &"generic"& interface to scanners called via the shell, and
29419 specialized interfaces for &"daemon"& type virus scanners, which are resident
29420 in memory and thus are much faster.
29421
29422
29423 .oindex "&%av_scanner%&"
29424 You can set the &%av_scanner%& option in first part of the Exim configuration
29425 file to specify which scanner to use, together with any additional options that
29426 are needed. The basic syntax is as follows:
29427 .display
29428 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29429 .endd
29430 If you do not set &%av_scanner%&, it defaults to
29431 .code
29432 av_scanner = sophie:/var/run/sophie
29433 .endd
29434 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29435 before use. The following scanner types are supported in this release:
29436
29437 .vlist
29438 .vitem &%aveserver%&
29439 .cindex "virus scanners" "Kaspersky"
29440 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29441 at &url(http://www.kaspersky.com). This scanner type takes one option,
29442 which is the path to the daemon's UNIX socket. The default is shown in this
29443 example:
29444 .code
29445 av_scanner = aveserver:/var/run/aveserver
29446 .endd
29447
29448
29449 .vitem &%clamd%&
29450 .cindex "virus scanners" "clamd"
29451 This daemon-type scanner is GPL and free. You can get it at
29452 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29453 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29454 in the MIME ACL. This no longer believed to be necessary. One option is
29455 required: either the path and name of a UNIX socket file, or a hostname or IP
29456 number, and a port, separated by space, as in the second of these examples:
29457 .code
29458 av_scanner = clamd:/opt/clamd/socket
29459 av_scanner = clamd:192.0.2.3 1234
29460 av_scanner = clamd:192.0.2.3 1234:local
29461 .endd
29462 If the value of av_scanner points to a UNIX socket file or contains the local
29463 keyword, then the ClamAV interface will pass a filename containing the data
29464 to be scanned, which will should normally result in less I/O happening and be
29465 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29466 Exim does not assume that there is a common filesystem with the remote host.
29467 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29468 you be running a version of ClamAV prior to 0.95.
29469 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29470 contributing the code for this scanner.
29471
29472 .vitem &%cmdline%&
29473 .cindex "virus scanners" "command line interface"
29474 This is the keyword for the generic command line scanner interface. It can be
29475 used to attach virus scanners that are invoked from the shell. This scanner
29476 type takes 3 mandatory options:
29477
29478 .olist
29479 The full path and name of the scanner binary, with all command line options,
29480 and a placeholder (&`%s`&) for the directory to scan.
29481
29482 .next
29483 A regular expression to match against the STDOUT and STDERR output of the
29484 virus scanner. If the expression matches, a virus was found. You must make
29485 absolutely sure that this expression matches on &"virus found"&. This is called
29486 the &"trigger"& expression.
29487
29488 .next
29489 Another regular expression, containing exactly one pair of parentheses, to
29490 match the name of the virus found in the scanners output. This is called the
29491 &"name"& expression.
29492 .endlist olist
29493
29494 For example, Sophos Sweep reports a virus on a line like this:
29495 .code
29496 Virus 'W32/Magistr-B' found in file ./those.bat
29497 .endd
29498 For the trigger expression, we can match the phrase &"found in file"&. For the
29499 name expression, we want to extract the W32/Magistr-B string, so we can match
29500 for the single quotes left and right of it. Altogether, this makes the
29501 configuration setting:
29502 .code
29503 av_scanner = cmdline:\
29504              /path/to/sweep -ss -all -rec -archive %s:\
29505              found in file:'(.+)'
29506 .endd
29507 .vitem &%drweb%&
29508 .cindex "virus scanners" "DrWeb"
29509 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29510 argument, either a full path to a UNIX socket, or an IP address and port
29511 separated by white space, as in these examples:
29512 .code
29513 av_scanner = drweb:/var/run/drwebd.sock
29514 av_scanner = drweb:192.168.2.20 31337
29515 .endd
29516 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29517 is used. Thanks to Alex Miller for contributing the code for this scanner.
29518
29519 .vitem &%fsecure%&
29520 .cindex "virus scanners" "F-Secure"
29521 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29522 argument which is the path to a UNIX socket. For example:
29523 .code
29524 av_scanner = fsecure:/path/to/.fsav
29525 .endd
29526 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29527 Thelmen for contributing the code for this scanner.
29528
29529 .vitem &%kavdaemon%&
29530 .cindex "virus scanners" "Kaspersky"
29531 This is the scanner daemon of Kaspersky Version 4. This version of the
29532 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29533 scanner type takes one option, which is the path to the daemon's UNIX socket.
29534 For example:
29535 .code
29536 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29537 .endd
29538 The default path is &_/var/run/AvpCtl_&.
29539
29540 .vitem &%mksd%&
29541 .cindex "virus scanners" "mksd"
29542 This is a daemon type scanner that is aimed mainly at Polish users, though some
29543 parts of documentation are now available in English. You can get it at
29544 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29545 the maximum number of processes used simultaneously to scan the attachments,
29546 provided that the demime facility is employed and also provided that mksd has
29547 been run with at least the same number of child processes. For example:
29548 .code
29549 av_scanner = mksd:2
29550 .endd
29551 You can safely omit this option (the default value is 1).
29552
29553 .vitem &%sophie%&
29554 .cindex "virus scanners" "Sophos and Sophie"
29555 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29556 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29557 for this scanner type is the path to the UNIX socket that Sophie uses for
29558 client communication. For example:
29559 .code
29560 av_scanner = sophie:/tmp/sophie
29561 .endd
29562 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29563 the option.
29564 .endlist
29565
29566 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29567 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29568 ACL.
29569
29570 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29571 makes it possible to use different scanners. See further below for an example.
29572 The &%malware%& condition caches its results, so when you use it multiple times
29573 for the same message, the actual scanning process is only carried out once.
29574 However, using expandable items in &%av_scanner%& disables this caching, in
29575 which case each use of the &%malware%& condition causes a new scan of the
29576 message.
29577
29578 The &%malware%& condition takes a right-hand argument that is expanded before
29579 use. It can then be one of
29580
29581 .ilist
29582 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29583 The condition succeeds if a virus was found, and fail otherwise. This is the
29584 recommended usage.
29585 .next
29586 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29587 the condition fails immediately.
29588 .next
29589 A regular expression, in which case the message is scanned for viruses. The
29590 condition succeeds if a virus is found and its name matches the regular
29591 expression. This allows you to take special actions on certain types of virus.
29592 .endlist
29593
29594 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29595 even if there is a problem with the virus scanner. Otherwise, such a problem
29596 causes the ACL to defer.
29597
29598 .vindex "&$malware_name$&"
29599 When a virus is found, the condition sets up an expansion variable called
29600 &$malware_name$& that contains the name of the virus. You can use it in a
29601 &%message%& modifier that specifies the error returned to the sender, and/or in
29602 logging data.
29603
29604 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29605 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29606 &%malware%& condition.
29607
29608 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29609 imposed by your anti-virus scanner.
29610
29611 Here is a very simple scanning example:
29612 .code
29613 deny message = This message contains malware ($malware_name)
29614      demime = *
29615      malware = *
29616 .endd
29617 The next example accepts messages when there is a problem with the scanner:
29618 .code
29619 deny message = This message contains malware ($malware_name)
29620      demime = *
29621      malware = */defer_ok
29622 .endd
29623 The next example shows how to use an ACL variable to scan with both sophie and
29624 aveserver. It assumes you have set:
29625 .code
29626 av_scanner = $acl_m0
29627 .endd
29628 in the main Exim configuration.
29629 .code
29630 deny message = This message contains malware ($malware_name)
29631      set acl_m0 = sophie
29632      malware = *
29633
29634 deny message = This message contains malware ($malware_name)
29635      set acl_m0 = aveserver
29636      malware = *
29637 .endd
29638
29639
29640 .section "Scanning with SpamAssassin" "SECTscanspamass"
29641 .cindex "content scanning" "for spam"
29642 .cindex "spam scanning"
29643 .cindex "SpamAssassin"
29644 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29645 score and a report for the message. You can get SpamAssassin at
29646 &url(http://www.spamassassin.org), or, if you have a working Perl
29647 installation, you can use CPAN by running:
29648 .code
29649 perl -MCPAN -e 'install Mail::SpamAssassin'
29650 .endd
29651 SpamAssassin has its own set of configuration files. Please review its
29652 documentation to see how you can tweak it. The default installation should work
29653 nicely, however.
29654
29655 .oindex "&%spamd_address%&"
29656 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29657 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29658 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29659 part of the Exim configuration as follows (example):
29660 .code
29661 spamd_address = 192.168.99.45 387
29662 .endd
29663 You do not need to set this option if you use the default. As of version 2.60,
29664 &%spamd%& also supports communication over UNIX sockets. If you want to use
29665 these, supply &%spamd_address%& with an absolute file name instead of a
29666 address/port pair:
29667 .code
29668 spamd_address = /var/run/spamd_socket
29669 .endd
29670 You can have multiple &%spamd%& servers to improve scalability. These can
29671 reside on other hardware reachable over the network. To specify multiple
29672 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29673 option, separated with colons:
29674 .code
29675 spamd_address = 192.168.2.10 783 : \
29676                 192.168.2.11 783 : \
29677                 192.168.2.12 783
29678 .endd
29679 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29680 fashion. When a server fails to respond to the connection attempt, all other
29681 servers are tried until one succeeds. If no server responds, the &%spam%&
29682 condition defers.
29683
29684 &*Warning*&: It is not possible to use the UNIX socket connection method with
29685 multiple &%spamd%& servers.
29686
29687 The &%spamd_address%& variable is expanded before use if it starts with
29688 a dollar sign. In this case, the expansion may return a string that is
29689 used as the list so that multiple spamd servers can be the result of an
29690 expansion.
29691
29692 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29693 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29694 .code
29695 deny message = This message was classified as SPAM
29696      spam = joe
29697 .endd
29698 The right-hand side of the &%spam%& condition specifies a name. This is
29699 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29700 to scan using a specific profile, but rather use the SpamAssassin system-wide
29701 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29702 However, you must put something on the right-hand side.
29703
29704 The name allows you to use per-domain or per-user antispam profiles in
29705 principle, but this is not straightforward in practice, because a message may
29706 have multiple recipients, not necessarily all in the same domain. Because the
29707 &%spam%& condition has to be called from a DATA ACL in order to be able to
29708 read the contents of the message, the variables &$local_part$& and &$domain$&
29709 are not set.
29710
29711 The right-hand side of the &%spam%& condition is expanded before being used, so
29712 you can put lookups or conditions there. When the right-hand side evaluates to
29713 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29714
29715
29716 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29717 large ones may cause significant performance degradation. As most spam messages
29718 are quite small, it is recommended that you do not scan the big ones. For
29719 example:
29720 .code
29721 deny message = This message was classified as SPAM
29722      condition = ${if < {$message_size}{10K}}
29723      spam = nobody
29724 .endd
29725
29726 The &%spam%& condition returns true if the threshold specified in the user's
29727 SpamAssassin profile has been matched or exceeded. If you want to use the
29728 &%spam%& condition for its side effects (see the variables below), you can make
29729 it always return &"true"& by appending &`:true`& to the username.
29730
29731 .cindex "spam scanning" "returned variables"
29732 When the &%spam%& condition is run, it sets up a number of expansion
29733 variables. These variables are saved with the received message, thus they are
29734 available for use at delivery time.
29735
29736 .vlist
29737 .vitem &$spam_score$&
29738 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29739 for inclusion in log or reject messages.
29740
29741 .vitem &$spam_score_int$&
29742 The spam score of the message, multiplied by ten, as an integer value. For
29743 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29744 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29745 The integer value is useful for numeric comparisons in conditions.
29746
29747 .vitem &$spam_bar$&
29748 A string consisting of a number of &"+"& or &"-"& characters, representing the
29749 integer part of the spam score value. A spam score of 4.4 would have a
29750 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29751 headers, since MUAs can match on such strings.
29752
29753 .vitem &$spam_report$&
29754 A multiline text table, containing the full SpamAssassin report for the
29755 message. Useful for inclusion in headers or reject messages.
29756 .endlist
29757
29758 The &%spam%& condition caches its results unless expansion in
29759 spamd_address was used. If you call it again with the same user name, it
29760 does not scan again, but rather returns the same values as before.
29761
29762 The &%spam%& condition returns DEFER if there is any error while running
29763 the message through SpamAssassin or if the expansion of spamd_address
29764 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29765 statement block), append &`/defer_ok`& to the right-hand side of the
29766 spam condition, like this:
29767 .code
29768 deny message = This message was classified as SPAM
29769      spam    = joe/defer_ok
29770 .endd
29771 This causes messages to be accepted even if there is a problem with &%spamd%&.
29772
29773 Here is a longer, commented example of the use of the &%spam%&
29774 condition:
29775 .code
29776 # put headers in all messages (no matter if spam or not)
29777 warn  spam = nobody:true
29778       add_header = X-Spam-Score: $spam_score ($spam_bar)
29779       add_header = X-Spam-Report: $spam_report
29780
29781 # add second subject line with *SPAM* marker when message
29782 # is over threshold
29783 warn  spam = nobody
29784       add_header = Subject: *SPAM* $h_Subject:
29785
29786 # reject spam at high scores (> 12)
29787 deny  message = This message scored $spam_score spam points.
29788       spam = nobody:true
29789       condition = ${if >{$spam_score_int}{120}{1}{0}}
29790 .endd
29791
29792
29793
29794 .section "Scanning MIME parts" "SECTscanmimepart"
29795 .cindex "content scanning" "MIME parts"
29796 .cindex "MIME content scanning"
29797 .oindex "&%acl_smtp_mime%&"
29798 .oindex "&%acl_not_smtp_mime%&"
29799 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29800 each MIME part of an SMTP message, including multipart types, in the sequence
29801 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29802 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29803 options may both refer to the same ACL if you want the same processing in both
29804 cases.
29805
29806 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29807 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29808 the case of a non-SMTP message. However, a MIME ACL is called only if the
29809 message contains a &'Content-Type:'& header line. When a call to a MIME
29810 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29811 result code is sent to the client. In the case of an SMTP message, the
29812 &%acl_smtp_data%& ACL is not called when this happens.
29813
29814 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29815 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29816 condition to match against the raw MIME part. You can also use the
29817 &%mime_regex%& condition to match against the decoded MIME part (see section
29818 &<<SECTscanregex>>&).
29819
29820 At the start of a MIME ACL, a number of variables are set from the header
29821 information for the relevant MIME part. These are described below. The contents
29822 of the MIME part are not by default decoded into a disk file except for MIME
29823 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29824 part into a disk file, you can use the &%decode%& condition. The general
29825 syntax is:
29826 .display
29827 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29828 .endd
29829 The right hand side is expanded before use. After expansion,
29830 the value can be:
29831
29832 .olist
29833 &"0"& or &"false"&, in which case no decoding is done.
29834 .next
29835 The string &"default"&. In that case, the file is put in the temporary
29836 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29837 a sequential file name consisting of the message id and a sequence number. The
29838 full path and name is available in &$mime_decoded_filename$& after decoding.
29839 .next
29840 A full path name starting with a slash. If the full name is an existing
29841 directory, it is used as a replacement for the default directory. The filename
29842 is then sequentially assigned. If the path does not exist, it is used as
29843 the full path and file name.
29844 .next
29845 If the string does not start with a slash, it is used as the
29846 filename, and the default path is then used.
29847 .endlist
29848 The &%decode%& condition normally succeeds. It is only false for syntax
29849 errors or unusual circumstances such as memory shortages. You can easily decode
29850 a file with its original, proposed filename using
29851 .code
29852 decode = $mime_filename
29853 .endd
29854 However, you should keep in mind that &$mime_filename$& might contain
29855 anything. If you place files outside of the default path, they are not
29856 automatically unlinked.
29857
29858 For RFC822 attachments (these are messages attached to messages, with a
29859 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29860 as for the primary message, only that the &$mime_is_rfc822$& expansion
29861 variable is set (see below). Attached messages are always decoded to disk
29862 before being checked, and the files are unlinked once the check is done.
29863
29864 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29865 used to match regular expressions against raw and decoded MIME parts,
29866 respectively. They are described in section &<<SECTscanregex>>&.
29867
29868 .cindex "MIME content scanning" "returned variables"
29869 The following list describes all expansion variables that are
29870 available in the MIME ACL:
29871
29872 .vlist
29873 .vitem &$mime_boundary$&
29874 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29875 have a boundary string, which is stored in this variable. If the current part
29876 has no boundary parameter in the &'Content-Type:'& header, this variable
29877 contains the empty string.
29878
29879 .vitem &$mime_charset$&
29880 This variable contains the character set identifier, if one was found in the
29881 &'Content-Type:'& header. Examples for charset identifiers are:
29882 .code
29883 us-ascii
29884 gb2312 (Chinese)
29885 iso-8859-1
29886 .endd
29887 Please note that this value is not normalized, so you should do matches
29888 case-insensitively.
29889
29890 .vitem &$mime_content_description$&
29891 This variable contains the normalized content of the &'Content-Description:'&
29892 header. It can contain a human-readable description of the parts content. Some
29893 implementations repeat the filename for attachments here, but they are usually
29894 only used for display purposes.
29895
29896 .vitem &$mime_content_disposition$&
29897 This variable contains the normalized content of the &'Content-Disposition:'&
29898 header. You can expect strings like &"attachment"& or &"inline"& here.
29899
29900 .vitem &$mime_content_id$&
29901 This variable contains the normalized content of the &'Content-ID:'& header.
29902 This is a unique ID that can be used to reference a part from another part.
29903
29904 .vitem &$mime_content_size$&
29905 This variable is set only after the &%decode%& modifier (see above) has been
29906 successfully run. It contains the size of the decoded part in kilobytes. The
29907 size is always rounded up to full kilobytes, so only a completely empty part
29908 has a &$mime_content_size$& of zero.
29909
29910 .vitem &$mime_content_transfer_encoding$&
29911 This variable contains the normalized content of the
29912 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29913 type. Typical values are &"base64"& and &"quoted-printable"&.
29914
29915 .vitem &$mime_content_type$&
29916 If the MIME part has a &'Content-Type:'& header, this variable contains its
29917 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29918 are some examples of popular MIME types, as they may appear in this variable:
29919 .code
29920 text/plain
29921 text/html
29922 application/octet-stream
29923 image/jpeg
29924 audio/midi
29925 .endd
29926 If the MIME part has no &'Content-Type:'& header, this variable contains the
29927 empty string.
29928
29929 .vitem &$mime_decoded_filename$&
29930 This variable is set only after the &%decode%& modifier (see above) has been
29931 successfully run. It contains the full path and file name of the file
29932 containing the decoded data.
29933 .endlist
29934
29935 .cindex "RFC 2047"
29936 .vlist
29937 .vitem &$mime_filename$&
29938 This is perhaps the most important of the MIME variables. It contains a
29939 proposed filename for an attachment, if one was found in either the
29940 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29941 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29942 found, this variable contains the empty string.
29943
29944 .vitem &$mime_is_coverletter$&
29945 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29946 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29947 content in the cover letter, while not restricting attachments at all.
29948
29949 The variable contains 1 (true) for a MIME part believed to be part of the
29950 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29951 follows:
29952
29953 .olist
29954 The outermost MIME part of a message is always a cover letter.
29955
29956 .next
29957 If a multipart/alternative or multipart/related MIME part is a cover letter,
29958 so are all MIME subparts within that multipart.
29959
29960 .next
29961 If any other multipart is a cover letter, the first subpart is a cover letter,
29962 and the rest are attachments.
29963
29964 .next
29965 All parts contained within an attachment multipart are attachments.
29966 .endlist olist
29967
29968 As an example, the following will ban &"HTML mail"& (including that sent with
29969 alternative plain text), while allowing HTML files to be attached. HTML
29970 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29971 .code
29972 deny message = HTML mail is not accepted here
29973 !condition = $mime_is_rfc822
29974 condition = $mime_is_coverletter
29975 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29976 .endd
29977 .vitem &$mime_is_multipart$&
29978 This variable has the value 1 (true) when the current part has the main type
29979 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29980 Since multipart entities only serve as containers for other parts, you may not
29981 want to carry out specific actions on them.
29982
29983 .vitem &$mime_is_rfc822$&
29984 This variable has the value 1 (true) if the current part is not a part of the
29985 checked message itself, but part of an attached message. Attached message
29986 decoding is fully recursive.
29987
29988 .vitem &$mime_part_count$&
29989 This variable is a counter that is raised for each processed MIME part. It
29990 starts at zero for the very first part (which is usually a multipart). The
29991 counter is per-message, so it is reset when processing RFC822 attachments (see
29992 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29993 complete, so you can use it in the DATA ACL to determine the number of MIME
29994 parts of a message. For non-MIME messages, this variable contains the value -1.
29995 .endlist
29996
29997
29998
29999 .section "Scanning with regular expressions" "SECTscanregex"
30000 .cindex "content scanning" "with regular expressions"
30001 .cindex "regular expressions" "content scanning with"
30002 You can specify your own custom regular expression matches on the full body of
30003 the message, or on individual MIME parts.
30004
30005 The &%regex%& condition takes one or more regular expressions as arguments and
30006 matches them against the full message (when called in the DATA ACL) or a raw
30007 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30008 linewise, with a maximum line length of 32K characters. That means you cannot
30009 have multiline matches with the &%regex%& condition.
30010
30011 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30012 to 32K of decoded content (the whole content at once, not linewise). If the
30013 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30014 is decoded automatically when &%mime_regex%& is executed (using default path
30015 and filename values). If the decoded data is larger than  32K, only the first
30016 32K characters are checked.
30017
30018 The regular expressions are passed as a colon-separated list. To include a
30019 literal colon, you must double it. Since the whole right-hand side string is
30020 expanded before being used, you must also escape dollar signs and backslashes
30021 with more backslashes, or use the &`\N`& facility to disable expansion.
30022 Here is a simple example that contains two regular expressions:
30023 .code
30024 deny message = contains blacklisted regex ($regex_match_string)
30025      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30026 .endd
30027 The conditions returns true if any one of the regular expressions matches. The
30028 &$regex_match_string$& expansion variable is then set up and contains the
30029 matching regular expression.
30030
30031 &*Warning*&: With large messages, these conditions can be fairly
30032 CPU-intensive.
30033
30034
30035
30036
30037 .section "The demime condition" "SECTdemimecond"
30038 .cindex "content scanning" "MIME checking"
30039 .cindex "MIME content scanning"
30040 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30041 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30042 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30043 ACL functionality, but provides no additional facilities. Please note that this
30044 condition is deprecated and kept only for backward compatibility. You must set
30045 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30046 use the &%demime%& condition.
30047
30048 The &%demime%& condition unpacks MIME containers in the message. It detects
30049 errors in MIME containers and can match file extensions found in the message
30050 against a list. Using this facility produces files containing the unpacked MIME
30051 parts of the message in the temporary scan directory. If you do antivirus
30052 scanning, it is recommended that you use the &%demime%& condition before the
30053 antivirus (&%malware%&) condition.
30054
30055 On the right-hand side of the &%demime%& condition you can pass a
30056 colon-separated list of file extensions that it should match against. For
30057 example:
30058 .code
30059 deny message = Found blacklisted file attachment
30060      demime  = vbs:com:bat:pif:prf:lnk
30061 .endd
30062 If one of the file extensions is found, the condition is true, otherwise it is
30063 false. If there is a temporary error while demimeing (for example, &"disk
30064 full"&), the condition defers, and the message is temporarily rejected (unless
30065 the condition is on a &%warn%& verb).
30066
30067 The right-hand side is expanded before being treated as a list, so you can have
30068 conditions and lookups there. If it expands to an empty string, &"false"&, or
30069 zero (&"0"&), no demimeing is done and the condition is false.
30070
30071 The &%demime%& condition set the following variables:
30072
30073 .vlist
30074 .vitem &$demime_errorlevel$&
30075 .vindex "&$demime_errorlevel$&"
30076 When an error is detected in a MIME container, this variable contains the
30077 severity of the error, as an integer number. The higher the value, the more
30078 severe the error (the current maximum value is 3). If this variable is unset or
30079 zero, no error occurred.
30080
30081 .vitem &$demime_reason$&
30082 .vindex "&$demime_reason$&"
30083 When &$demime_errorlevel$& is greater than zero, this variable contains a
30084 human-readable text string describing the MIME error that occurred.
30085 .endlist
30086
30087 .vlist
30088 .vitem &$found_extension$&
30089 .vindex "&$found_extension$&"
30090 When the &%demime%& condition is true, this variable contains the file
30091 extension it found.
30092 .endlist
30093
30094 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30095 the &%demime%& condition, and are not changed on subsequent calls.
30096
30097 If you do not want to check for file extensions, but rather use the &%demime%&
30098 condition for unpacking or error checking purposes, pass &"*"& as the
30099 right-hand side value. Here is a more elaborate example of how to use this
30100 facility:
30101 .code
30102 # Reject messages with serious MIME container errors
30103 deny  message = Found MIME error ($demime_reason).
30104       demime = *
30105       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30106
30107 # Reject known virus spreading file extensions.
30108 # Accepting these is pretty much braindead.
30109 deny  message = contains $found_extension file (blacklisted).
30110       demime  = com:vbs:bat:pif:scr
30111
30112 # Freeze .exe and .doc files. Postmaster can
30113 # examine them and eventually thaw them.
30114 deny  log_message = Another $found_extension file.
30115       demime = exe:doc
30116       control = freeze
30117 .endd
30118 .ecindex IIDcosca
30119
30120
30121
30122
30123 . ////////////////////////////////////////////////////////////////////////////
30124 . ////////////////////////////////////////////////////////////////////////////
30125
30126 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30127          "Local scan function"
30128 .scindex IIDlosca "&[local_scan()]& function" "description of"
30129 .cindex "customizing" "input scan using C function"
30130 .cindex "policy control" "by local scan function"
30131 In these days of email worms, viruses, and ever-increasing spam, some sites
30132 want to apply a lot of checking to messages before accepting them.
30133
30134 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30135 passing messages to external virus and spam scanning software. You can also do
30136 a certain amount in Exim itself through string expansions and the &%condition%&
30137 condition in the ACL that runs after the SMTP DATA command or the ACL for
30138 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30139
30140 To allow for further customization to a site's own requirements, there is the
30141 possibility of linking Exim with a private message scanning function, written
30142 in C. If you want to run code that is written in something other than C, you
30143 can of course use a little C stub to call it.
30144
30145 The local scan function is run once for every incoming message, at the point
30146 when Exim is just about to accept the message.
30147 It can therefore be used to control non-SMTP messages from local processes as
30148 well as messages arriving via SMTP.
30149
30150 Exim applies a timeout to calls of the local scan function, and there is an
30151 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30152 Zero means &"no timeout"&.
30153 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30154 before calling the local scan function, so that the most common types of crash
30155 are caught. If the timeout is exceeded or one of those signals is caught, the
30156 incoming message is rejected with a temporary error if it is an SMTP message.
30157 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30158 code. The incident is logged on the main and reject logs.
30159
30160
30161
30162 .section "Building Exim to use a local scan function" "SECID207"
30163 .cindex "&[local_scan()]& function" "building Exim to use"
30164 To make use of the local scan function feature, you must tell Exim where your
30165 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30166 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30167 directory, so you might set
30168 .code
30169 LOCAL_SCAN_SOURCE=Local/local_scan.c
30170 .endd
30171 for example. The function must be called &[local_scan()]&. It is called by
30172 Exim after it has received a message, when the success return code is about to
30173 be sent. This is after all the ACLs have been run. The return code from your
30174 function controls whether the message is actually accepted or not. There is a
30175 commented template function (that just accepts the message) in the file
30176 _src/local_scan.c_.
30177
30178 If you want to make use of Exim's run time configuration file to set options
30179 for your &[local_scan()]& function, you must also set
30180 .code
30181 LOCAL_SCAN_HAS_OPTIONS=yes
30182 .endd
30183 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30184
30185
30186
30187
30188 .section "API for local_scan()" "SECTapiforloc"
30189 .cindex "&[local_scan()]& function" "API description"
30190 You must include this line near the start of your code:
30191 .code
30192 #include "local_scan.h"
30193 .endd
30194 This header file defines a number of variables and other values, and the
30195 prototype for the function itself. Exim is coded to use unsigned char values
30196 almost exclusively, and one of the things this header defines is a shorthand
30197 for &`unsigned char`& called &`uschar`&.
30198 It also contains the following macro definitions, to simplify casting character
30199 strings and pointers to character strings:
30200 .code
30201 #define CS   (char *)
30202 #define CCS  (const char *)
30203 #define CSS  (char **)
30204 #define US   (unsigned char *)
30205 #define CUS  (const unsigned char *)
30206 #define USS  (unsigned char **)
30207 .endd
30208 The function prototype for &[local_scan()]& is:
30209 .code
30210 extern int local_scan(int fd, uschar **return_text);
30211 .endd
30212 The arguments are as follows:
30213
30214 .ilist
30215 &%fd%& is a file descriptor for the file that contains the body of the message
30216 (the -D file). The file is open for reading and writing, but updating it is not
30217 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30218
30219 The descriptor is positioned at character 19 of the file, which is the first
30220 character of the body itself, because the first 19 characters are the message
30221 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30222 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30223 case this changes in some future version.
30224 .next
30225 &%return_text%& is an address which you can use to return a pointer to a text
30226 string at the end of the function. The value it points to on entry is NULL.
30227 .endlist
30228
30229 The function must return an &%int%& value which is one of the following macros:
30230
30231 .vlist
30232 .vitem &`LOCAL_SCAN_ACCEPT`&
30233 .vindex "&$local_scan_data$&"
30234 The message is accepted. If you pass back a string of text, it is saved with
30235 the message, and made available in the variable &$local_scan_data$&. No
30236 newlines are permitted (if there are any, they are turned into spaces) and the
30237 maximum length of text is 1000 characters.
30238
30239 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30240 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30241 queued without immediate delivery, and is frozen.
30242
30243 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30244 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30245 queued without immediate delivery.
30246
30247 .vitem &`LOCAL_SCAN_REJECT`&
30248 The message is rejected; the returned text is used as an error message which is
30249 passed back to the sender and which is also logged. Newlines are permitted &--
30250 they cause a multiline response for SMTP rejections, but are converted to
30251 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30252 used.
30253
30254 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30255 The message is temporarily rejected; the returned text is used as an error
30256 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30257 problem"& is used.
30258
30259 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30260 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30261 message is not written to the reject log. It has the effect of unsetting the
30262 &%rejected_header%& log selector for just this rejection. If
30263 &%rejected_header%& is already unset (see the discussion of the
30264 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30265 same as LOCAL_SCAN_REJECT.
30266
30267 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30268 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30269 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30270 .endlist
30271
30272 If the message is not being received by interactive SMTP, rejections are
30273 reported by writing to &%stderr%& or by sending an email, as configured by the
30274 &%-oe%& command line options.
30275
30276
30277
30278 .section "Configuration options for local_scan()" "SECTconoptloc"
30279 .cindex "&[local_scan()]& function" "configuration options"
30280 It is possible to have option settings in the main configuration file
30281 that set values in static variables in the &[local_scan()]& module. If you
30282 want to do this, you must have the line
30283 .code
30284 LOCAL_SCAN_HAS_OPTIONS=yes
30285 .endd
30286 in your &_Local/Makefile_& when you build Exim. (This line is in
30287 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30288 file, you must define static variables to hold the option values, and a table
30289 to define them.
30290
30291 The table must be a vector called &%local_scan_options%&, of type
30292 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30293 and a pointer to the variable that holds the value. The entries must appear in
30294 alphabetical order. Following &%local_scan_options%& you must also define a
30295 variable called &%local_scan_options_count%& that contains the number of
30296 entries in the table. Here is a short example, showing two kinds of option:
30297 .code
30298 static int my_integer_option = 42;
30299 static uschar *my_string_option = US"a default string";
30300
30301 optionlist local_scan_options[] = {
30302   { "my_integer", opt_int,       &my_integer_option },
30303   { "my_string",  opt_stringptr, &my_string_option }
30304 };
30305
30306 int local_scan_options_count =
30307   sizeof(local_scan_options)/sizeof(optionlist);
30308 .endd
30309 The values of the variables can now be changed from Exim's runtime
30310 configuration file by including a local scan section as in this example:
30311 .code
30312 begin local_scan
30313 my_integer = 99
30314 my_string = some string of text...
30315 .endd
30316 The available types of option data are as follows:
30317
30318 .vlist
30319 .vitem &*opt_bool*&
30320 This specifies a boolean (true/false) option. The address should point to a
30321 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30322 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30323 whether such a variable has been set at all, you can initialize it to
30324 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30325 values.)
30326
30327 .vitem &*opt_fixed*&
30328 This specifies a fixed point number, such as is used for load averages.
30329 The address should point to a variable of type &`int`&. The value is stored
30330 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30331
30332 .vitem &*opt_int*&
30333 This specifies an integer; the address should point to a variable of type
30334 &`int`&. The value may be specified in any of the integer formats accepted by
30335 Exim.
30336
30337 .vitem &*opt_mkint*&
30338 This is the same as &%opt_int%&, except that when such a value is output in a
30339 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30340 printed with the suffix K or M.
30341
30342 .vitem &*opt_octint*&
30343 This also specifies an integer, but the value is always interpreted as an
30344 octal integer, whether or not it starts with the digit zero, and it is
30345 always output in octal.
30346
30347 .vitem &*opt_stringptr*&
30348 This specifies a string value; the address must be a pointer to a
30349 variable that points to a string (for example, of type &`uschar *`&).
30350
30351 .vitem &*opt_time*&
30352 This specifies a time interval value. The address must point to a variable of
30353 type &`int`&. The value that is placed there is a number of seconds.
30354 .endlist
30355
30356 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30357 out the values of all the &[local_scan()]& options.
30358
30359
30360
30361 .section "Available Exim variables" "SECID208"
30362 .cindex "&[local_scan()]& function" "available Exim variables"
30363 The header &_local_scan.h_& gives you access to a number of C variables. These
30364 are the only ones that are guaranteed to be maintained from release to release.
30365 Note, however, that you can obtain the value of any Exim expansion variable,
30366 including &$recipients$&, by calling &'expand_string()'&. The exported
30367 C variables are as follows:
30368
30369 .vlist
30370 .vitem &*int&~body_linecount*&
30371 This variable contains the number of lines in the message's body.
30372
30373 .vitem &*int&~body_zerocount*&
30374 This variable contains the number of binary zero bytes in the message's body.
30375
30376 .vitem &*unsigned&~int&~debug_selector*&
30377 This variable is set to zero when no debugging is taking place. Otherwise, it
30378 is a bitmap of debugging selectors. Two bits are identified for use in
30379 &[local_scan()]&; they are defined as macros:
30380
30381 .ilist
30382 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30383 testing option that is not privileged &-- any caller may set it. All the
30384 other selector bits can be set only by admin users.
30385
30386 .next
30387 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30388 by the &`+local_scan`& debug selector. It is not included in the default set
30389 of debugging bits.
30390 .endlist ilist
30391
30392 Thus, to write to the debugging output only when &`+local_scan`& has been
30393 selected, you should use code like this:
30394 .code
30395 if ((debug_selector & D_local_scan) != 0)
30396   debug_printf("xxx", ...);
30397 .endd
30398 .vitem &*uschar&~*expand_string_message*&
30399 After a failing call to &'expand_string()'& (returned value NULL), the
30400 variable &%expand_string_message%& contains the error message, zero-terminated.
30401
30402 .vitem &*header_line&~*header_list*&
30403 A pointer to a chain of header lines. The &%header_line%& structure is
30404 discussed below.
30405
30406 .vitem &*header_line&~*header_last*&
30407 A pointer to the last of the header lines.
30408
30409 .vitem &*uschar&~*headers_charset*&
30410 The value of the &%headers_charset%& configuration option.
30411
30412 .vitem &*BOOL&~host_checking*&
30413 This variable is TRUE during a host checking session that is initiated by the
30414 &%-bh%& command line option.
30415
30416 .vitem &*uschar&~*interface_address*&
30417 The IP address of the interface that received the message, as a string. This
30418 is NULL for locally submitted messages.
30419
30420 .vitem &*int&~interface_port*&
30421 The port on which this message was received. When testing with the &%-bh%&
30422 command line option, the value of this variable is -1 unless a port has been
30423 specified via the &%-oMi%& option.
30424
30425 .vitem &*uschar&~*message_id*&
30426 This variable contains Exim's message id for the incoming message (the value of
30427 &$message_exim_id$&) as a zero-terminated string.
30428
30429 .vitem &*uschar&~*received_protocol*&
30430 The name of the protocol by which the message was received.
30431
30432 .vitem &*int&~recipients_count*&
30433 The number of accepted recipients.
30434
30435 .vitem &*recipient_item&~*recipients_list*&
30436 .cindex "recipient" "adding in local scan"
30437 .cindex "recipient" "removing in local scan"
30438 The list of accepted recipients, held in a vector of length
30439 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30440 can add additional recipients by calling &'receive_add_recipient()'& (see
30441 below). You can delete recipients by removing them from the vector and
30442 adjusting the value in &%recipients_count%&. In particular, by setting
30443 &%recipients_count%& to zero you remove all recipients. If you then return the
30444 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30445 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30446 and then call &'receive_add_recipient()'& as often as needed.
30447
30448 .vitem &*uschar&~*sender_address*&
30449 The envelope sender address. For bounce messages this is the empty string.
30450
30451 .vitem &*uschar&~*sender_host_address*&
30452 The IP address of the sending host, as a string. This is NULL for
30453 locally-submitted messages.
30454
30455 .vitem &*uschar&~*sender_host_authenticated*&
30456 The name of the authentication mechanism that was used, or NULL if the message
30457 was not received over an authenticated SMTP connection.
30458
30459 .vitem &*uschar&~*sender_host_name*&
30460 The name of the sending host, if known.
30461
30462 .vitem &*int&~sender_host_port*&
30463 The port on the sending host.
30464
30465 .vitem &*BOOL&~smtp_input*&
30466 This variable is TRUE for all SMTP input, including BSMTP.
30467
30468 .vitem &*BOOL&~smtp_batched_input*&
30469 This variable is TRUE for BSMTP input.
30470
30471 .vitem &*int&~store_pool*&
30472 The contents of this variable control which pool of memory is used for new
30473 requests. See section &<<SECTmemhanloc>>& for details.
30474 .endlist
30475
30476
30477 .section "Structure of header lines" "SECID209"
30478 The &%header_line%& structure contains the members listed below.
30479 You can add additional header lines by calling the &'header_add()'& function
30480 (see below). You can cause header lines to be ignored (deleted) by setting
30481 their type to *.
30482
30483
30484 .vlist
30485 .vitem &*struct&~header_line&~*next*&
30486 A pointer to the next header line, or NULL for the last line.
30487
30488 .vitem &*int&~type*&
30489 A code identifying certain headers that Exim recognizes. The codes are printing
30490 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30491 Notice in particular that any header line whose type is * is not transmitted
30492 with the message. This flagging is used for header lines that have been
30493 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30494 lines.) Effectively, * means &"deleted"&.
30495
30496 .vitem &*int&~slen*&
30497 The number of characters in the header line, including the terminating and any
30498 internal newlines.
30499
30500 .vitem &*uschar&~*text*&
30501 A pointer to the text of the header. It always ends with a newline, followed by
30502 a zero byte. Internal newlines are preserved.
30503 .endlist
30504
30505
30506
30507 .section "Structure of recipient items" "SECID210"
30508 The &%recipient_item%& structure contains these members:
30509
30510 .vlist
30511 .vitem &*uschar&~*address*&
30512 This is a pointer to the recipient address as it was received.
30513
30514 .vitem &*int&~pno*&
30515 This is used in later Exim processing when top level addresses are created by
30516 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30517 and must always contain -1 at this stage.
30518
30519 .vitem &*uschar&~*errors_to*&
30520 If this value is not NULL, bounce messages caused by failing to deliver to the
30521 recipient are sent to the address it contains. In other words, it overrides the
30522 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30523 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30524 an unqualified address, Exim qualifies it using the domain from
30525 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30526 is NULL for all recipients.
30527 .endlist
30528
30529
30530
30531 .section "Available Exim functions" "SECID211"
30532 .cindex "&[local_scan()]& function" "available Exim functions"
30533 The header &_local_scan.h_& gives you access to a number of Exim functions.
30534 These are the only ones that are guaranteed to be maintained from release to
30535 release:
30536
30537 .vlist
30538 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30539        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30540
30541 This function creates a child process that runs the command specified by
30542 &%argv%&. The environment for the process is specified by &%envp%&, which can
30543 be NULL if no environment variables are to be passed. A new umask is supplied
30544 for the process in &%newumask%&.
30545
30546 Pipes to the standard input and output of the new process are set up
30547 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30548 standard error is cloned to the standard output. If there are any file
30549 descriptors &"in the way"& in the new process, they are closed. If the final
30550 argument is TRUE, the new process is made into a process group leader.
30551
30552 The function returns the pid of the new process, or -1 if things go wrong.
30553
30554 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30555 This function waits for a child process to terminate, or for a timeout (in
30556 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30557 return value is as follows:
30558
30559 .ilist
30560 >= 0
30561
30562 The process terminated by a normal exit and the value is the process
30563 ending status.
30564
30565 .next
30566 < 0 and > &--256
30567
30568 The process was terminated by a signal and the value is the negation of the
30569 signal number.
30570
30571 .next
30572 &--256
30573
30574 The process timed out.
30575 .next
30576 &--257
30577
30578 The was some other error in wait(); &%errno%& is still set.
30579 .endlist
30580
30581 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30582 This function provide you with a means of submitting a new message to
30583 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30584 want, but this packages it all up for you.) The function creates a pipe,
30585 forks a subprocess that is running
30586 .code
30587 exim -t -oem -oi -f <>
30588 .endd
30589 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30590 that is connected to the standard input. The yield of the function is the PID
30591 of the subprocess. You can then write a message to the file descriptor, with
30592 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30593
30594 When you have finished, call &'child_close()'& to wait for the process to
30595 finish and to collect its ending status. A timeout value of zero is usually
30596 fine in this circumstance. Unless you have made a mistake with the recipient
30597 addresses, you should get a return code of zero.
30598
30599
30600 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30601        *sender_authentication)*&
30602 This function is a more sophisticated version of &'child_open()'&. The command
30603 that it runs is:
30604 .display
30605 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30606 .endd
30607 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30608
30609
30610 .vitem &*void&~debug_printf(char&~*,&~...)*&
30611 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30612 output is written to the standard error stream. If no debugging is selected,
30613 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30614 conditional on the &`local_scan`& debug selector by coding like this:
30615 .code
30616 if ((debug_selector & D_local_scan) != 0)
30617   debug_printf("xxx", ...);
30618 .endd
30619
30620 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30621 This is an interface to Exim's string expansion code. The return value is the
30622 expanded string, or NULL if there was an expansion failure.
30623 The C variable &%expand_string_message%& contains an error message after an
30624 expansion failure. If expansion does not change the string, the return value is
30625 the pointer to the input string. Otherwise, the return value points to a new
30626 block of memory that was obtained by a call to &'store_get()'&. See section
30627 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30628
30629 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30630 This function allows you to an add additional header line at the end of the
30631 existing ones. The first argument is the type, and should normally be a space
30632 character. The second argument is a format string and any number of
30633 substitution arguments as for &[sprintf()]&. You may include internal newlines
30634 if you want, and you must ensure that the string ends with a newline.
30635
30636 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30637         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30638 This function adds a new header line at a specified point in the header
30639 chain. The header itself is specified as for &'header_add()'&.
30640
30641 If &%name%& is NULL, the new header is added at the end of the chain if
30642 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30643 NULL, the header lines are searched for the first non-deleted header that
30644 matches the name. If one is found, the new header is added before it if
30645 &%after%& is false. If &%after%& is true, the new header is added after the
30646 found header and any adjacent subsequent ones with the same name (even if
30647 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30648 option controls where the header is added. If it is true, addition is at the
30649 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30650 headers, or at the top if there are no &'Received:'& headers, you could use
30651 .code
30652 header_add_at_position(TRUE, US"Received", TRUE,
30653   ' ', "X-xxx: ...");
30654 .endd
30655 Normally, there is always at least one non-deleted &'Received:'& header, but
30656 there may not be if &%received_header_text%& expands to an empty string.
30657
30658
30659 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30660 This function removes header lines. If &%occurrence%& is zero or negative, all
30661 occurrences of the header are removed. If occurrence is greater than zero, that
30662 particular instance of the header is removed. If no header(s) can be found that
30663 match the specification, the function does nothing.
30664
30665
30666 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30667         int&~length,&~BOOL&~notdel)*&"
30668 This function tests whether the given header has the given name. It is not just
30669 a string comparison, because white space is permitted between the name and the
30670 colon. If the &%notdel%& argument is true, a false return is forced for all
30671 &"deleted"& headers; otherwise they are not treated specially. For example:
30672 .code
30673 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30674 .endd
30675 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30676 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30677 This function base64-encodes a string, which is passed by address and length.
30678 The text may contain bytes of any value, including zero. The result is passed
30679 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30680 zero-terminated.
30681
30682 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30683 This function decodes a base64-encoded string. Its arguments are a
30684 zero-terminated base64-encoded string and the address of a variable that is set
30685 to point to the result, which is in dynamic memory. The length of the decoded
30686 string is the yield of the function. If the input is invalid base64 data, the
30687 yield is -1. A zero byte is added to the end of the output string to make it
30688 easy to interpret as a C string (assuming it contains no zeros of its own). The
30689 added zero byte is not included in the returned count.
30690
30691 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30692 This function checks for a match in a domain list. Domains are always
30693 matched caselessly. The return value is one of the following:
30694 .display
30695 &`OK     `& match succeeded
30696 &`FAIL   `& match failed
30697 &`DEFER  `& match deferred
30698 .endd
30699 DEFER is usually caused by some kind of lookup defer, such as the
30700 inability to contact a database.
30701
30702 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30703         BOOL&~caseless)*&"
30704 This function checks for a match in a local part list. The third argument
30705 controls case-sensitivity. The return values are as for
30706 &'lss_match_domain()'&.
30707
30708 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30709         BOOL&~caseless)*&"
30710 This function checks for a match in an address list. The third argument
30711 controls the case-sensitivity of the local part match. The domain is always
30712 matched caselessly. The return values are as for &'lss_match_domain()'&.
30713
30714 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30715         uschar&~*list)*&"
30716 This function checks for a match in a host list. The most common usage is
30717 expected to be
30718 .code
30719 lss_match_host(sender_host_name, sender_host_address, ...)
30720 .endd
30721 .vindex "&$sender_host_address$&"
30722 An empty address field matches an empty item in the host list. If the host name
30723 is NULL, the name corresponding to &$sender_host_address$& is automatically
30724 looked up if a host name is required to match an item in the list. The return
30725 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30726 returns ERROR in the case when it had to look up a host name, but the lookup
30727 failed.
30728
30729 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30730         *format,&~...)*&"
30731 This function writes to Exim's log files. The first argument should be zero (it
30732 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30733 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30734 them. It specifies to which log or logs the message is written. The remaining
30735 arguments are a format and relevant insertion arguments. The string should not
30736 contain any newlines, not even at the end.
30737
30738
30739 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30740 This function adds an additional recipient to the message. The first argument
30741 is the recipient address. If it is unqualified (has no domain), it is qualified
30742 with the &%qualify_recipient%& domain. The second argument must always be -1.
30743
30744 This function does not allow you to specify a private &%errors_to%& address (as
30745 described with the structure of &%recipient_item%& above), because it pre-dates
30746 the addition of that field to the structure. However, it is easy to add such a
30747 value afterwards. For example:
30748 .code
30749  receive_add_recipient(US"monitor@mydom.example", -1);
30750  recipients_list[recipients_count-1].errors_to =
30751    US"postmaster@mydom.example";
30752 .endd
30753
30754 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30755 This is a convenience function to remove a named recipient from the list of
30756 recipients. It returns true if a recipient was removed, and false if no
30757 matching recipient could be found. The argument must be a complete email
30758 address.
30759 .endlist
30760
30761
30762 .cindex "RFC 2047"
30763 .vlist
30764 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30765   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30766 This function decodes strings that are encoded according to RFC 2047. Typically
30767 these are the contents of header lines. First, each &"encoded word"& is decoded
30768 from the Q or B encoding into a byte-string. Then, if provided with the name of
30769 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30770 made  to translate the result to the named character set. If this fails, the
30771 binary string is returned with an error message.
30772
30773 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30774 maximum MIME word length is enforced. The third argument is the target
30775 encoding, or NULL if no translation is wanted.
30776
30777 .cindex "binary zero" "in RFC 2047 decoding"
30778 .cindex "RFC 2047" "binary zero in"
30779 If a binary zero is encountered in the decoded string, it is replaced by the
30780 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30781 not be 0 because header lines are handled as zero-terminated strings.
30782
30783 The function returns the result of processing the string, zero-terminated; if
30784 &%lenptr%& is not NULL, the length of the result is set in the variable to
30785 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30786
30787 If an error is encountered, the function returns NULL and uses the &%error%&
30788 argument to return an error message. The variable pointed to by &%error%& is
30789 set to NULL if there is no error; it may be set non-NULL even when the function
30790 returns a non-NULL value if decoding was successful, but there was a problem
30791 with translation.
30792
30793
30794 .vitem &*int&~smtp_fflush(void)*&
30795 This function is used in conjunction with &'smtp_printf()'&, as described
30796 below.
30797
30798 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30799 The arguments of this function are like &[printf()]&; it writes to the SMTP
30800 output stream. You should use this function only when there is an SMTP output
30801 stream, that is, when the incoming message is being received via interactive
30802 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30803 is FALSE. If you want to test for an incoming message from another host (as
30804 opposed to a local process that used the &%-bs%& command line option), you can
30805 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30806 is involved.
30807
30808 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30809 output function, so it can be used for all forms of SMTP connection.
30810
30811 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30812 must start with an appropriate response code: 550 if you are going to return
30813 LOCAL_SCAN_REJECT, 451 if you are going to return
30814 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30815 initial lines of a multi-line response, the code must be followed by a hyphen
30816 to indicate that the line is not the final response line. You must also ensure
30817 that the lines you write terminate with CRLF. For example:
30818 .code
30819 smtp_printf("550-this is some extra info\r\n");
30820 return LOCAL_SCAN_REJECT;
30821 .endd
30822 Note that you can also create multi-line responses by including newlines in
30823 the data returned via the &%return_text%& argument. The added value of using
30824 &'smtp_printf()'& is that, for instance, you could introduce delays between
30825 multiple output lines.
30826
30827 The &'smtp_printf()'& function does not return any error indication, because it
30828 does not automatically flush pending output, and therefore does not test
30829 the state of the stream. (In the main code of Exim, flushing and error
30830 detection is done when Exim is ready for the next SMTP input command.) If
30831 you want to flush the output and check for an error (for example, the
30832 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30833 arguments. It flushes the output stream, and returns a non-zero value if there
30834 is an error.
30835
30836 .vitem &*void&~*store_get(int)*&
30837 This function accesses Exim's internal store (memory) manager. It gets a new
30838 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30839 runs out of memory. See the next section for a discussion of memory handling.
30840
30841 .vitem &*void&~*store_get_perm(int)*&
30842 This function is like &'store_get()'&, but it always gets memory from the
30843 permanent pool. See the next section for a discussion of memory handling.
30844
30845 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30846 See below.
30847
30848 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30849 See below.
30850
30851 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30852 These three functions create strings using Exim's dynamic memory facilities.
30853 The first makes a copy of an entire string. The second copies up to a maximum
30854 number of characters, indicated by the second argument. The third uses a format
30855 and insertion arguments to create a new string. In each case, the result is a
30856 pointer to a new string in the current memory pool. See the next section for
30857 more discussion.
30858 .endlist
30859
30860
30861
30862 .section "More about Exim's memory handling" "SECTmemhanloc"
30863 .cindex "&[local_scan()]& function" "memory handling"
30864 No function is provided for freeing memory, because that is never needed.
30865 The dynamic memory that Exim uses when receiving a message is automatically
30866 recycled if another message is received by the same process (this applies only
30867 to incoming SMTP connections &-- other input methods can supply only one
30868 message at a time). After receiving the last message, a reception process
30869 terminates.
30870
30871 Because it is recycled, the normal dynamic memory cannot be used for holding
30872 data that must be preserved over a number of incoming messages on the same SMTP
30873 connection. However, Exim in fact uses two pools of dynamic memory; the second
30874 one is not recycled, and can be used for this purpose.
30875
30876 If you want to allocate memory that remains available for subsequent messages
30877 in the same SMTP connection, you should set
30878 .code
30879 store_pool = POOL_PERM
30880 .endd
30881 before calling the function that does the allocation. There is no need to
30882 restore the value if you do not need to; however, if you do want to revert to
30883 the normal pool, you can either restore the previous value of &%store_pool%& or
30884 set it explicitly to POOL_MAIN.
30885
30886 The pool setting applies to all functions that get dynamic memory, including
30887 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30888 There is also a convenience function called &'store_get_perm()'& that gets a
30889 block of memory from the permanent pool while preserving the value of
30890 &%store_pool%&.
30891 .ecindex IIDlosca
30892
30893
30894
30895
30896 . ////////////////////////////////////////////////////////////////////////////
30897 . ////////////////////////////////////////////////////////////////////////////
30898
30899 .chapter "System-wide message filtering" "CHAPsystemfilter"
30900 .scindex IIDsysfil1 "filter" "system filter"
30901 .scindex IIDsysfil2 "filtering all mail"
30902 .scindex IIDsysfil3 "system filter"
30903 The previous chapters (on ACLs and the local scan function) describe checks
30904 that can be applied to messages before they are accepted by a host. There is
30905 also a mechanism for checking messages once they have been received, but before
30906 they are delivered. This is called the &'system filter'&.
30907
30908 The system filter operates in a similar manner to users' filter files, but it
30909 is run just once per message (however many recipients the message has).
30910 It should not normally be used as a substitute for routing, because &%deliver%&
30911 commands in a system router provide new envelope recipient addresses.
30912 The system filter must be an Exim filter. It cannot be a Sieve filter.
30913
30914 The system filter is run at the start of a delivery attempt, before any routing
30915 is done. If a message fails to be completely delivered at the first attempt,
30916 the system filter is run again at the start of every retry.
30917 If you want your filter to do something only once per message, you can make use
30918 of the &%first_delivery%& condition in an &%if%& command in the filter to
30919 prevent it happening on retries.
30920
30921 .vindex "&$domain$&"
30922 .vindex "&$local_part$&"
30923 &*Warning*&: Because the system filter runs just once, variables that are
30924 specific to individual recipient addresses, such as &$local_part$& and
30925 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30926 you want to run a centrally-specified filter for each recipient address
30927 independently, you can do so by setting up a suitable &(redirect)& router, as
30928 described in section &<<SECTperaddfil>>& below.
30929
30930
30931 .section "Specifying a system filter" "SECID212"
30932 .cindex "uid (user id)" "system filter"
30933 .cindex "gid (group id)" "system filter"
30934 The name of the file that contains the system filter must be specified by
30935 setting &%system_filter%&. If you want the filter to run under a uid and gid
30936 other than root, you must also set &%system_filter_user%& and
30937 &%system_filter_group%& as appropriate. For example:
30938 .code
30939 system_filter = /etc/mail/exim.filter
30940 system_filter_user = exim
30941 .endd
30942 If a system filter generates any deliveries directly to files or pipes (via the
30943 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30944 specified by setting &%system_filter_file_transport%& and
30945 &%system_filter_pipe_transport%&, respectively. Similarly,
30946 &%system_filter_reply_transport%& must be set to handle any messages generated
30947 by the &%reply%& command.
30948
30949
30950 .section "Testing a system filter" "SECID213"
30951 You can run simple tests of a system filter in the same way as for a user
30952 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30953 are permitted only in system filters are recognized.
30954
30955 If you want to test the combined effect of a system filter and a user filter,
30956 you can use both &%-bF%& and &%-bf%& on the same command line.
30957
30958
30959
30960 .section "Contents of a system filter" "SECID214"
30961 The language used to specify system filters is the same as for users' filter
30962 files. It is described in the separate end-user document &'Exim's interface to
30963 mail filtering'&. However, there are some additional features that are
30964 available only in system filters; these are described in subsequent sections.
30965 If they are encountered in a user's filter file or when testing with &%-bf%&,
30966 they cause errors.
30967
30968 .cindex "frozen messages" "manual thaw; testing in filter"
30969 There are two special conditions which, though available in users' filter
30970 files, are designed for use in system filters. The condition &%first_delivery%&
30971 is true only for the first attempt at delivering a message, and
30972 &%manually_thawed%& is true only if the message has been frozen, and
30973 subsequently thawed by an admin user. An explicit forced delivery counts as a
30974 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30975
30976 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30977 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30978 succeed, it will not be tried again.
30979 If you want Exim to retry an unseen delivery until it succeeds, you should
30980 arrange to set it up every time the filter runs.
30981
30982 When a system filter finishes running, the values of the variables &$n0$& &--
30983 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30984 users' filter files. Thus a system filter can, for example, set up &"scores"&
30985 to which users' filter files can refer.
30986
30987
30988
30989 .section "Additional variable for system filters" "SECID215"
30990 .vindex "&$recipients$&"
30991 The expansion variable &$recipients$&, containing a list of all the recipients
30992 of the message (separated by commas and white space), is available in system
30993 filters. It is not available in users' filters for privacy reasons.
30994
30995
30996
30997 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30998 .cindex "freezing messages"
30999 .cindex "message" "freezing"
31000 .cindex "message" "forced failure"
31001 .cindex "&%fail%&" "in system filter"
31002 .cindex "&%freeze%& in system filter"
31003 .cindex "&%defer%& in system filter"
31004 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31005 always available in system filters, but are not normally enabled in users'
31006 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31007 for the &(redirect)& router.) These commands can optionally be followed by the
31008 word &%text%& and a string containing an error message, for example:
31009 .code
31010 fail text "this message looks like spam to me"
31011 .endd
31012 The keyword &%text%& is optional if the next character is a double quote.
31013
31014 The &%defer%& command defers delivery of the original recipients of the
31015 message. The &%fail%& command causes all the original recipients to be failed,
31016 and a bounce message to be created. The &%freeze%& command suspends all
31017 delivery attempts for the original recipients. In all cases, any new deliveries
31018 that are specified by the filter are attempted as normal after the filter has
31019 run.
31020
31021 The &%freeze%& command is ignored if the message has been manually unfrozen and
31022 not manually frozen since. This means that automatic freezing by a system
31023 filter can be used as a way of checking out suspicious messages. If a message
31024 is found to be all right, manually unfreezing it allows it to be delivered.
31025
31026 .cindex "log" "&%fail%& command log line"
31027 .cindex "&%fail%&" "log line; reducing"
31028 The text given with a fail command is used as part of the bounce message as
31029 well as being written to the log. If the message is quite long, this can fill
31030 up a lot of log space when such failures are common. To reduce the size of the
31031 log message, Exim interprets the text in a special way if it starts with the
31032 two characters &`<<`& and contains &`>>`& later. The text between these two
31033 strings is written to the log, and the rest of the text is used in the bounce
31034 message. For example:
31035 .code
31036 fail "<<filter test 1>>Your message is rejected \
31037      because it contains attachments that we are \
31038      not prepared to receive."
31039 .endd
31040
31041 .cindex "loop" "caused by &%fail%&"
31042 Take great care with the &%fail%& command when basing the decision to fail on
31043 the contents of the message, because the bounce message will of course include
31044 the contents of the original message and will therefore trigger the &%fail%&
31045 command again (causing a mail loop) unless steps are taken to prevent this.
31046 Testing the &%error_message%& condition is one way to prevent this. You could
31047 use, for example
31048 .code
31049 if $message_body contains "this is spam" and not error_message
31050 then fail text "spam is not wanted here" endif
31051 .endd
31052 though of course that might let through unwanted bounce messages. The
31053 alternative is clever checking of the body and/or headers to detect bounces
31054 generated by the filter.
31055
31056 The interpretation of a system filter file ceases after a
31057 &%defer%&,
31058 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31059 set up earlier in the filter file are honoured, so you can use a sequence such
31060 as
31061 .code
31062 mail ...
31063 freeze
31064 .endd
31065 to send a specified message when the system filter is freezing (or deferring or
31066 failing) a message. The normal deliveries for the message do not, of course,
31067 take place.
31068
31069
31070
31071 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31072 .cindex "header lines" "adding; in system filter"
31073 .cindex "header lines" "removing; in system filter"
31074 .cindex "filter" "header lines; adding/removing"
31075 Two filter commands that are available only in system filters are:
31076 .code
31077 headers add <string>
31078 headers remove <string>
31079 .endd
31080 The argument for the &%headers add%& is a string that is expanded and then
31081 added to the end of the message's headers. It is the responsibility of the
31082 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31083 space is ignored, and if the string is otherwise empty, or if the expansion is
31084 forced to fail, the command has no effect.
31085
31086 You can use &"\n"& within the string, followed by white space, to specify
31087 continued header lines. More than one header may be added in one command by
31088 including &"\n"& within the string without any following white space. For
31089 example:
31090 .code
31091 headers add "X-header-1: ....\n  \
31092              continuation of X-header-1 ...\n\
31093              X-header-2: ...."
31094 .endd
31095 Note that the header line continuation white space after the first newline must
31096 be placed before the backslash that continues the input string, because white
31097 space after input continuations is ignored.
31098
31099 The argument for &%headers remove%& is a colon-separated list of header names.
31100 This command applies only to those headers that are stored with the message;
31101 those that are added at delivery time (such as &'Envelope-To:'& and
31102 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31103 header with the same name, they are all removed.
31104
31105 The &%headers%& command in a system filter makes an immediate change to the set
31106 of header lines that was received with the message (with possible additions
31107 from ACL processing). Subsequent commands in the system filter operate on the
31108 modified set, which also forms the basis for subsequent message delivery.
31109 Unless further modified during routing or transporting, this set of headers is
31110 used for all recipients of the message.
31111
31112 During routing and transporting, the variables that refer to the contents of
31113 header lines refer only to those lines that are in this set. Thus, header lines
31114 that are added by a system filter are visible to users' filter files and to all
31115 routers and transports. This contrasts with the manipulation of header lines by
31116 routers and transports, which is not immediate, but which instead is saved up
31117 until the message is actually being written (see section
31118 &<<SECTheadersaddrem>>&).
31119
31120 If the message is not delivered at the first attempt, header lines that were
31121 added by the system filter are stored with the message, and so are still
31122 present at the next delivery attempt. Header lines that were removed are still
31123 present, but marked &"deleted"& so that they are not transported with the
31124 message. For this reason, it is usual to make the &%headers%& command
31125 conditional on &%first_delivery%& so that the set of header lines is not
31126 modified more than once.
31127
31128 Because header modification in a system filter acts immediately, you have to
31129 use an indirect approach if you want to modify the contents of a header line.
31130 For example:
31131 .code
31132 headers add "Old-Subject: $h_subject:"
31133 headers remove "Subject"
31134 headers add "Subject: new subject (was: $h_old-subject:)"
31135 headers remove "Old-Subject"
31136 .endd
31137
31138
31139
31140 .section "Setting an errors address in a system filter" "SECID217"
31141 .cindex "envelope sender"
31142 In a system filter, if a &%deliver%& command is followed by
31143 .code
31144 errors_to <some address>
31145 .endd
31146 in order to change the envelope sender (and hence the error reporting) for that
31147 delivery, any address may be specified. (In a user filter, only the current
31148 user's address can be set.) For example, if some mail is being monitored, you
31149 might use
31150 .code
31151 unseen deliver monitor@spying.example errors_to root@local.example
31152 .endd
31153 to take a copy which would not be sent back to the normal error reporting
31154 address if its delivery failed.
31155
31156
31157
31158 .section "Per-address filtering" "SECTperaddfil"
31159 .vindex "&$domain$&"
31160 .vindex "&$local_part$&"
31161 In contrast to the system filter, which is run just once per message for each
31162 delivery attempt, it is also possible to set up a system-wide filtering
31163 operation that runs once for each recipient address. In this case, variables
31164 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31165 filter file could be made dependent on them. This is an example of a router
31166 which implements such a filter:
31167 .code
31168 central_filter:
31169   check_local_user
31170   driver = redirect
31171   domains = +local_domains
31172   file = /central/filters/$local_part
31173   no_verify
31174   allow_filter
31175   allow_freeze
31176 .endd
31177 The filter is run in a separate process under its own uid. Therefore, either
31178 &%check_local_user%& must be set (as above), in which case the filter is run as
31179 the local user, or the &%user%& option must be used to specify which user to
31180 use. If both are set, &%user%& overrides.
31181
31182 Care should be taken to ensure that none of the commands in the filter file
31183 specify a significant delivery if the message is to go on to be delivered to
31184 its intended recipient. The router will not then claim to have dealt with the
31185 address, so it will be passed on to subsequent routers to be delivered in the
31186 normal way.
31187 .ecindex IIDsysfil1
31188 .ecindex IIDsysfil2
31189 .ecindex IIDsysfil3
31190
31191
31192
31193
31194
31195
31196 . ////////////////////////////////////////////////////////////////////////////
31197 . ////////////////////////////////////////////////////////////////////////////
31198
31199 .chapter "Message processing" "CHAPmsgproc"
31200 .scindex IIDmesproc "message" "general processing"
31201 Exim performs various transformations on the sender and recipient addresses of
31202 all messages that it handles, and also on the messages' header lines. Some of
31203 these are optional and configurable, while others always take place. All of
31204 this processing, except rewriting as a result of routing, and the addition or
31205 removal of header lines while delivering, happens when a message is received,
31206 before it is placed on Exim's queue.
31207
31208 Some of the automatic processing takes place by default only for
31209 &"locally-originated"& messages. This adjective is used to describe messages
31210 that are not received over TCP/IP, but instead are passed to an Exim process on
31211 its standard input. This includes the interactive &"local SMTP"& case that is
31212 set up by the &%-bs%& command line option.
31213
31214 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31215 or ::1) are not considered to be locally-originated. Exim does not treat the
31216 loopback interface specially in any way.
31217
31218 If you want the loopback interface to be treated specially, you must ensure
31219 that there are appropriate entries in your ACLs.
31220
31221
31222
31223
31224 .section "Submission mode for non-local messages" "SECTsubmodnon"
31225 .cindex "message" "submission"
31226 .cindex "submission mode"
31227 Processing that happens automatically for locally-originated messages (unless
31228 &%suppress_local_fixups%& is set) can also be requested for messages that are
31229 received over TCP/IP. The term &"submission mode"& is used to describe this
31230 state. Submission mode is set by the modifier
31231 .code
31232 control = submission
31233 .endd
31234 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31235 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31236 a local submission, and is normally used when the source of the message is
31237 known to be an MUA running on a client host (as opposed to an MTA). For
31238 example, to set submission mode for messages originating on the IPv4 loopback
31239 interface, you could include the following in the MAIL ACL:
31240 .code
31241 warn  hosts = 127.0.0.1
31242       control = submission
31243 .endd
31244 .cindex "&%sender_retain%& submission option"
31245 There are some options that can be used when setting submission mode. A slash
31246 is used to separate options. For example:
31247 .code
31248 control = submission/sender_retain
31249 .endd
31250 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31251 true and &%local_from_check%& false for the current incoming message. The first
31252 of these allows an existing &'Sender:'& header in the message to remain, and
31253 the second suppresses the check to ensure that &'From:'& matches the
31254 authenticated sender. With this setting, Exim still fixes up messages by adding
31255 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31256 attempt to check sender authenticity in header lines.
31257
31258 When &%sender_retain%& is not set, a submission mode setting may specify a
31259 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31260 example:
31261 .code
31262 control = submission/domain=some.domain
31263 .endd
31264 The domain may be empty. How this value is used is described in sections
31265 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31266 that allows you to specify the user's full name for inclusion in a created
31267 &'Sender:'& or &'From:'& header line. For example:
31268 .code
31269 accept authenticated = *
31270        control = submission/domain=wonderland.example/\
31271                             name=${lookup {$authenticated_id} \
31272                                    lsearch {/etc/exim/namelist}}
31273 .endd
31274 Because the name may contain any characters, including slashes, the &%name%&
31275 option must be given last. The remainder of the string is used as the name. For
31276 the example above, if &_/etc/exim/namelist_& contains:
31277 .code
31278 bigegg:  Humpty Dumpty
31279 .endd
31280 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31281 line would be:
31282 .code
31283 Sender: Humpty Dumpty <bigegg@wonderland.example>
31284 .endd
31285 .cindex "return path" "in submission mode"
31286 By default, submission mode forces the return path to the same address as is
31287 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31288 specified, the return path is also left unchanged.
31289
31290 &*Note*&: The changes caused by submission mode take effect after the predata
31291 ACL. This means that any sender checks performed before the fix-ups use the
31292 untrusted sender address specified by the user, not the trusted sender address
31293 specified by submission mode. Although this might be slightly unexpected, it
31294 does mean that you can configure ACL checks to spot that a user is trying to
31295 spoof another's address.
31296
31297 .section "Line endings" "SECTlineendings"
31298 .cindex "line endings"
31299 .cindex "carriage return"
31300 .cindex "linefeed"
31301 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31302 linefeed) is the line ending for messages transmitted over the Internet using
31303 SMTP over TCP/IP. However, within individual operating systems, different
31304 conventions are used. For example, Unix-like systems use just LF, but others
31305 use CRLF or just CR.
31306
31307 Exim was designed for Unix-like systems, and internally, it stores messages
31308 using the system's convention of a single LF as a line terminator. When
31309 receiving a message, all line endings are translated to this standard format.
31310 Originally, it was thought that programs that passed messages directly to an
31311 MTA within an operating system would use that system's convention. Experience
31312 has shown that this is not the case; for example, there are Unix applications
31313 that use CRLF in this circumstance. For this reason, and for compatibility with
31314 other MTAs, the way Exim handles line endings for all messages is now as
31315 follows:
31316
31317 .ilist
31318 LF not preceded by CR is treated as a line ending.
31319 .next
31320 CR is treated as a line ending; if it is immediately followed by LF, the LF
31321 is ignored.
31322 .next
31323 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31324 nor a local message in the state where a line containing only a dot is a
31325 terminator.
31326 .next
31327 If a bare CR is encountered within a header line, an extra space is added after
31328 the line terminator so as not to end the header line. The reasoning behind this
31329 is that bare CRs in header lines are most likely either to be mistakes, or
31330 people trying to play silly games.
31331 .next
31332 If the first header line received in a message ends with CRLF, a subsequent
31333 bare LF in a header line is treated in the same way as a bare CR in a header
31334 line.
31335 .endlist
31336
31337
31338
31339
31340
31341 .section "Unqualified addresses" "SECID218"
31342 .cindex "unqualified addresses"
31343 .cindex "address" "qualification"
31344 By default, Exim expects every envelope address it receives from an external
31345 host to be fully qualified. Unqualified addresses cause negative responses to
31346 SMTP commands. However, because SMTP is used as a means of transporting
31347 messages from MUAs running on personal workstations, there is sometimes a
31348 requirement to accept unqualified addresses from specific hosts or IP networks.
31349
31350 Exim has two options that separately control which hosts may send unqualified
31351 sender or recipient addresses in SMTP commands, namely
31352 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31353 cases, if an unqualified address is accepted, it is qualified by adding the
31354 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31355
31356 .oindex "&%qualify_domain%&"
31357 .oindex "&%qualify_recipient%&"
31358 Unqualified addresses in header lines are automatically qualified for messages
31359 that are locally originated, unless the &%-bnq%& option is given on the command
31360 line. For messages received over SMTP, unqualified addresses in header lines
31361 are qualified only if unqualified addresses are permitted in SMTP commands. In
31362 other words, such qualification is also controlled by
31363 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31364
31365
31366
31367
31368 .section "The UUCP From line" "SECID219"
31369 .cindex "&""From""& line"
31370 .cindex "UUCP" "&""From""& line"
31371 .cindex "sender" "address"
31372 .oindex "&%uucp_from_pattern%&"
31373 .oindex "&%uucp_from_sender%&"
31374 .cindex "envelope sender"
31375 .cindex "Sendmail compatibility" "&""From""& line"
31376 Messages that have come from UUCP (and some other applications) often begin
31377 with a line containing the envelope sender and a timestamp, following the word
31378 &"From"&. Examples of two common formats are:
31379 .code
31380 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31381 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31382 .endd
31383 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31384 Exim recognizes such lines at the start of messages that are submitted to it
31385 via the command line (that is, on the standard input). It does not recognize
31386 such lines in incoming SMTP messages, unless the sending host matches
31387 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31388 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31389 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31390 default value matches the two common cases shown above and puts the address
31391 that follows &"From"& into &$1$&.
31392
31393 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31394 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31395 a trusted user, the message's sender address is constructed by expanding the
31396 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31397 then parsed as an RFC 2822 address. If there is no domain, the local part is
31398 qualified with &%qualify_domain%& unless it is the empty string. However, if
31399 the command line &%-f%& option is used, it overrides the &"From"& line.
31400
31401 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31402 sender address is not changed. This is also the case for incoming SMTP messages
31403 that are permitted to contain &"From"& lines.
31404
31405 Only one &"From"& line is recognized. If there is more than one, the second is
31406 treated as a data line that starts the body of the message, as it is not valid
31407 as a header line. This also happens if a &"From"& line is present in an
31408 incoming SMTP message from a source that is not permitted to send them.
31409
31410
31411
31412 .section "Resent- header lines" "SECID220"
31413 .cindex "&%Resent-%& header lines"
31414 RFC 2822 makes provision for sets of header lines starting with the string
31415 &`Resent-`& to be added to a message when it is resent by the original
31416 recipient to somebody else. These headers are &'Resent-Date:'&,
31417 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31418 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31419
31420 .blockquote
31421 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31422 processing of replies or other such automatic actions on messages.'&
31423 .endblockquote
31424
31425 This leaves things a bit vague as far as other processing actions such as
31426 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31427 follows:
31428
31429 .ilist
31430 A &'Resent-From:'& line that just contains the login id of the submitting user
31431 is automatically rewritten in the same way as &'From:'& (see below).
31432 .next
31433 If there's a rewriting rule for a particular header line, it is also applied to
31434 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31435 &'From:'& also rewrites &'Resent-From:'&.
31436 .next
31437 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31438 also removed.
31439 .next
31440 For a locally-submitted message,
31441 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31442 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31443 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31444 included in log lines in this case.
31445 .next
31446 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31447 &%Resent-%& header lines are present.
31448 .endlist
31449
31450
31451
31452
31453 .section "The Auto-Submitted: header line" "SECID221"
31454 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31455 includes the header line:
31456 .code
31457 Auto-Submitted: auto-replied
31458 .endd
31459
31460 .section "The Bcc: header line" "SECID222"
31461 .cindex "&'Bcc:'& header line"
31462 If Exim is called with the &%-t%& option, to take recipient addresses from a
31463 message's header, it removes any &'Bcc:'& header line that may exist (after
31464 extracting its addresses). If &%-t%& is not present on the command line, any
31465 existing &'Bcc:'& is not removed.
31466
31467
31468 .section "The Date: header line" "SECID223"
31469 .cindex "&'Date:'& header line"
31470 If a locally-generated or submission-mode message has no &'Date:'& header line,
31471 Exim adds one, using the current date and time, unless the
31472 &%suppress_local_fixups%& control has been specified.
31473
31474 .section "The Delivery-date: header line" "SECID224"
31475 .cindex "&'Delivery-date:'& header line"
31476 .oindex "&%delivery_date_remove%&"
31477 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31478 set. Exim can be configured to add them to the final delivery of messages. (See
31479 the generic &%delivery_date_add%& transport option.) They should not be present
31480 in messages in transit. If the &%delivery_date_remove%& configuration option is
31481 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31482 messages.
31483
31484
31485 .section "The Envelope-to: header line" "SECID225"
31486 .cindex "&'Envelope-to:'& header line"
31487 .oindex "&%envelope_to_remove%&"
31488 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31489 Exim can be configured to add them to the final delivery of messages. (See the
31490 generic &%envelope_to_add%& transport option.) They should not be present in
31491 messages in transit. If the &%envelope_to_remove%& configuration option is set
31492 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31493 messages.
31494
31495
31496 .section "The From: header line" "SECTthefrohea"
31497 .cindex "&'From:'& header line"
31498 .cindex "Sendmail compatibility" "&""From""& line"
31499 .cindex "message" "submission"
31500 .cindex "submission mode"
31501 If a submission-mode message does not contain a &'From:'& header line, Exim
31502 adds one if either of the following conditions is true:
31503
31504 .ilist
31505 The envelope sender address is not empty (that is, this is not a bounce
31506 message). The added header line copies the envelope sender address.
31507 .next
31508 .vindex "&$authenticated_id$&"
31509 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31510 .olist
31511 .vindex "&$qualify_domain$&"
31512 If no domain is specified by the submission control, the local part is
31513 &$authenticated_id$& and the domain is &$qualify_domain$&.
31514 .next
31515 If a non-empty domain is specified by the submission control, the local
31516 part is &$authenticated_id$&, and the domain is the specified domain.
31517 .next
31518 If an empty domain is specified by the submission control,
31519 &$authenticated_id$& is assumed to be the complete address.
31520 .endlist
31521 .endlist
31522
31523 A non-empty envelope sender takes precedence.
31524
31525 If a locally-generated incoming message does not contain a &'From:'& header
31526 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31527 containing the sender's address. The calling user's login name and full name
31528 are used to construct the address, as described in section &<<SECTconstr>>&.
31529 They are obtained from the password data by calling &[getpwuid()]& (but see the
31530 &%unknown_login%& configuration option). The address is qualified with
31531 &%qualify_domain%&.
31532
31533 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31534 &'From:'& header line containing just the unqualified login name of the calling
31535 user, this is replaced by an address containing the user's login name and full
31536 name as described in section &<<SECTconstr>>&.
31537
31538
31539 .section "The Message-ID: header line" "SECID226"
31540 .cindex "&'Message-ID:'& header line"
31541 .cindex "message" "submission"
31542 .oindex "&%message_id_header_text%&"
31543 If a locally-generated or submission-mode incoming message does not contain a
31544 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31545 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31546 to the message. If there are any &'Resent-:'& headers in the message, it
31547 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31548 message id, preceded by the letter E to ensure it starts with a letter, and
31549 followed by @ and the primary host name. Additional information can be included
31550 in this header line by setting the &%message_id_header_text%& and/or
31551 &%message_id_header_domain%& options.
31552
31553
31554 .section "The Received: header line" "SECID227"
31555 .cindex "&'Received:'& header line"
31556 A &'Received:'& header line is added at the start of every message. The
31557 contents are defined by the &%received_header_text%& configuration option, and
31558 Exim automatically adds a semicolon and a timestamp to the configured string.
31559
31560 The &'Received:'& header is generated as soon as the message's header lines
31561 have been received. At this stage, the timestamp in the &'Received:'& header
31562 line is the time that the message started to be received. This is the value
31563 that is seen by the DATA ACL and by the &[local_scan()]& function.
31564
31565 Once a message is accepted, the timestamp in the &'Received:'& header line is
31566 changed to the time of acceptance, which is (apart from a small delay while the
31567 -H spool file is written) the earliest time at which delivery could start.
31568
31569
31570 .section "The References: header line" "SECID228"
31571 .cindex "&'References:'& header line"
31572 Messages created by the &(autoreply)& transport include a &'References:'&
31573 header line. This is constructed according to the rules that are described in
31574 section 3.64 of RFC 2822 (which states that replies should contain such a
31575 header line), and section 3.14 of RFC 3834 (which states that automatic
31576 responses are not different in this respect). However, because some mail
31577 processing software does not cope well with very long header lines, no more
31578 than 12 message IDs are copied from the &'References:'& header line in the
31579 incoming message. If there are more than 12, the first one and then the final
31580 11 are copied, before adding the message ID of the incoming message.
31581
31582
31583
31584 .section "The Return-path: header line" "SECID229"
31585 .cindex "&'Return-path:'& header line"
31586 .oindex "&%return_path_remove%&"
31587 &'Return-path:'& header lines are defined as something an MTA may insert when
31588 it does the final delivery of messages. (See the generic &%return_path_add%&
31589 transport option.) Therefore, they should not be present in messages in
31590 transit. If the &%return_path_remove%& configuration option is set (the
31591 default), Exim removes &'Return-path:'& header lines from incoming messages.
31592
31593
31594
31595 .section "The Sender: header line" "SECTthesenhea"
31596 .cindex "&'Sender:'& header line"
31597 .cindex "message" "submission"
31598 For a locally-originated message from an untrusted user, Exim may remove an
31599 existing &'Sender:'& header line, and it may add a new one. You can modify
31600 these actions by setting the &%local_sender_retain%& option true, the
31601 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31602 control setting.
31603
31604 When a local message is received from an untrusted user and
31605 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31606 control has not been set, a check is made to see if the address given in the
31607 &'From:'& header line is the correct (local) sender of the message. The address
31608 that is expected has the login name as the local part and the value of
31609 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31610 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31611 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31612 line is added to the message.
31613
31614 If you set &%local_from_check%& false, this checking does not occur. However,
31615 the removal of an existing &'Sender:'& line still happens, unless you also set
31616 &%local_sender_retain%& to be true. It is not possible to set both of these
31617 options true at the same time.
31618
31619 .cindex "submission mode"
31620 By default, no processing of &'Sender:'& header lines is done for messages
31621 received over TCP/IP or for messages submitted by trusted users. However, when
31622 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31623 not specified on the submission control, the following processing takes place:
31624
31625 .vindex "&$authenticated_id$&"
31626 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31627 authenticated, and &$authenticated_id$& is not empty, a sender address is
31628 created as follows:
31629
31630 .ilist
31631 .vindex "&$qualify_domain$&"
31632 If no domain is specified by the submission control, the local part is
31633 &$authenticated_id$& and the domain is &$qualify_domain$&.
31634 .next
31635 If a non-empty domain is specified by the submission control, the local part
31636 is &$authenticated_id$&, and the domain is the specified domain.
31637 .next
31638 If an empty domain is specified by the submission control,
31639 &$authenticated_id$& is assumed to be the complete address.
31640 .endlist
31641
31642 This address is compared with the address in the &'From:'& header line. If they
31643 are different, a &'Sender:'& header line containing the created address is
31644 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31645 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31646
31647 .cindex "return path" "created from &'Sender:'&"
31648 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31649 the message (the envelope sender address) is changed to be the same address,
31650 except in the case of submission mode when &%sender_retain%& is specified.
31651
31652
31653
31654 .section "Adding and removing header lines in routers and transports" &&&
31655          "SECTheadersaddrem"
31656 .cindex "header lines" "adding; in router or transport"
31657 .cindex "header lines" "removing; in router or transport"
31658 When a message is delivered, the addition and removal of header lines can be
31659 specified in a system filter, or on any of the routers and transports that
31660 process the message. Section &<<SECTaddremheasys>>& contains details about
31661 modifying headers in a system filter. Header lines can also be added in an ACL
31662 as a message is received (see section &<<SECTaddheadacl>>&).
31663
31664 In contrast to what happens in a system filter, header modifications that are
31665 specified on routers and transports apply only to the particular recipient
31666 addresses that are being processed by those routers and transports. These
31667 changes do not actually take place until a copy of the message is being
31668 transported. Therefore, they do not affect the basic set of header lines, and
31669 they do not affect the values of the variables that refer to header lines.
31670
31671 &*Note*&: In particular, this means that any expansions in the configuration of
31672 the transport cannot refer to the modified header lines, because such
31673 expansions all occur before the message is actually transported.
31674
31675 For both routers and transports, the result of expanding a &%headers_add%&
31676 option must be in the form of one or more RFC 2822 header lines, separated by
31677 newlines (coded as &"\n"&). For example:
31678 .code
31679 headers_add = X-added-header: added by $primary_hostname\n\
31680               X-added-second: another added header line
31681 .endd
31682 Exim does not check the syntax of these added header lines.
31683
31684 Multiple &%headers_add%& options for a single router or transport can be
31685 specified; the values will be concatenated (with a separating newline
31686 added) before expansion.
31687
31688 The result of expanding &%headers_remove%& must consist of a colon-separated
31689 list of header names. This is confusing, because header names themselves are
31690 often terminated by colons. In this case, the colons are the list separators,
31691 not part of the names. For example:
31692 .code
31693 headers_remove = return-receipt-to:acknowledge-to
31694 .endd
31695
31696 Multiple &%headers_remove%& options for a single router or transport can be
31697 specified; the values will be concatenated (with a separating colon
31698 added) before expansion.
31699
31700 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31701 is expanded at routing time, and then associated with all addresses that are
31702 accepted by that router, and also with any new addresses that it generates. If
31703 an address passes through several routers as a result of aliasing or
31704 forwarding, the changes are cumulative.
31705
31706 .oindex "&%unseen%&"
31707 However, this does not apply to multiple routers that result from the use of
31708 the &%unseen%& option. Any header modifications that were specified by the
31709 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31710
31711 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31712 settings cannot be delivered together in a batch, so a transport is always
31713 dealing with a set of addresses that have the same header-processing
31714 requirements.
31715
31716 The transport starts by writing the original set of header lines that arrived
31717 with the message, possibly modified by the system filter. As it writes out
31718 these lines, it consults the list of header names that were attached to the
31719 recipient address(es) by &%headers_remove%& options in routers, and it also
31720 consults the transport's own &%headers_remove%& option. Header lines whose
31721 names are on either of these lists are not written out. If there are multiple
31722 instances of any listed header, they are all skipped.
31723
31724 After the remaining original header lines have been written, new header
31725 lines that were specified by routers' &%headers_add%& options are written, in
31726 the order in which they were attached to the address. These are followed by any
31727 header lines specified by the transport's &%headers_add%& option.
31728
31729 This way of handling header line modifications in routers and transports has
31730 the following consequences:
31731
31732 .ilist
31733 The original set of header lines, possibly modified by the system filter,
31734 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31735 to it, at all times.
31736 .next
31737 Header lines that are added by a router's
31738 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31739 expansion syntax in subsequent routers or the transport.
31740 .next
31741 Conversely, header lines that are specified for removal by &%headers_remove%&
31742 in a router remain visible to subsequent routers and the transport.
31743 .next
31744 Headers added to an address by &%headers_add%& in a router cannot be removed by
31745 a later router or by a transport.
31746 .next
31747 An added header can refer to the contents of an original header that is to be
31748 removed, even it has the same name as the added header. For example:
31749 .code
31750 headers_remove = subject
31751 headers_add = Subject: new subject (was: $h_subject:)
31752 .endd
31753 .endlist
31754
31755 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31756 for a &(redirect)& router that has the &%one_time%& option set.
31757
31758
31759
31760
31761
31762 .section "Constructed addresses" "SECTconstr"
31763 .cindex "address" "constructed"
31764 .cindex "constructed address"
31765 When Exim constructs a sender address for a locally-generated message, it uses
31766 the form
31767 .display
31768 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31769 .endd
31770 For example:
31771 .code
31772 Zaphod Beeblebrox <zaphod@end.univ.example>
31773 .endd
31774 The user name is obtained from the &%-F%& command line option if set, or
31775 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31776 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31777 ampersand character, this is replaced by the login name with the first letter
31778 upper cased, as is conventional in a number of operating systems. See the
31779 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31780 The &%unknown_username%& option can be used to specify user names in cases when
31781 there is no password file entry.
31782
31783 .cindex "RFC 2047"
31784 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31785 parts of it if necessary. In addition, if it contains any non-printing
31786 characters, it is encoded as described in RFC 2047, which defines a way of
31787 including non-ASCII characters in header lines. The value of the
31788 &%headers_charset%& option specifies the name of the encoding that is used (the
31789 characters are assumed to be in this encoding). The setting of
31790 &%print_topbitchars%& controls whether characters with the top bit set (that
31791 is, with codes greater than 127) count as printing characters or not.
31792
31793
31794
31795 .section "Case of local parts" "SECID230"
31796 .cindex "case of local parts"
31797 .cindex "local part" "case of"
31798 RFC 2822 states that the case of letters in the local parts of addresses cannot
31799 be assumed to be non-significant. Exim preserves the case of local parts of
31800 addresses, but by default it uses a lower-cased form when it is routing,
31801 because on most Unix systems, usernames are in lower case and case-insensitive
31802 routing is required. However, any particular router can be made to use the
31803 original case for local parts by setting the &%caseful_local_part%& generic
31804 router option.
31805
31806 .cindex "mixed-case login names"
31807 If you must have mixed-case user names on your system, the best way to proceed,
31808 assuming you want case-independent handling of incoming email, is to set up
31809 your first router to convert incoming local parts in your domains to the
31810 correct case by means of a file lookup. For example:
31811 .code
31812 correct_case:
31813   driver = redirect
31814   domains = +local_domains
31815   data = ${lookup{$local_part}cdb\
31816               {/etc/usercased.cdb}{$value}fail}\
31817               @$domain
31818 .endd
31819 For this router, the local part is forced to lower case by the default action
31820 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31821 up a new local part in the correct case. If you then set &%caseful_local_part%&
31822 on any subsequent routers which process your domains, they will operate on
31823 local parts with the correct case in a case-sensitive manner.
31824
31825
31826
31827 .section "Dots in local parts" "SECID231"
31828 .cindex "dot" "in local part"
31829 .cindex "local part" "dots in"
31830 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31831 part may not begin or end with a dot, nor have two consecutive dots in the
31832 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31833 empty components for compatibility.
31834
31835
31836
31837 .section "Rewriting addresses" "SECID232"
31838 .cindex "rewriting" "addresses"
31839 Rewriting of sender and recipient addresses, and addresses in headers, can
31840 happen automatically, or as the result of configuration options, as described
31841 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31842 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31843
31844 Automatic rewriting includes qualification, as mentioned above. The other case
31845 in which it can happen is when an incomplete non-local domain is given. The
31846 routing process may cause this to be expanded into the full domain name. For
31847 example, a header such as
31848 .code
31849 To: hare@teaparty
31850 .endd
31851 might get rewritten as
31852 .code
31853 To: hare@teaparty.wonderland.fict.example
31854 .endd
31855 Rewriting as a result of routing is the one kind of message processing that
31856 does not happen at input time, as it cannot be done until the address has
31857 been routed.
31858
31859 Strictly, one should not do &'any'& deliveries of a message until all its
31860 addresses have been routed, in case any of the headers get changed as a
31861 result of routing. However, doing this in practice would hold up many
31862 deliveries for unreasonable amounts of time, just because one address could not
31863 immediately be routed. Exim therefore does not delay other deliveries when
31864 routing of one or more addresses is deferred.
31865 .ecindex IIDmesproc
31866
31867
31868
31869 . ////////////////////////////////////////////////////////////////////////////
31870 . ////////////////////////////////////////////////////////////////////////////
31871
31872 .chapter "SMTP processing" "CHAPSMTP"
31873 .scindex IIDsmtpproc1 "SMTP" "processing details"
31874 .scindex IIDsmtpproc2 "LMTP" "processing details"
31875 Exim supports a number of different ways of using the SMTP protocol, and its
31876 LMTP variant, which is an interactive protocol for transferring messages into a
31877 closed mail store application. This chapter contains details of how SMTP is
31878 processed. For incoming mail, the following are available:
31879
31880 .ilist
31881 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31882 .next
31883 SMTP over the standard input and output (the &%-bs%& option);
31884 .next
31885 Batched SMTP on the standard input (the &%-bS%& option).
31886 .endlist
31887
31888 For mail delivery, the following are available:
31889
31890 .ilist
31891 SMTP over TCP/IP (the &(smtp)& transport);
31892 .next
31893 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31894 &"lmtp"&);
31895 .next
31896 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31897 transport);
31898 .next
31899 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31900 the &%use_bsmtp%& option set).
31901 .endlist
31902
31903 &'Batched SMTP'& is the name for a process in which batches of messages are
31904 stored in or read from files (or pipes), in a format in which SMTP commands are
31905 used to contain the envelope information.
31906
31907
31908
31909 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31910 .cindex "SMTP" "outgoing over TCP/IP"
31911 .cindex "outgoing SMTP over TCP/IP"
31912 .cindex "LMTP" "over TCP/IP"
31913 .cindex "outgoing LMTP over TCP/IP"
31914 .cindex "EHLO"
31915 .cindex "HELO"
31916 .cindex "SIZE option on MAIL command"
31917 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31918 The &%protocol%& option selects which protocol is to be used, but the actual
31919 processing is the same in both cases.
31920
31921 If, in response to its EHLO command, Exim is told that the SIZE
31922 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31923 command. The value of <&'n'&> is the message size plus the value of the
31924 &%size_addition%& option (default 1024) to allow for additions to the message
31925 such as per-transport header lines, or changes made in a
31926 .cindex "transport" "filter"
31927 .cindex "filter" "transport filter"
31928 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31929 suppressed.
31930
31931 If the remote server advertises support for PIPELINING, Exim uses the
31932 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31933 required for the transaction.
31934
31935 If the remote server advertises support for the STARTTLS command, and Exim
31936 was built to support TLS encryption, it tries to start a TLS session unless the
31937 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31938 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
31939 is called for verification.
31940
31941 If the remote server advertises support for the AUTH command, Exim scans
31942 the authenticators configuration for any suitable client settings, as described
31943 in chapter &<<CHAPSMTPAUTH>>&.
31944
31945 .cindex "carriage return"
31946 .cindex "linefeed"
31947 Responses from the remote host are supposed to be terminated by CR followed by
31948 LF. However, there are known to be hosts that do not send CR characters, so in
31949 order to be able to interwork with such hosts, Exim treats LF on its own as a
31950 line terminator.
31951
31952 If a message contains a number of different addresses, all those with the same
31953 characteristics (for example, the same envelope sender) that resolve to the
31954 same set of hosts, in the same order, are sent in a single SMTP transaction,
31955 even if they are for different domains, unless there are more than the setting
31956 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31957 they are split into groups containing no more than &%max_rcpt%&s addresses
31958 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31959 in parallel sessions. The order of hosts with identical MX values is not
31960 significant when checking whether addresses can be batched in this way.
31961
31962 When the &(smtp)& transport suffers a temporary failure that is not
31963 message-related, Exim updates its transport-specific database, which contains
31964 records indexed by host name that remember which messages are waiting for each
31965 particular host. It also updates the retry database with new retry times.
31966
31967 .cindex "hints database" "retry keys"
31968 Exim's retry hints are based on host name plus IP address, so if one address of
31969 a multi-homed host is broken, it will soon be skipped most of the time.
31970 See the next section for more detail about error handling.
31971
31972 .cindex "SMTP" "passed connection"
31973 .cindex "SMTP" "batching over TCP/IP"
31974 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31975 looks in the hints database for the transport to see if there are any queued
31976 messages waiting for the host to which it is connected. If it finds one, it
31977 creates a new Exim process using the &%-MC%& option (which can only be used by
31978 a process running as root or the Exim user) and passes the TCP/IP socket to it
31979 so that it can deliver another message using the same socket. The new process
31980 does only those deliveries that are routed to the connected host, and may in
31981 turn pass the socket on to a third process, and so on.
31982
31983 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31984 limit the number of messages sent down a single TCP/IP connection.
31985
31986 .cindex "asterisk" "after IP address"
31987 The second and subsequent messages delivered down an existing connection are
31988 identified in the main log by the addition of an asterisk after the closing
31989 square bracket of the IP address.
31990
31991
31992
31993
31994 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31995 .cindex "error" "in outgoing SMTP"
31996 .cindex "SMTP" "errors in outgoing"
31997 .cindex "host" "error"
31998 Three different kinds of error are recognized for outgoing SMTP: host errors,
31999 message errors, and recipient errors.
32000
32001 .vlist
32002 .vitem "&*Host errors*&"
32003 A host error is not associated with a particular message or with a
32004 particular recipient of a message. The host errors are:
32005
32006 .ilist
32007 Connection refused or timed out,
32008 .next
32009 Any error response code on connection,
32010 .next
32011 Any error response code to EHLO or HELO,
32012 .next
32013 Loss of connection at any time, except after &"."&,
32014 .next
32015 I/O errors at any time,
32016 .next
32017 Timeouts during the session, other than in response to MAIL, RCPT or
32018 the &"."& at the end of the data.
32019 .endlist ilist
32020
32021 For a host error, a permanent error response on connection, or in response to
32022 EHLO, causes all addresses routed to the host to be failed. Any other host
32023 error causes all addresses to be deferred, and retry data to be created for the
32024 host. It is not tried again, for any message, until its retry time arrives. If
32025 the current set of addresses are not all delivered in this run (to some
32026 alternative host), the message is added to the list of those waiting for this
32027 host, so if it is still undelivered when a subsequent successful delivery is
32028 made to the host, it will be sent down the same SMTP connection.
32029
32030 .vitem "&*Message errors*&"
32031 .cindex "message" "error"
32032 A message error is associated with a particular message when sent to a
32033 particular host, but not with a particular recipient of the message. The
32034 message errors are:
32035
32036 .ilist
32037 Any error response code to MAIL, DATA, or the &"."& that terminates
32038 the data,
32039 .next
32040 Timeout after MAIL,
32041 .next
32042 Timeout or loss of connection after the &"."& that terminates the data. A
32043 timeout after the DATA command itself is treated as a host error, as is loss of
32044 connection at any other time.
32045 .endlist ilist
32046
32047 For a message error, a permanent error response (5&'xx'&) causes all addresses
32048 to be failed, and a delivery error report to be returned to the sender. A
32049 temporary error response (4&'xx'&), or one of the timeouts, causes all
32050 addresses to be deferred. Retry data is not created for the host, but instead,
32051 a retry record for the combination of host plus message id is created. The
32052 message is not added to the list of those waiting for this host. This ensures
32053 that the failing message will not be sent to this host again until the retry
32054 time arrives. However, other messages that are routed to the host are not
32055 affected, so if it is some property of the message that is causing the error,
32056 it will not stop the delivery of other mail.
32057
32058 If the remote host specified support for the SIZE parameter in its response
32059 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32060 over-large message will cause a message error because the error arrives as a
32061 response to MAIL.
32062
32063 .vitem "&*Recipient errors*&"
32064 .cindex "recipient" "error"
32065 A recipient error is associated with a particular recipient of a message. The
32066 recipient errors are:
32067
32068 .ilist
32069 Any error response to RCPT,
32070 .next
32071 Timeout after RCPT.
32072 .endlist
32073
32074 For a recipient error, a permanent error response (5&'xx'&) causes the
32075 recipient address to be failed, and a bounce message to be returned to the
32076 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32077 address to be deferred, and routing retry data to be created for it. This is
32078 used to delay processing of the address in subsequent queue runs, until its
32079 routing retry time arrives. This applies to all messages, but because it
32080 operates only in queue runs, one attempt will be made to deliver a new message
32081 to the failing address before the delay starts to operate. This ensures that,
32082 if the failure is really related to the message rather than the recipient
32083 (&"message too big for this recipient"& is a possible example), other messages
32084 have a chance of getting delivered. If a delivery to the address does succeed,
32085 the retry information gets cleared, so all stuck messages get tried again, and
32086 the retry clock is reset.
32087
32088 The message is not added to the list of those waiting for this host. Use of the
32089 host for other messages is unaffected, and except in the case of a timeout,
32090 other recipients are processed independently, and may be successfully delivered
32091 in the current SMTP session. After a timeout it is of course impossible to
32092 proceed with the session, so all addresses get deferred. However, those other
32093 than the one that failed do not suffer any subsequent retry delays. Therefore,
32094 if one recipient is causing trouble, the others have a chance of getting
32095 through when a subsequent delivery attempt occurs before the failing
32096 recipient's retry time.
32097 .endlist
32098
32099 In all cases, if there are other hosts (or IP addresses) available for the
32100 current set of addresses (for example, from multiple MX records), they are
32101 tried in this run for any undelivered addresses, subject of course to their
32102 own retry data. In other words, recipient error retry data does not take effect
32103 until the next delivery attempt.
32104
32105 Some hosts have been observed to give temporary error responses to every
32106 MAIL command at certain times (&"insufficient space"& has been seen). It
32107 would be nice if such circumstances could be recognized, and defer data for the
32108 host itself created, but this is not possible within the current Exim design.
32109 What actually happens is that retry data for every (host, message) combination
32110 is created.
32111
32112 The reason that timeouts after MAIL and RCPT are treated specially is that
32113 these can sometimes arise as a result of the remote host's verification
32114 procedures. Exim makes this assumption, and treats them as if a temporary error
32115 response had been received. A timeout after &"."& is treated specially because
32116 it is known that some broken implementations fail to recognize the end of the
32117 message if the last character of the last line is a binary zero. Thus, it is
32118 helpful to treat this case as a message error.
32119
32120 Timeouts at other times are treated as host errors, assuming a problem with the
32121 host, or the connection to it. If a timeout after MAIL, RCPT,
32122 or &"."& is really a connection problem, the assumption is that at the next try
32123 the timeout is likely to occur at some other point in the dialogue, causing it
32124 then to be treated as a host error.
32125
32126 There is experimental evidence that some MTAs drop the connection after the
32127 terminating &"."& if they do not like the contents of the message for some
32128 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32129 should be given. That is why Exim treats this case as a message rather than a
32130 host error, in order not to delay other messages to the same host.
32131
32132
32133
32134
32135 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32136 .cindex "SMTP" "incoming over TCP/IP"
32137 .cindex "incoming SMTP over TCP/IP"
32138 .cindex "inetd"
32139 .cindex "daemon"
32140 Incoming SMTP messages can be accepted in one of two ways: by running a
32141 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32142 &_/etc/inetd.conf_& should be like this:
32143 .code
32144 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32145 .endd
32146 Exim distinguishes between this case and the case of a locally running user
32147 agent using the &%-bs%& option by checking whether or not the standard input is
32148 a socket. When it is, either the port must be privileged (less than 1024), or
32149 the caller must be root or the Exim user. If any other user passes a socket
32150 with an unprivileged port number, Exim prints a message on the standard error
32151 stream and exits with an error code.
32152
32153 By default, Exim does not make a log entry when a remote host connects or
32154 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32155 unexpected. It can be made to write such log entries by setting the
32156 &%smtp_connection%& log selector.
32157
32158 .cindex "carriage return"
32159 .cindex "linefeed"
32160 Commands from the remote host are supposed to be terminated by CR followed by
32161 LF. However, there are known to be hosts that do not send CR characters. In
32162 order to be able to interwork with such hosts, Exim treats LF on its own as a
32163 line terminator.
32164 Furthermore, because common code is used for receiving messages from all
32165 sources, a CR on its own is also interpreted as a line terminator. However, the
32166 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32167
32168 .cindex "EHLO" "invalid data"
32169 .cindex "HELO" "invalid data"
32170 One area that sometimes gives rise to problems concerns the EHLO or
32171 HELO commands. Some clients send syntactically invalid versions of these
32172 commands, which Exim rejects by default. (This is nothing to do with verifying
32173 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32174 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32175 match the broken hosts that send invalid commands.
32176
32177 .cindex "SIZE option on MAIL command"
32178 .cindex "MAIL" "SIZE option"
32179 The amount of disk space available is checked whenever SIZE is received on
32180 a MAIL command, independently of whether &%message_size_limit%& or
32181 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32182 false. A temporary error is given if there is not enough space. If
32183 &%check_spool_space%& is set, the check is for that amount of space plus the
32184 value given with SIZE, that is, it checks that the addition of the incoming
32185 message will not reduce the space below the threshold.
32186
32187 When a message is successfully received, Exim includes the local message id in
32188 its response to the final &"."& that terminates the data. If the remote host
32189 logs this text it can help with tracing what has happened to a message.
32190
32191 The Exim daemon can limit the number of simultaneous incoming connections it is
32192 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32193 number of simultaneous incoming connections from a single remote host (see the
32194 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32195 rejected using the SMTP temporary error code 421.
32196
32197 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32198 subprocess has finished, as this can get lost at busy times. Instead, it looks
32199 for completed subprocesses every time it wakes up. Provided there are other
32200 things happening (new incoming calls, starts of queue runs), completed
32201 processes will be noticed and tidied away. On very quiet systems you may
32202 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32203 it will be noticed when the daemon next wakes up.
32204
32205 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32206 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32207 high system load &-- for details see the &%smtp_accept_reserve%&,
32208 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32209 applies in both the daemon and &'inetd'& cases.
32210
32211 Exim normally starts a delivery process for each message received, though this
32212 can be varied by means of the &%-odq%& command line option and the
32213 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32214 number of simultaneously running delivery processes started in this way from
32215 SMTP input can be limited by the &%smtp_accept_queue%& and
32216 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32217 subsequently received messages are just put on the input queue without starting
32218 a delivery process.
32219
32220 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32221 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32222 started up from the &'inetd'& daemon, because in that case each connection is
32223 handled by an entirely independent Exim process. Control by load average is,
32224 however, available with &'inetd'&.
32225
32226 Exim can be configured to verify addresses in incoming SMTP commands as they
32227 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32228 to rewrite addresses at this time &-- before any syntax checking is done. See
32229 section &<<SECTrewriteS>>&.
32230
32231 Exim can also be configured to limit the rate at which a client host submits
32232 MAIL and RCPT commands in a single SMTP session. See the
32233 &%smtp_ratelimit_hosts%& option.
32234
32235
32236
32237 .section "Unrecognized SMTP commands" "SECID234"
32238 .cindex "SMTP" "unrecognized commands"
32239 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32240 commands during a single SMTP connection, it drops the connection after sending
32241 the error response to the last command. The default value for
32242 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32243 abuse that subvert web servers into making connections to SMTP ports; in these
32244 circumstances, a number of non-SMTP lines are sent first.
32245
32246
32247 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32248 .cindex "SMTP" "syntax errors"
32249 .cindex "SMTP" "protocol errors"
32250 A syntax error is detected if an SMTP command is recognized, but there is
32251 something syntactically wrong with its data, for example, a malformed email
32252 address in a RCPT command. Protocol errors include invalid command
32253 sequencing such as RCPT before MAIL. If Exim receives more than
32254 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32255 drops the connection after sending the error response to the last command. The
32256 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32257 broken clients that loop sending bad commands (yes, it has been seen).
32258
32259
32260
32261 .section "Use of non-mail SMTP commands" "SECID236"
32262 .cindex "SMTP" "non-mail commands"
32263 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32264 DATA. Exim counts such commands, and drops the connection if there are too
32265 many of them in a single SMTP session. This action catches some
32266 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32267 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32268 defines what &"too many"& means. Its default value is 10.
32269
32270 When a new message is expected, one occurrence of RSET is not counted. This
32271 allows a client to send one RSET between messages (this is not necessary,
32272 but some clients do it). Exim also allows one uncounted occurrence of HELO
32273 or EHLO, and one occurrence of STARTTLS between messages. After
32274 starting up a TLS session, another EHLO is expected, and so it too is not
32275 counted.
32276
32277 The first occurrence of AUTH in a connection, or immediately following
32278 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32279 RCPT, DATA, and QUIT are counted.
32280
32281 You can control which hosts are subject to the limit set by
32282 &%smtp_accept_max_nonmail%& by setting
32283 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32284 the limit apply to all hosts. This option means that you can exclude any
32285 specific badly-behaved hosts that you have to live with.
32286
32287
32288
32289
32290 .section "The VRFY and EXPN commands" "SECID237"
32291 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32292 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32293 appropriate) in order to decide whether the command should be accepted or not.
32294 If no ACL is defined, the command is rejected.
32295
32296 .cindex "VRFY" "processing"
32297 When VRFY is accepted, it runs exactly the same code as when Exim is
32298 called with the &%-bv%& option.
32299
32300 .cindex "EXPN" "processing"
32301 When EXPN is accepted, a single-level expansion of the address is done.
32302 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32303 than a verification (the &%-bv%& option). If an unqualified local part is given
32304 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32305 of VRFY and EXPN commands are logged on the main and reject logs, and
32306 VRFY verification failures are logged on the main log for consistency with
32307 RCPT failures.
32308
32309
32310
32311 .section "The ETRN command" "SECTETRN"
32312 .cindex "ETRN" "processing"
32313 RFC 1985 describes an SMTP command called ETRN that is designed to
32314 overcome the security problems of the TURN command (which has fallen into
32315 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32316 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32317 should be accepted or not. If no ACL is defined, the command is rejected.
32318
32319 The ETRN command is concerned with &"releasing"& messages that are awaiting
32320 delivery to certain hosts. As Exim does not organize its message queue by host,
32321 the only form of ETRN that is supported by default is the one where the
32322 text starts with the &"#"& prefix, in which case the remainder of the text is
32323 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32324 the &%-R%& option to happen, with the remainder of the ETRN text as its
32325 argument. For example,
32326 .code
32327 ETRN #brigadoon
32328 .endd
32329 runs the command
32330 .code
32331 exim -R brigadoon
32332 .endd
32333 which causes a delivery attempt on all messages with undelivered addresses
32334 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32335 default), Exim prevents the simultaneous execution of more than one queue run
32336 for the same argument string as a result of an ETRN command. This stops
32337 a misbehaving client from starting more than one queue runner at once.
32338
32339 .cindex "hints database" "ETRN serialization"
32340 Exim implements the serialization by means of a hints database in which a
32341 record is written whenever a process is started by ETRN, and deleted when
32342 the process completes. However, Exim does not keep the SMTP session waiting for
32343 the ETRN process to complete. Once ETRN is accepted, the client is sent
32344 a &"success"& return code. Obviously there is scope for hints records to get
32345 left lying around if there is a system or program crash. To guard against this,
32346 Exim ignores any records that are more than six hours old.
32347
32348 .oindex "&%smtp_etrn_command%&"
32349 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32350 used. This specifies a command that is run whenever ETRN is received,
32351 whatever the form of its argument. For
32352 example:
32353 .code
32354 smtp_etrn_command = /etc/etrn_command $domain \
32355                     $sender_host_address
32356 .endd
32357 .vindex "&$domain$&"
32358 The string is split up into arguments which are independently expanded. The
32359 expansion variable &$domain$& is set to the argument of the ETRN command,
32360 and no syntax checking is done on the contents of this argument. Exim does not
32361 wait for the command to complete, so its status code is not checked. Exim runs
32362 under its own uid and gid when receiving incoming SMTP, so it is not possible
32363 for it to change them before running the command.
32364
32365
32366
32367 .section "Incoming local SMTP" "SECID238"
32368 .cindex "SMTP" "local incoming"
32369 Some user agents use SMTP to pass messages to their local MTA using the
32370 standard input and output, as opposed to passing the envelope on the command
32371 line and writing the message to the standard input. This is supported by the
32372 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32373 messages over TCP/IP (including the use of ACLs), except that the envelope
32374 sender given in a MAIL command is ignored unless the caller is trusted. In
32375 an ACL you can detect this form of SMTP input by testing for an empty host
32376 identification. It is common to have this as the first line in the ACL that
32377 runs for RCPT commands:
32378 .code
32379 accept hosts = :
32380 .endd
32381 This accepts SMTP messages from local processes without doing any other tests.
32382
32383
32384
32385 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32386 .cindex "SMTP" "batched outgoing"
32387 .cindex "batched SMTP output"
32388 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32389 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32390 be output in BSMTP format. No SMTP responses are possible for this form of
32391 delivery. All it is doing is using SMTP commands as a way of transmitting the
32392 envelope along with the message.
32393
32394 The message is written to the file or pipe preceded by the SMTP commands
32395 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32396 the message that start with a dot have an extra dot added. The SMTP command
32397 HELO is not normally used. If it is required, the &%message_prefix%& option
32398 can be used to specify it.
32399
32400 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32401 one recipient address at a time by default. However, you can arrange for them
32402 to handle several addresses at once by setting the &%batch_max%& option. When
32403 this is done for BSMTP, messages may contain multiple RCPT commands. See
32404 chapter &<<CHAPbatching>>& for more details.
32405
32406 .vindex "&$host$&"
32407 When one or more addresses are routed to a BSMTP transport by a router that
32408 sets up a host list, the name of the first host on the list is available to the
32409 transport in the variable &$host$&. Here is an example of such a transport and
32410 router:
32411 .code
32412 begin routers
32413 route_append:
32414   driver = manualroute
32415   transport = smtp_appendfile
32416   route_list = domain.example  batch.host.example
32417
32418 begin transports
32419 smtp_appendfile:
32420   driver = appendfile
32421   directory = /var/bsmtp/$host
32422   batch_max = 1000
32423   use_bsmtp
32424   user = exim
32425 .endd
32426 This causes messages addressed to &'domain.example'& to be written in BSMTP
32427 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32428 message (unless there are more than 1000 recipients).
32429
32430
32431
32432 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32433 .cindex "SMTP" "batched incoming"
32434 .cindex "batched SMTP input"
32435 The &%-bS%& command line option causes Exim to accept one or more messages by
32436 reading SMTP on the standard input, but to generate no responses. If the caller
32437 is trusted, the senders in the MAIL commands are believed; otherwise the
32438 sender is always the caller of Exim. Unqualified senders and receivers are not
32439 rejected (there seems little point) but instead just get qualified. HELO
32440 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32441 as NOOP; QUIT quits.
32442
32443 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32444 ACL is run in the same way as for non-SMTP local input.
32445
32446 If an error is detected while reading a message, including a missing &"."& at
32447 the end, Exim gives up immediately. It writes details of the error to the
32448 standard output in a stylized way that the calling program should be able to
32449 make some use of automatically, for example:
32450 .code
32451 554 Unexpected end of file
32452 Transaction started in line 10
32453 Error detected in line 14
32454 .endd
32455 It writes a more verbose version, for human consumption, to the standard error
32456 file, for example:
32457 .code
32458 An error was detected while processing a file of BSMTP input.
32459 The error message was:
32460
32461 501 '>' missing at end of address
32462
32463 The SMTP transaction started in line 10.
32464 The error was detected in line 12.
32465 The SMTP command at fault was:
32466
32467 rcpt to:<malformed@in.com.plete
32468
32469 1 previous message was successfully processed.
32470 The rest of the batch was abandoned.
32471 .endd
32472 The return code from Exim is zero only if there were no errors. It is 1 if some
32473 messages were accepted before an error was detected, and 2 if no messages were
32474 accepted.
32475 .ecindex IIDsmtpproc1
32476 .ecindex IIDsmtpproc2
32477
32478
32479
32480 . ////////////////////////////////////////////////////////////////////////////
32481 . ////////////////////////////////////////////////////////////////////////////
32482
32483 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32484          "Customizing messages"
32485 When a message fails to be delivered, or remains on the queue for more than a
32486 configured amount of time, Exim sends a message to the original sender, or
32487 to an alternative configured address. The text of these messages is built into
32488 the code of Exim, but it is possible to change it, either by adding a single
32489 string, or by replacing each of the paragraphs by text supplied in a file.
32490
32491 The &'From:'& and &'To:'& header lines are automatically generated; you can
32492 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32493 option. Exim also adds the line
32494 .code
32495 Auto-Submitted: auto-generated
32496 .endd
32497 to all warning and bounce messages,
32498
32499
32500 .section "Customizing bounce messages" "SECID239"
32501 .cindex "customizing" "bounce message"
32502 .cindex "bounce message" "customizing"
32503 If &%bounce_message_text%& is set, its contents are included in the default
32504 message immediately after &"This message was created automatically by mail
32505 delivery software."& The string is not expanded. It is not used if
32506 &%bounce_message_file%& is set.
32507
32508 When &%bounce_message_file%& is set, it must point to a template file for
32509 constructing error messages. The file consists of a series of text items,
32510 separated by lines consisting of exactly four asterisks. If the file cannot be
32511 opened, default text is used and a message is written to the main and panic
32512 logs. If any text item in the file is empty, default text is used for that
32513 item.
32514
32515 .vindex "&$bounce_recipient$&"
32516 .vindex "&$bounce_return_size_limit$&"
32517 Each item of text that is read from the file is expanded, and there are two
32518 expansion variables which can be of use here: &$bounce_recipient$& is set to
32519 the recipient of an error message while it is being created, and
32520 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32521 option, rounded to a whole number.
32522
32523 The items must appear in the file in the following order:
32524
32525 .ilist
32526 The first item is included in the headers, and should include at least a
32527 &'Subject:'& header. Exim does not check the syntax of these headers.
32528 .next
32529 The second item forms the start of the error message. After it, Exim lists the
32530 failing addresses with their error messages.
32531 .next
32532 The third item is used to introduce any text from pipe transports that is to be
32533 returned to the sender. It is omitted if there is no such text.
32534 .next
32535 The fourth item is used to introduce the copy of the message that is returned
32536 as part of the error report.
32537 .next
32538 The fifth item is added after the fourth one if the returned message is
32539 truncated because it is bigger than &%return_size_limit%&.
32540 .next
32541 The sixth item is added after the copy of the original message.
32542 .endlist
32543
32544 The default state (&%bounce_message_file%& unset) is equivalent to the
32545 following file, in which the sixth item is empty. The &'Subject:'& and some
32546 other lines have been split in order to fit them on the page:
32547 .code
32548 Subject: Mail delivery failed
32549   ${if eq{$sender_address}{$bounce_recipient}
32550   {: returning message to sender}}
32551 ****
32552 This message was created automatically by mail delivery software.
32553
32554 A message ${if eq{$sender_address}{$bounce_recipient}
32555   {that you sent }{sent by
32556
32557 <$sender_address>
32558
32559 }}could not be delivered to all of its recipients.
32560 This is a permanent error. The following address(es) failed:
32561 ****
32562 The following text was generated during the delivery attempt(s):
32563 ****
32564 ------ This is a copy of the message, including all the headers.
32565   ------
32566 ****
32567 ------ The body of the message is $message_size characters long;
32568   only the first
32569 ------ $bounce_return_size_limit or so are included here.
32570 ****
32571 .endd
32572 .section "Customizing warning messages" "SECTcustwarn"
32573 .cindex "customizing" "warning message"
32574 .cindex "warning of delay" "customizing the message"
32575 The option &%warn_message_file%& can be pointed at a template file for use when
32576 warnings about message delays are created. In this case there are only three
32577 text sections:
32578
32579 .ilist
32580 The first item is included in the headers, and should include at least a
32581 &'Subject:'& header. Exim does not check the syntax of these headers.
32582 .next
32583 The second item forms the start of the warning message. After it, Exim lists
32584 the delayed addresses.
32585 .next
32586 The third item then ends the message.
32587 .endlist
32588
32589 The default state is equivalent to the following file, except that some lines
32590 have been split here, in order to fit them on the page:
32591 .code
32592 Subject: Warning: message $message_exim_id delayed
32593   $warn_message_delay
32594 ****
32595 This message was created automatically by mail delivery software.
32596
32597 A message ${if eq{$sender_address}{$warn_message_recipients}
32598 {that you sent }{sent by
32599
32600 <$sender_address>
32601
32602 }}has not been delivered to all of its recipients after
32603 more than $warn_message_delay on the queue on $primary_hostname.
32604
32605 The message identifier is:     $message_exim_id
32606 The subject of the message is: $h_subject
32607 The date of the message is:    $h_date
32608
32609 The following address(es) have not yet been delivered:
32610 ****
32611 No action is required on your part. Delivery attempts will
32612 continue for some time, and this warning may be repeated at
32613 intervals if the message remains undelivered. Eventually the
32614 mail delivery software will give up, and when that happens,
32615 the message will be returned to you.
32616 .endd
32617 .vindex "&$warn_message_delay$&"
32618 .vindex "&$warn_message_recipients$&"
32619 However, in the default state the subject and date lines are omitted if no
32620 appropriate headers exist. During the expansion of this file,
32621 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32622 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32623 of recipients for the warning message. There may be more than one if there are
32624 multiple addresses with different &%errors_to%& settings on the routers that
32625 handled them.
32626
32627
32628
32629
32630 . ////////////////////////////////////////////////////////////////////////////
32631 . ////////////////////////////////////////////////////////////////////////////
32632
32633 .chapter "Some common configuration settings" "CHAPcomconreq"
32634 This chapter discusses some configuration settings that seem to be fairly
32635 common. More examples and discussion can be found in the Exim book.
32636
32637
32638
32639 .section "Sending mail to a smart host" "SECID240"
32640 .cindex "smart host" "example router"
32641 If you want to send all mail for non-local domains to a &"smart host"&, you
32642 should replace the default &(dnslookup)& router with a router which does the
32643 routing explicitly:
32644 .code
32645 send_to_smart_host:
32646   driver = manualroute
32647   route_list = !+local_domains smart.host.name
32648   transport = remote_smtp
32649 .endd
32650 You can use the smart host's IP address instead of the name if you wish.
32651 If you are using Exim only to submit messages to a smart host, and not for
32652 receiving incoming messages, you can arrange for it to do the submission
32653 synchronously by setting the &%mua_wrapper%& option (see chapter
32654 &<<CHAPnonqueueing>>&).
32655
32656
32657
32658
32659 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32660 .cindex "mailing lists"
32661 Exim can be used to run simple mailing lists, but for large and/or complicated
32662 requirements, the use of additional specialized mailing list software such as
32663 Majordomo or Mailman is recommended.
32664
32665 The &(redirect)& router can be used to handle mailing lists where each list
32666 is maintained in a separate file, which can therefore be managed by an
32667 independent manager. The &%domains%& router option can be used to run these
32668 lists in a separate domain from normal mail. For example:
32669 .code
32670 lists:
32671   driver = redirect
32672   domains = lists.example
32673   file = /usr/lists/$local_part
32674   forbid_pipe
32675   forbid_file
32676   errors_to = $local_part-request@lists.example
32677   no_more
32678 .endd
32679 This router is skipped for domains other than &'lists.example'&. For addresses
32680 in that domain, it looks for a file that matches the local part. If there is no
32681 such file, the router declines, but because &%no_more%& is set, no subsequent
32682 routers are tried, and so the whole delivery fails.
32683
32684 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32685 expanded into a file name or a pipe delivery, which is usually inappropriate in
32686 a mailing list.
32687
32688 .oindex "&%errors_to%&"
32689 The &%errors_to%& option specifies that any delivery errors caused by addresses
32690 taken from a mailing list are to be sent to the given address rather than the
32691 original sender of the message. However, before acting on this, Exim verifies
32692 the error address, and ignores it if verification fails.
32693
32694 For example, using the configuration above, mail sent to
32695 &'dicts@lists.example'& is passed on to those addresses contained in
32696 &_/usr/lists/dicts_&, with error reports directed to
32697 &'dicts-request@lists.example'&, provided that this address can be verified.
32698 There could be a file called &_/usr/lists/dicts-request_& containing
32699 the address(es) of this particular list's manager(s), but other approaches,
32700 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32701 or &%local_part_suffix%& options) to handle addresses of the form
32702 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32703
32704
32705
32706 .section "Syntax errors in mailing lists" "SECID241"
32707 .cindex "mailing lists" "syntax errors in"
32708 If an entry in redirection data contains a syntax error, Exim normally defers
32709 delivery of the original address. That means that a syntax error in a mailing
32710 list holds up all deliveries to the list. This may not be appropriate when a
32711 list is being maintained automatically from data supplied by users, and the
32712 addresses are not rigorously checked.
32713
32714 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32715 entries that fail to parse, noting the incident in the log. If in addition
32716 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32717 whenever a broken address is skipped. It is usually appropriate to set
32718 &%syntax_errors_to%& to the same address as &%errors_to%&.
32719
32720
32721
32722 .section "Re-expansion of mailing lists" "SECID242"
32723 .cindex "mailing lists" "re-expansion of"
32724 Exim remembers every individual address to which a message has been delivered,
32725 in order to avoid duplication, but it normally stores only the original
32726 recipient addresses with a message. If all the deliveries to a mailing list
32727 cannot be done at the first attempt, the mailing list is re-expanded when the
32728 delivery is next tried. This means that alterations to the list are taken into
32729 account at each delivery attempt, so addresses that have been added to
32730 the list since the message arrived will therefore receive a copy of the
32731 message, even though it pre-dates their subscription.
32732
32733 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32734 on the &(redirect)& router. If this is done, any addresses generated by the
32735 router that fail to deliver at the first attempt are added to the message as
32736 &"top level"& addresses, and the parent address that generated them is marked
32737 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32738 subsequent delivery attempts. The disadvantage of this is that if any of the
32739 failing addresses are incorrect, correcting them in the file has no effect on
32740 pre-existing messages.
32741
32742 The original top-level address is remembered with each of the generated
32743 addresses, and is output in any log messages. However, any intermediate parent
32744 addresses are not recorded. This makes a difference to the log only if the
32745 &%all_parents%& selector is set, but for mailing lists there is normally only
32746 one level of expansion anyway.
32747
32748
32749
32750 .section "Closed mailing lists" "SECID243"
32751 .cindex "mailing lists" "closed"
32752 The examples so far have assumed open mailing lists, to which anybody may
32753 send mail. It is also possible to set up closed lists, where mail is accepted
32754 from specified senders only. This is done by making use of the generic
32755 &%senders%& option to restrict the router that handles the list.
32756
32757 The following example uses the same file as a list of recipients and as a list
32758 of permitted senders. It requires three routers:
32759 .code
32760 lists_request:
32761   driver = redirect
32762   domains = lists.example
32763   local_part_suffix = -request
32764   file = /usr/lists/$local_part$local_part_suffix
32765   no_more
32766
32767 lists_post:
32768   driver = redirect
32769   domains = lists.example
32770   senders = ${if exists {/usr/lists/$local_part}\
32771              {lsearch;/usr/lists/$local_part}{*}}
32772   file = /usr/lists/$local_part
32773   forbid_pipe
32774   forbid_file
32775   errors_to = $local_part-request@lists.example
32776   no_more
32777
32778 lists_closed:
32779   driver = redirect
32780   domains = lists.example
32781   allow_fail
32782   data = :fail: $local_part@lists.example is a closed mailing list
32783 .endd
32784 All three routers have the same &%domains%& setting, so for any other domains,
32785 they are all skipped. The first router runs only if the local part ends in
32786 &%-request%&. It handles messages to the list manager(s) by means of an open
32787 mailing list.
32788
32789 The second router runs only if the &%senders%& precondition is satisfied. It
32790 checks for the existence of a list that corresponds to the local part, and then
32791 checks that the sender is on the list by means of a linear search. It is
32792 necessary to check for the existence of the file before trying to search it,
32793 because otherwise Exim thinks there is a configuration error. If the file does
32794 not exist, the expansion of &%senders%& is *, which matches all senders. This
32795 means that the router runs, but because there is no list, declines, and
32796 &%no_more%& ensures that no further routers are run. The address fails with an
32797 &"unrouteable address"& error.
32798
32799 The third router runs only if the second router is skipped, which happens when
32800 a mailing list exists, but the sender is not on it. This router forcibly fails
32801 the address, giving a suitable error message.
32802
32803
32804
32805
32806 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32807 .cindex "VERP"
32808 .cindex "Variable Envelope Return Paths"
32809 .cindex "envelope sender"
32810 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32811 are a way of helping mailing list administrators discover which subscription
32812 address is the cause of a particular delivery failure. The idea is to encode
32813 the original recipient address in the outgoing envelope sender address, so that
32814 if the message is forwarded by another host and then subsequently bounces, the
32815 original recipient can be extracted from the recipient address of the bounce.
32816
32817 .oindex &%errors_to%&
32818 .oindex &%return_path%&
32819 Envelope sender addresses can be modified by Exim using two different
32820 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32821 list examples), or the &%return_path%& option on a transport. The second of
32822 these is effective only if the message is successfully delivered to another
32823 host; it is not used for errors detected on the local host (see the description
32824 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32825 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32826 .code
32827 verp_smtp:
32828   driver = smtp
32829   max_rcpt = 1
32830   return_path = \
32831     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32832       {$1-request+$local_part=$domain@your.dom.example}fail}
32833 .endd
32834 This has the effect of rewriting the return path (envelope sender) on outgoing
32835 SMTP messages, if the local part of the original return path ends in
32836 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32837 local part and domain of the recipient into the return path. Suppose, for
32838 example, that a message whose return path has been set to
32839 &'somelist-request@your.dom.example'& is sent to
32840 &'subscriber@other.dom.example'&. In the transport, the return path is
32841 rewritten as
32842 .code
32843 somelist-request+subscriber=other.dom.example@your.dom.example
32844 .endd
32845 .vindex "&$local_part$&"
32846 For this to work, you must tell Exim to send multiple copies of messages that
32847 have more than one recipient, so that each copy has just one recipient. This is
32848 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32849 might be sent to several different recipients in the same domain, in which case
32850 &$local_part$& is not available in the transport, because it is not unique.
32851
32852 Unless your host is doing nothing but mailing list deliveries, you should
32853 probably use a separate transport for the VERP deliveries, so as not to use
32854 extra resources in making one-per-recipient copies for other deliveries. This
32855 can easily be done by expanding the &%transport%& option in the router:
32856 .code
32857 dnslookup:
32858   driver = dnslookup
32859   domains = ! +local_domains
32860   transport = \
32861     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32862       {verp_smtp}{remote_smtp}}
32863   no_more
32864 .endd
32865 If you want to change the return path using &%errors_to%& in a router instead
32866 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32867 routers that handle mailing list addresses. This will ensure that all delivery
32868 errors, including those detected on the local host, are sent to the VERP
32869 address.
32870
32871 On a host that does no local deliveries and has no manual routing, only the
32872 &(dnslookup)& router needs to be changed. A special transport is not needed for
32873 SMTP deliveries. Every mailing list recipient has its own return path value,
32874 and so Exim must hand them to the transport one at a time. Here is an example
32875 of a &(dnslookup)& router that implements VERP:
32876 .code
32877 verp_dnslookup:
32878   driver = dnslookup
32879   domains = ! +local_domains
32880   transport = remote_smtp
32881   errors_to = \
32882     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32883      {$1-request+$local_part=$domain@your.dom.example}fail}
32884   no_more
32885 .endd
32886 Before you start sending out messages with VERPed return paths, you must also
32887 configure Exim to accept the bounce messages that come back to those paths.
32888 Typically this is done by setting a &%local_part_suffix%& option for a
32889 router, and using this to route the messages to wherever you want to handle
32890 them.
32891
32892 The overhead incurred in using VERP depends very much on the size of the
32893 message, the number of recipient addresses that resolve to the same remote
32894 host, and the speed of the connection over which the message is being sent. If
32895 a lot of addresses resolve to the same host and the connection is slow, sending
32896 a separate copy of the message for each address may take substantially longer
32897 than sending a single copy with many recipients (for which VERP cannot be
32898 used).
32899
32900
32901
32902
32903
32904
32905 .section "Virtual domains" "SECTvirtualdomains"
32906 .cindex "virtual domains"
32907 .cindex "domain" "virtual"
32908 The phrase &'virtual domain'& is unfortunately used with two rather different
32909 meanings:
32910
32911 .ilist
32912 A domain for which there are no real mailboxes; all valid local parts are
32913 aliases for other email addresses. Common examples are organizational
32914 top-level domains and &"vanity"& domains.
32915 .next
32916 One of a number of independent domains that are all handled by the same host,
32917 with mailboxes on that host, but where the mailbox owners do not necessarily
32918 have login accounts on that host.
32919 .endlist
32920
32921 The first usage is probably more common, and does seem more &"virtual"& than
32922 the second. This kind of domain can be handled in Exim with a straightforward
32923 aliasing router. One approach is to create a separate alias file for each
32924 virtual domain. Exim can test for the existence of the alias file to determine
32925 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32926 to a router of this form:
32927 .code
32928 virtual:
32929   driver = redirect
32930   domains = dsearch;/etc/mail/virtual
32931   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32932   no_more
32933 .endd
32934 The &%domains%& option specifies that the router is to be skipped, unless there
32935 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32936 domain that is being processed. When the router runs, it looks up the local
32937 part in the file to find a new address (or list of addresses). The &%no_more%&
32938 setting ensures that if the lookup fails (leading to &%data%& being an empty
32939 string), Exim gives up on the address without trying any subsequent routers.
32940
32941 This one router can handle all the virtual domains because the alias file names
32942 follow a fixed pattern. Permissions can be arranged so that appropriate people
32943 can edit the different alias files. A successful aliasing operation results in
32944 a new envelope recipient address, which is then routed from scratch.
32945
32946 The other kind of &"virtual"& domain can also be handled in a straightforward
32947 way. One approach is to create a file for each domain containing a list of
32948 valid local parts, and use it in a router like this:
32949 .code
32950 my_domains:
32951   driver = accept
32952   domains = dsearch;/etc/mail/domains
32953   local_parts = lsearch;/etc/mail/domains/$domain
32954   transport = my_mailboxes
32955 .endd
32956 The address is accepted if there is a file for the domain, and the local part
32957 can be found in the file. The &%domains%& option is used to check for the
32958 file's existence because &%domains%& is tested before the &%local_parts%&
32959 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32960 because that option is tested after &%local_parts%&. The transport is as
32961 follows:
32962 .code
32963 my_mailboxes:
32964   driver = appendfile
32965   file = /var/mail/$domain/$local_part
32966   user = mail
32967 .endd
32968 This uses a directory of mailboxes for each domain. The &%user%& setting is
32969 required, to specify which uid is to be used for writing to the mailboxes.
32970
32971 The configuration shown here is just one example of how you might support this
32972 requirement. There are many other ways this kind of configuration can be set
32973 up, for example, by using a database instead of separate files to hold all the
32974 information about the domains.
32975
32976
32977
32978 .section "Multiple user mailboxes" "SECTmulbox"
32979 .cindex "multiple mailboxes"
32980 .cindex "mailbox" "multiple"
32981 .cindex "local part" "prefix"
32982 .cindex "local part" "suffix"
32983 Heavy email users often want to operate with multiple mailboxes, into which
32984 incoming mail is automatically sorted. A popular way of handling this is to
32985 allow users to use multiple sender addresses, so that replies can easily be
32986 identified. Users are permitted to add prefixes or suffixes to their local
32987 parts for this purpose. The wildcard facility of the generic router options
32988 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32989 example, consider this router:
32990 .code
32991 userforward:
32992   driver = redirect
32993   check_local_user
32994   file = $home/.forward
32995   local_part_suffix = -*
32996   local_part_suffix_optional
32997   allow_filter
32998 .endd
32999 .vindex "&$local_part_suffix$&"
33000 It runs a user's &_.forward_& file for all local parts of the form
33001 &'username-*'&. Within the filter file the user can distinguish different
33002 cases by testing the variable &$local_part_suffix$&. For example:
33003 .code
33004 if $local_part_suffix contains -special then
33005 save /home/$local_part/Mail/special
33006 endif
33007 .endd
33008 If the filter file does not exist, or does not deal with such addresses, they
33009 fall through to subsequent routers, and, assuming no subsequent use of the
33010 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33011 control over which suffixes are valid.
33012
33013 Alternatively, a suffix can be used to trigger the use of a different
33014 &_.forward_& file &-- which is the way a similar facility is implemented in
33015 another MTA:
33016 .code
33017 userforward:
33018   driver = redirect
33019   check_local_user
33020   file = $home/.forward$local_part_suffix
33021   local_part_suffix = -*
33022   local_part_suffix_optional
33023   allow_filter
33024 .endd
33025 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33026 example, &_.forward-special_& is used. Once again, if the appropriate file
33027 does not exist, or does not deal with the address, it is passed on to
33028 subsequent routers, which could, if required, look for an unqualified
33029 &_.forward_& file to use as a default.
33030
33031
33032
33033 .section "Simplified vacation processing" "SECID244"
33034 .cindex "vacation processing"
33035 The traditional way of running the &'vacation'& program is for a user to set up
33036 a pipe command in a &_.forward_& file
33037 (see section &<<SECTspecitredli>>& for syntax details).
33038 This is prone to error by inexperienced users. There are two features of Exim
33039 that can be used to make this process simpler for users:
33040
33041 .ilist
33042 A local part prefix such as &"vacation-"& can be specified on a router which
33043 can cause the message to be delivered directly to the &'vacation'& program, or
33044 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33045 &_.forward_& file are then much simpler. For example:
33046 .code
33047 spqr, vacation-spqr
33048 .endd
33049 .next
33050 The &%require_files%& generic router option can be used to trigger a
33051 vacation delivery by checking for the existence of a certain file in the
33052 user's home directory. The &%unseen%& generic option should also be used, to
33053 ensure that the original delivery also proceeds. In this case, all the user has
33054 to do is to create a file called, say, &_.vacation_&, containing a vacation
33055 message.
33056 .endlist
33057
33058 Another advantage of both these methods is that they both work even when the
33059 use of arbitrary pipes by users is locked out.
33060
33061
33062
33063 .section "Taking copies of mail" "SECID245"
33064 .cindex "message" "copying every"
33065 Some installations have policies that require archive copies of all messages to
33066 be made. A single copy of each message can easily be taken by an appropriate
33067 command in a system filter, which could, for example, use a different file for
33068 each day's messages.
33069
33070 There is also a shadow transport mechanism that can be used to take copies of
33071 messages that are successfully delivered by local transports, one copy per
33072 delivery. This could be used, &'inter alia'&, to implement automatic
33073 notification of delivery by sites that insist on doing such things.
33074
33075
33076
33077 .section "Intermittently connected hosts" "SECID246"
33078 .cindex "intermittently connected hosts"
33079 It has become quite common (because it is cheaper) for hosts to connect to the
33080 Internet periodically rather than remain connected all the time. The normal
33081 arrangement is that mail for such hosts accumulates on a system that is
33082 permanently connected.
33083
33084 Exim was designed for use on permanently connected hosts, and so it is not
33085 particularly well-suited to use in an intermittently connected environment.
33086 Nevertheless there are some features that can be used.
33087
33088
33089 .section "Exim on the upstream server host" "SECID247"
33090 It is tempting to arrange for incoming mail for the intermittently connected
33091 host to remain on Exim's queue until the client connects. However, this
33092 approach does not scale very well. Two different kinds of waiting message are
33093 being mixed up in the same queue &-- those that cannot be delivered because of
33094 some temporary problem, and those that are waiting for their destination host
33095 to connect. This makes it hard to manage the queue, as well as wasting
33096 resources, because each queue runner scans the entire queue.
33097
33098 A better approach is to separate off those messages that are waiting for an
33099 intermittently connected host. This can be done by delivering these messages
33100 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33101 format, from where they are transmitted by other software when their
33102 destination connects. This makes it easy to collect all the mail for one host
33103 in a single directory, and to apply local timeout rules on a per-message basis
33104 if required.
33105
33106 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33107 you are doing this, you should configure Exim with a long retry period for the
33108 intermittent host. For example:
33109 .code
33110 cheshire.wonderland.fict.example    *   F,5d,24h
33111 .endd
33112 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33113 which messages it has queued up for that host. Once the intermittent host comes
33114 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33115 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33116 causes all the queued up messages to be delivered, often down a single SMTP
33117 connection. While the host remains connected, any new messages get delivered
33118 immediately.
33119
33120 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33121 issued with a different IP address each time it connects, Exim's retry
33122 mechanisms on the holding host get confused, because the IP address is normally
33123 used as part of the key string for holding retry information. This can be
33124 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33125 Since this has disadvantages for permanently connected hosts, it is best to
33126 arrange a separate transport for the intermittently connected ones.
33127
33128
33129
33130 .section "Exim on the intermittently connected client host" "SECID248"
33131 The value of &%smtp_accept_queue_per_connection%& should probably be
33132 increased, or even set to zero (that is, disabled) on the intermittently
33133 connected host, so that all incoming messages down a single connection get
33134 delivered immediately.
33135
33136 .cindex "SMTP" "passed connection"
33137 .cindex "SMTP" "multiple deliveries"
33138 .cindex "multiple SMTP deliveries"
33139 Mail waiting to be sent from an intermittently connected host will probably
33140 not have been routed, because without a connection DNS lookups are not
33141 possible. This means that if a normal queue run is done at connection time,
33142 each message is likely to be sent in a separate SMTP session. This can be
33143 avoided by starting the queue run with a command line option beginning with
33144 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33145 first pass, routing is done but no deliveries take place. The second pass is a
33146 normal queue run; since all the messages have been previously routed, those
33147 destined for the same host are likely to get sent as multiple deliveries in a
33148 single SMTP connection.
33149
33150
33151
33152 . ////////////////////////////////////////////////////////////////////////////
33153 . ////////////////////////////////////////////////////////////////////////////
33154
33155 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33156          "Exim as a non-queueing client"
33157 .cindex "client, non-queueing"
33158 .cindex "smart host" "suppressing queueing"
33159 On a personal computer, it is a common requirement for all
33160 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33161 configured to operate that way, for all the popular operating systems.
33162 However, there are some MUAs for Unix-like systems that cannot be so
33163 configured: they submit messages using the command line interface of
33164 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33165 messages this way.
33166
33167 If the personal computer runs continuously, there is no problem, because it can
33168 run a conventional MTA that handles delivery to the smart host, and deal with
33169 any delays via its queueing mechanism. However, if the computer does not run
33170 continuously or runs different operating systems at different times, queueing
33171 email is not desirable.
33172
33173 There is therefore a requirement for something that can provide the
33174 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33175 any queueing or retrying facilities. Furthermore, the delivery to the smart
33176 host should be synchronous, so that if it fails, the sending MUA is immediately
33177 informed. In other words, we want something that extends an MUA that submits
33178 to a local MTA via the command line so that it behaves like one that submits
33179 to a remote smart host using TCP/SMTP.
33180
33181 There are a number of applications (for example, there is one called &'ssmtp'&)
33182 that do this job. However, people have found them to be lacking in various
33183 ways. For instance, you might want to allow aliasing and forwarding to be done
33184 before sending a message to the smart host.
33185
33186 Exim already had the necessary infrastructure for doing this job. Just a few
33187 tweaks were needed to make it behave as required, though it is somewhat of an
33188 overkill to use a fully-featured MTA for this purpose.
33189
33190 .oindex "&%mua_wrapper%&"
33191 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33192 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33193 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33194 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33195 compatible router and transport configuration. Typically there will be just one
33196 router and one transport, sending everything to a smart host.
33197
33198 When run in MUA wrapping mode, the behaviour of Exim changes in the
33199 following ways:
33200
33201 .ilist
33202 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33203 In other words, the only way to submit messages is via the command line.
33204 .next
33205 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33206 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33207 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33208 does not finish until the delivery attempt is complete. If the delivery is
33209 successful, a zero return code is given.
33210 .next
33211 Address redirection is permitted, but the final routing for all addresses must
33212 be to the same remote transport, and to the same list of hosts. Furthermore,
33213 the return address (envelope sender) must be the same for all recipients, as
33214 must any added or deleted header lines. In other words, it must be possible to
33215 deliver the message in a single SMTP transaction, however many recipients there
33216 are.
33217 .next
33218 If these conditions are not met, or if routing any address results in a
33219 failure or defer status, or if Exim is unable to deliver all the recipients
33220 successfully to one of the smart hosts, delivery of the entire message fails.
33221 .next
33222 Because no queueing is allowed, all failures are treated as permanent; there
33223 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33224 smart host. Furthermore, because only a single yes/no response can be given to
33225 the caller, it is not possible to deliver to some recipients and not others. If
33226 there is an error (temporary or permanent) for any recipient, all are failed.
33227 .next
33228 If more than one smart host is listed, Exim will try another host after a
33229 connection failure or a timeout, in the normal way. However, if this kind of
33230 failure happens for all the hosts, the delivery fails.
33231 .next
33232 When delivery fails, an error message is written to the standard error stream
33233 (as well as to Exim's log), and Exim exits to the caller with a return code
33234 value 1. The message is expunged from Exim's spool files. No bounce messages
33235 are ever generated.
33236 .next
33237 No retry data is maintained, and any retry rules are ignored.
33238 .next
33239 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33240 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33241 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33242 .endlist
33243
33244 The overall effect is that Exim makes a single synchronous attempt to deliver
33245 the message, failing if there is any kind of problem. Because no local
33246 deliveries are done and no daemon can be run, Exim does not need root
33247 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33248 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33249 the advantages and disadvantages of running without root privilege.
33250
33251
33252
33253
33254 . ////////////////////////////////////////////////////////////////////////////
33255 . ////////////////////////////////////////////////////////////////////////////
33256
33257 .chapter "Log files" "CHAPlog"
33258 .scindex IIDloggen "log" "general description"
33259 .cindex "log" "types of"
33260 Exim writes three different logs, referred to as the main log, the reject log,
33261 and the panic log:
33262
33263 .ilist
33264 .cindex "main log"
33265 The main log records the arrival of each message and each delivery in a single
33266 line in each case. The format is as compact as possible, in an attempt to keep
33267 down the size of log files. Two-character flag sequences make it easy to pick
33268 out these lines. A number of other events are recorded in the main log. Some of
33269 them are optional, in which case the &%log_selector%& option controls whether
33270 they are included or not. A Perl script called &'eximstats'&, which does simple
33271 analysis of main log files, is provided in the Exim distribution (see section
33272 &<<SECTmailstat>>&).
33273 .next
33274 .cindex "reject log"
33275 The reject log records information from messages that are rejected as a result
33276 of a configuration option (that is, for policy reasons).
33277 The first line of each rejection is a copy of the line that is also written to
33278 the main log. Then, if the message's header has been read at the time the log
33279 is written, its contents are written to this log. Only the original header
33280 lines are available; header lines added by ACLs are not logged. You can use the
33281 reject log to check that your policy controls are working correctly; on a busy
33282 host this may be easier than scanning the main log for rejection messages. You
33283 can suppress the writing of the reject log by setting &%write_rejectlog%&
33284 false.
33285 .next
33286 .cindex "panic log"
33287 .cindex "system log"
33288 When certain serious errors occur, Exim writes entries to its panic log. If the
33289 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33290 are usually written to the main log as well, but can get lost amid the mass of
33291 other entries. The panic log should be empty under normal circumstances. It is
33292 therefore a good idea to check it (or to have a &'cron'& script check it)
33293 regularly, in order to become aware of any problems. When Exim cannot open its
33294 panic log, it tries as a last resort to write to the system log (syslog). This
33295 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33296 message itself is written at priority LOG_CRIT.
33297 .endlist
33298
33299 Every log line starts with a timestamp, in the format shown in the following
33300 example. Note that many of the examples shown in this chapter are line-wrapped.
33301 In the log file, this would be all on one line:
33302 .code
33303 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33304   by QUIT
33305 .endd
33306 By default, the timestamps are in the local timezone. There are two
33307 ways of changing this:
33308
33309 .ilist
33310 You can set the &%timezone%& option to a different time zone; in particular, if
33311 you set
33312 .code
33313 timezone = UTC
33314 .endd
33315 the timestamps will be in UTC (aka GMT).
33316 .next
33317 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33318 example:
33319 .code
33320 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33321 .endd
33322 .endlist
33323
33324 .cindex "log" "process ids in"
33325 .cindex "pid (process id)" "in log lines"
33326 Exim does not include its process id in log lines by default, but you can
33327 request that it does so by specifying the &`pid`& log selector (see section
33328 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33329 brackets, immediately after the time and date.
33330
33331
33332
33333
33334 .section "Where the logs are written" "SECTwhelogwri"
33335 .cindex "log" "destination"
33336 .cindex "log" "to file"
33337 .cindex "log" "to syslog"
33338 .cindex "syslog"
33339 The logs may be written to local files, or to syslog, or both. However, it
33340 should be noted that many syslog implementations use UDP as a transport, and
33341 are therefore unreliable in the sense that messages are not guaranteed to
33342 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33343 It has also been reported that on large log files (tens of megabytes) you may
33344 need to tweak syslog to prevent it syncing the file with each write &-- on
33345 Linux this has been seen to make syslog take 90% plus of CPU time.
33346
33347 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33348 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33349 configuration. This latter string is expanded, so it can contain, for example,
33350 references to the host name:
33351 .code
33352 log_file_path = /var/log/$primary_hostname/exim_%slog
33353 .endd
33354 It is generally advisable, however, to set the string in &_Local/Makefile_&
33355 rather than at run time, because then the setting is available right from the
33356 start of Exim's execution. Otherwise, if there's something it wants to log
33357 before it has read the configuration file (for example, an error in the
33358 configuration file) it will not use the path you want, and may not be able to
33359 log at all.
33360
33361 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33362 list, currently limited to at most two items. This is one option where the
33363 facility for changing a list separator may not be used. The list must always be
33364 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33365 otherwise the item must either be an absolute path, containing &`%s`& at the
33366 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33367 implying the use of a default path.
33368
33369 When Exim encounters an empty item in the list, it searches the list defined by
33370 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33371 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33372 mean &"use the path specified at build time"&. It no such item exists, log
33373 files are written in the &_log_& subdirectory of the spool directory. This is
33374 equivalent to the setting:
33375 .code
33376 log_file_path = $spool_directory/log/%slog
33377 .endd
33378 If you do not specify anything at build time or run time, that is where the
33379 logs are written.
33380
33381 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33382 are in use &-- see section &<<SECTdatlogfil>>& below.
33383
33384 Here are some examples of possible settings:
33385 .display
33386 &`LOG_FILE_PATH=syslog                    `& syslog only
33387 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33388 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33389 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33390 .endd
33391 If there are more than two paths in the list, the first is used and a panic
33392 error is logged.
33393
33394
33395
33396 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33397 .cindex "log" "cycling local files"
33398 .cindex "cycling logs"
33399 .cindex "&'exicyclog'&"
33400 .cindex "log" "local files; writing to"
33401 Some operating systems provide centralized and standardized methods for cycling
33402 log files. For those that do not, a utility script called &'exicyclog'& is
33403 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33404 main and reject logs each time it is called. The maximum number of old logs to
33405 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33406
33407 An Exim delivery process opens the main log when it first needs to write to it,
33408 and it keeps the file open in case subsequent entries are required &-- for
33409 example, if a number of different deliveries are being done for the same
33410 message. However, remote SMTP deliveries can take a long time, and this means
33411 that the file may be kept open long after it is renamed if &'exicyclog'& or
33412 something similar is being used to rename log files on a regular basis. To
33413 ensure that a switch of log files is noticed as soon as possible, Exim calls
33414 &[stat()]& on the main log's name before reusing an open file, and if the file
33415 does not exist, or its inode has changed, the old file is closed and Exim
33416 tries to open the main log from scratch. Thus, an old log file may remain open
33417 for quite some time, but no Exim processes should write to it once it has been
33418 renamed.
33419
33420
33421
33422 .section "Datestamped log files" "SECTdatlogfil"
33423 .cindex "log" "datestamped files"
33424 Instead of cycling the main and reject log files by renaming them
33425 periodically, some sites like to use files whose names contain a datestamp,
33426 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33427 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33428 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33429 point where the datestamp is required. For example:
33430 .code
33431 log_file_path = /var/spool/exim/log/%slog-%D
33432 log_file_path = /var/log/exim-%s-%D.log
33433 log_file_path = /var/spool/exim/log/%D-%slog
33434 log_file_path = /var/log/exim/%s.%M
33435 .endd
33436 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33437 examples of names generated by the above examples:
33438 .code
33439 /var/spool/exim/log/mainlog-20021225
33440 /var/log/exim-reject-20021225.log
33441 /var/spool/exim/log/20021225-mainlog
33442 /var/log/exim/main.200212
33443 .endd
33444 When this form of log file is specified, Exim automatically switches to new
33445 files at midnight. It does not make any attempt to compress old logs; you
33446 will need to write your own script if you require this. You should not
33447 run &'exicyclog'& with this form of logging.
33448
33449 The location of the panic log is also determined by &%log_file_path%&, but it
33450 is not datestamped, because rotation of the panic log does not make sense.
33451 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33452 the string. In addition, if it immediately follows a slash, a following
33453 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33454 character is removed. Thus, the four examples above would give these panic
33455 log names:
33456 .code
33457 /var/spool/exim/log/paniclog
33458 /var/log/exim-panic.log
33459 /var/spool/exim/log/paniclog
33460 /var/log/exim/panic
33461 .endd
33462
33463
33464 .section "Logging to syslog" "SECID249"
33465 .cindex "log" "syslog; writing to"
33466 The use of syslog does not change what Exim logs or the format of its messages,
33467 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33468 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33469 that, the same strings are written to syslog as to log files. The syslog
33470 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33471 by default, but you can change these by setting the &%syslog_facility%& and
33472 &%syslog_processname%& options, respectively. If Exim was compiled with
33473 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33474 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33475 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33476 the time and host name to each line.
33477 The three log streams are mapped onto syslog priorities as follows:
33478
33479 .ilist
33480 &'mainlog'& is mapped to LOG_INFO
33481 .next
33482 &'rejectlog'& is mapped to LOG_NOTICE
33483 .next
33484 &'paniclog'& is mapped to LOG_ALERT
33485 .endlist
33486
33487 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33488 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33489 these are routed by syslog to the same place. You can suppress this duplication
33490 by setting &%syslog_duplication%& false.
33491
33492 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33493 entries contain multiple lines when headers are included. To cope with both
33494 these cases, entries written to syslog are split into separate &[syslog()]&
33495 calls at each internal newline, and also after a maximum of
33496 870 data characters. (This allows for a total syslog line length of 1024, when
33497 additions such as timestamps are added.) If you are running a syslog
33498 replacement that can handle lines longer than the 1024 characters allowed by
33499 RFC 3164, you should set
33500 .code
33501 SYSLOG_LONG_LINES=yes
33502 .endd
33503 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33504 lines, but it still splits at internal newlines in &'reject'& log entries.
33505
33506 To make it easy to re-assemble split lines later, each component of a split
33507 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33508 where <&'n'&> is the component number and <&'m'&> is the total number of
33509 components in the entry. The / delimiter is used when the line was split
33510 because it was too long; if it was split because of an internal newline, the \
33511 delimiter is used. For example, supposing the length limit to be 50 instead of
33512 870, the following would be the result of a typical rejection message to
33513 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33514 name, and pid as added by syslog:
33515 .code
33516 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33517 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33518 [3/5]  when scanning for sender: missing or malformed lo
33519 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33520 [5/5] mple>)
33521 .endd
33522 The same error might cause the following lines to be written to &"rejectlog"&
33523 (LOG_NOTICE):
33524 .code
33525 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33526 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33527 [3/18] er when scanning for sender: missing or malformed
33528 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33529 [5\18] .example>)
33530 [6\18] Recipients: ph10@some.domain.cam.example
33531 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33532 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33533 [9\18]        id 16RdAL-0006pc-00
33534 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33535 [11\18] 09:43 +0100
33536 [12\18] F From: <>
33537 [13\18]   Subject: this is a test header
33538 [18\18]   X-something: this is another header
33539 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33540 [16\18] le>
33541 [17\18] B Bcc:
33542 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33543 .endd
33544 Log lines that are neither too long nor contain newlines are written to syslog
33545 without modification.
33546
33547 If only syslog is being used, the Exim monitor is unable to provide a log tail
33548 display, unless syslog is routing &'mainlog'& to a file on the local host and
33549 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33550 where it is.
33551
33552
33553
33554 .section "Log line flags" "SECID250"
33555 One line is written to the main log for each message received, and for each
33556 successful, unsuccessful, and delayed delivery. These lines can readily be
33557 picked out by the distinctive two-character flags that immediately follow the
33558 timestamp. The flags are:
33559 .display
33560 &`<=`&     message arrival
33561 &`=>`&     normal message delivery
33562 &`->`&     additional address in same delivery
33563 &`>>`&     cutthrough message delivery
33564 &`*>`&     delivery suppressed by &%-N%&
33565 &`**`&     delivery failed; address bounced
33566 &`==`&     delivery deferred; temporary problem
33567 .endd
33568
33569
33570 .section "Logging message reception" "SECID251"
33571 .cindex "log" "reception line"
33572 The format of the single-line entry in the main log that is written for every
33573 message received is shown in the basic example below, which is split over
33574 several lines in order to fit it on the page:
33575 .code
33576 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33577   H=mailer.fict.example [192.168.123.123] U=exim
33578   P=smtp S=5678 id=<incoming message id>
33579 .endd
33580 The address immediately following &"<="& is the envelope sender address. A
33581 bounce message is shown with the sender address &"<>"&, and if it is locally
33582 generated, this is followed by an item of the form
33583 .code
33584 R=<message id>
33585 .endd
33586 which is a reference to the message that caused the bounce to be sent.
33587
33588 .cindex "HELO"
33589 .cindex "EHLO"
33590 For messages from other hosts, the H and U fields identify the remote host and
33591 record the RFC 1413 identity of the user that sent the message, if one was
33592 received. The number given in square brackets is the IP address of the sending
33593 host. If there is a single, unparenthesized  host name in the H field, as
33594 above, it has been verified to correspond to the IP address (see the
33595 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33596 by the remote host in the SMTP HELO or EHLO command, and has not been
33597 verified. If verification yields a different name to that given for HELO or
33598 EHLO, the verified name appears first, followed by the HELO or EHLO
33599 name in parentheses.
33600
33601 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33602 without brackets, in the HELO or EHLO command, leading to entries in
33603 the log containing text like these examples:
33604 .code
33605 H=(10.21.32.43) [192.168.8.34]
33606 H=([10.21.32.43]) [192.168.8.34]
33607 .endd
33608 This can be confusing. Only the final address in square brackets can be relied
33609 on.
33610
33611 For locally generated messages (that is, messages not received over TCP/IP),
33612 the H field is omitted, and the U field contains the login name of the caller
33613 of Exim.
33614
33615 .cindex "authentication" "logging"
33616 .cindex "AUTH" "logging"
33617 For all messages, the P field specifies the protocol used to receive the
33618 message. This is the value that is stored in &$received_protocol$&. In the case
33619 of incoming SMTP messages, the value indicates whether or not any SMTP
33620 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33621 session was encrypted, there is an additional X field that records the cipher
33622 suite that was used.
33623
33624 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33625 hosts that have authenticated themselves using the SMTP AUTH command. The first
33626 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33627 there is an additional item A= followed by the name of the authenticator that
33628 was used. If an authenticated identification was set up by the authenticator's
33629 &%server_set_id%& option, this is logged too, separated by a colon from the
33630 authenticator name.
33631
33632 .cindex "size" "of message"
33633 The id field records the existing message id, if present. The size of the
33634 received message is given by the S field. When the message is delivered,
33635 headers may be removed or added, so that the size of delivered copies of the
33636 message may not correspond with this value (and indeed may be different to each
33637 other).
33638
33639 The &%log_selector%& option can be used to request the logging of additional
33640 data when a message is received. See section &<<SECTlogselector>>& below.
33641
33642
33643
33644 .section "Logging deliveries" "SECID252"
33645 .cindex "log" "delivery line"
33646 The format of the single-line entry in the main log that is written for every
33647 delivery is shown in one of the examples below, for local and remote
33648 deliveries, respectively. Each example has been split into two lines in order
33649 to fit it on the page:
33650 .code
33651 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33652   <marv@hitch.fict.example> R=localuser T=local_delivery
33653 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33654   monk@holistic.fict.example R=dnslookup T=remote_smtp
33655   H=holistic.fict.example [192.168.234.234]
33656 .endd
33657 For ordinary local deliveries, the original address is given in angle brackets
33658 after the final delivery address, which might be a pipe or a file. If
33659 intermediate address(es) exist between the original and the final address, the
33660 last of these is given in parentheses after the final address. The R and T
33661 fields record the router and transport that were used to process the address.
33662
33663 If SMTP AUTH was used for the delivery there is an additional item A=
33664 followed by the name of the authenticator that was used.
33665 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33666 option, this is logged too, separated by a colon from the authenticator name.
33667
33668 If a shadow transport was run after a successful local delivery, the log line
33669 for the successful delivery has an item added on the end, of the form
33670 .display
33671 &`ST=<`&&'shadow transport name'&&`>`&
33672 .endd
33673 If the shadow transport did not succeed, the error message is put in
33674 parentheses afterwards.
33675
33676 .cindex "asterisk" "after IP address"
33677 When more than one address is included in a single delivery (for example, two
33678 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33679 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33680 down a single SMTP connection, an asterisk follows the IP address in the log
33681 lines for the second and subsequent messages.
33682
33683 .cindex "delivery" "cutthrough; logging"
33684 .cindex "cutthrough" "logging"
33685 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
33686 line precedes the reception line, since cutthrough waits for a possible
33687 rejection from the destination in case it can reject the sourced item.
33688
33689 The generation of a reply message by a filter file gets logged as a
33690 &"delivery"& to the addressee, preceded by &">"&.
33691
33692 The &%log_selector%& option can be used to request the logging of additional
33693 data when a message is delivered. See section &<<SECTlogselector>>& below.
33694
33695
33696 .section "Discarded deliveries" "SECID253"
33697 .cindex "discarded messages"
33698 .cindex "message" "discarded"
33699 .cindex "delivery" "discarded; logging"
33700 When a message is discarded as a result of the command &"seen finish"& being
33701 obeyed in a filter file which generates no deliveries, a log entry of the form
33702 .code
33703 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33704   <low.club@bridge.example> R=userforward
33705 .endd
33706 is written, to record why no deliveries are logged. When a message is discarded
33707 because it is aliased to &":blackhole:"& the log line is like this:
33708 .code
33709 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33710   <hole@nowhere.example> R=blackhole_router
33711 .endd
33712
33713
33714 .section "Deferred deliveries" "SECID254"
33715 When a delivery is deferred, a line of the following form is logged:
33716 .code
33717 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33718   R=dnslookup T=smtp defer (146): Connection refused
33719 .endd
33720 In the case of remote deliveries, the error is the one that was given for the
33721 last IP address that was tried. Details of individual SMTP failures are also
33722 written to the log, so the above line would be preceded by something like
33723 .code
33724 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33725   mail1.endrest.example [192.168.239.239]: Connection refused
33726 .endd
33727 When a deferred address is skipped because its retry time has not been reached,
33728 a message is written to the log, but this can be suppressed by setting an
33729 appropriate value in &%log_selector%&.
33730
33731
33732
33733 .section "Delivery failures" "SECID255"
33734 .cindex "delivery" "failure; logging"
33735 If a delivery fails because an address cannot be routed, a line of the
33736 following form is logged:
33737 .code
33738 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33739   <jim@trek99.example>: unknown mail domain
33740 .endd
33741 If a delivery fails at transport time, the router and transport are shown, and
33742 the response from the remote host is included, as in this example:
33743 .code
33744 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33745   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33746   after pipelined RCPT TO:<ace400@pb.example>: host
33747   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33748   <ace400@pb.example>...Addressee unknown
33749 .endd
33750 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33751 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33752 disabling PIPELINING. The log lines for all forms of delivery failure are
33753 flagged with &`**`&.
33754
33755
33756
33757 .section "Fake deliveries" "SECID256"
33758 .cindex "delivery" "fake; logging"
33759 If a delivery does not actually take place because the &%-N%& option has been
33760 used to suppress it, a normal delivery line is written to the log, except that
33761 &"=>"& is replaced by &"*>"&.
33762
33763
33764
33765 .section "Completion" "SECID257"
33766 A line of the form
33767 .code
33768 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33769 .endd
33770 is written to the main log when a message is about to be removed from the spool
33771 at the end of its processing.
33772
33773
33774
33775
33776 .section "Summary of Fields in Log Lines" "SECID258"
33777 .cindex "log" "summary of fields"
33778 A summary of the field identifiers that are used in log lines is shown in
33779 the following table:
33780 .display
33781 &`A   `&        authenticator name (and optional id and sender)
33782 &`C   `&        SMTP confirmation on delivery
33783 &`    `&        command list for &"no mail in SMTP session"&
33784 &`CV  `&        certificate verification status
33785 &`D   `&        duration of &"no mail in SMTP session"&
33786 &`DN  `&        distinguished name from peer certificate
33787 &`DT  `&        on &`=>`& lines: time taken for a delivery
33788 &`F   `&        sender address (on delivery lines)
33789 &`H   `&        host name and IP address
33790 &`I   `&        local interface used
33791 &`id  `&        message id for incoming message
33792 &`P   `&        on &`<=`& lines: protocol used
33793 &`    `&        on &`=>`& and &`**`& lines: return path
33794 &`QT  `&        on &`=>`& lines: time spent on queue so far
33795 &`    `&        on &"Completed"& lines: time spent on queue
33796 &`R   `&        on &`<=`& lines: reference for local bounce
33797 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33798 &`S   `&        size of message
33799 &`ST  `&        shadow transport name
33800 &`T   `&        on &`<=`& lines: message subject (topic)
33801 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33802 &`U   `&        local user or RFC 1413 identity
33803 &`X   `&        TLS cipher suite
33804 .endd
33805
33806
33807 .section "Other log entries" "SECID259"
33808 Various other types of log entry are written from time to time. Most should be
33809 self-explanatory. Among the more common are:
33810
33811 .ilist
33812 .cindex "retry" "time not reached"
33813 &'retry time not reached'&&~&~An address previously suffered a temporary error
33814 during routing or local delivery, and the time to retry has not yet arrived.
33815 This message is not written to an individual message log file unless it happens
33816 during the first delivery attempt.
33817 .next
33818 &'retry time not reached for any host'&&~&~An address previously suffered
33819 temporary errors during remote delivery, and the retry time has not yet arrived
33820 for any of the hosts to which it is routed.
33821 .next
33822 .cindex "spool directory" "file locked"
33823 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33824 some other Exim process is already working on the message. This can be quite
33825 common if queue running processes are started at frequent intervals. The
33826 &'exiwhat'& utility script can be used to find out what Exim processes are
33827 doing.
33828 .next
33829 .cindex "error" "ignored"
33830 &'error ignored'&&~&~There are several circumstances that give rise to this
33831 message:
33832 .olist
33833 Exim failed to deliver a bounce message whose age was greater than
33834 &%ignore_bounce_errors_after%&. The bounce was discarded.
33835 .next
33836 A filter file set up a delivery using the &"noerror"& option, and the delivery
33837 failed. The delivery was discarded.
33838 .next
33839 A delivery set up by a router configured with
33840 . ==== As this is a nested list, any displays it contains must be indented
33841 . ==== as otherwise they are too far to the left.
33842 .code
33843     errors_to = <>
33844 .endd
33845 failed. The delivery was discarded.
33846 .endlist olist
33847 .endlist ilist
33848
33849
33850
33851
33852
33853 .section "Reducing or increasing what is logged" "SECTlogselector"
33854 .cindex "log" "selectors"
33855 By setting the &%log_selector%& global option, you can disable some of Exim's
33856 default logging, or you can request additional logging. The value of
33857 &%log_selector%& is made up of names preceded by plus or minus characters. For
33858 example:
33859 .code
33860 log_selector = +arguments -retry_defer
33861 .endd
33862 The list of optional log items is in the following table, with the default
33863 selection marked by asterisks:
33864 .display
33865 &` 8bitmime                   `&  received 8BITMIME status
33866 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33867 &` address_rewrite            `&  address rewriting
33868 &` all_parents                `&  all parents in => lines
33869 &` arguments                  `&  command line arguments
33870 &`*connection_reject          `&  connection rejections
33871 &`*delay_delivery             `&  immediate delivery delayed
33872 &` deliver_time               `&  time taken to perform delivery
33873 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33874 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33875 &`*etrn                       `&  ETRN commands
33876 &`*host_lookup_failed         `&  as it says
33877 &` ident_timeout              `&  timeout for ident connection
33878 &` incoming_interface         `&  incoming interface on <= lines
33879 &` incoming_port              `&  incoming port on <= lines
33880 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33881 &` outgoing_port              `&  add remote port to => lines
33882 &`*queue_run                  `&  start and end queue runs
33883 &` queue_time                 `&  time on queue for one recipient
33884 &` queue_time_overall         `&  time on queue for whole message
33885 &` pid                        `&  Exim process id
33886 &` received_recipients        `&  recipients on <= lines
33887 &` received_sender            `&  sender on <= lines
33888 &`*rejected_header            `&  header contents on reject log
33889 &`*retry_defer                `&  &"retry time not reached"&
33890 &` return_path_on_delivery    `&  put return path on => and ** lines
33891 &` sender_on_delivery         `&  add sender to => lines
33892 &`*sender_verify_fail         `&  sender verification failures
33893 &`*size_reject                `&  rejection because too big
33894 &`*skip_delivery              `&  delivery skipped in a queue run
33895 &`*smtp_confirmation          `&  SMTP confirmation on => lines
33896 &` smtp_connection            `&  SMTP connections
33897 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33898 &` smtp_mailauth              `&  AUTH argument to MAIL commands
33899 &` smtp_no_mail               `&  session with no MAIL commands
33900 &` smtp_protocol_error        `&  SMTP protocol errors
33901 &` smtp_syntax_error          `&  SMTP syntax errors
33902 &` subject                    `&  contents of &'Subject:'& on <= lines
33903 &` tls_certificate_verified   `&  certificate verification status
33904 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33905 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33906 &` tls_sni                    `&  TLS SNI on <= lines
33907 &` unknown_in_list            `&  DNS lookup failed in list match
33908
33909 &` all                        `&  all of the above
33910 .endd
33911 More details on each of these items follows:
33912
33913 .ilist
33914 .cindex "8BITMIME"
33915 .cindex "log" "8BITMIME"
33916 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
33917 which may help in tracking down interoperability issues with ancient MTAs
33918 that are not 8bit clean.  This is added to the &"<="& line, tagged with
33919 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
33920 &`7BIT`& and &`8BITMIME`& respectively.
33921 .next
33922 .cindex "&%warn%& ACL verb" "log when skipping"
33923 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33924 its conditions cannot be evaluated, a log line to this effect is written if
33925 this log selector is set.
33926 .next
33927 .cindex "log" "rewriting"
33928 .cindex "rewriting" "logging"
33929 &%address_rewrite%&: This applies both to global rewrites and per-transport
33930 rewrites, but not to rewrites in filters run as an unprivileged user (because
33931 such users cannot access the log).
33932 .next
33933 .cindex "log" "full parentage"
33934 &%all_parents%&: Normally only the original and final addresses are logged on
33935 delivery lines; with this selector, intermediate parents are given in
33936 parentheses between them.
33937 .next
33938 .cindex "log" "Exim arguments"
33939 .cindex "Exim arguments, logging"
33940 &%arguments%&: This causes Exim to write the arguments with which it was called
33941 to the main log, preceded by the current working directory. This is a debugging
33942 feature, added to make it easier to find out how certain MUAs call
33943 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33944 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33945 that are empty or that contain white space are quoted. Non-printing characters
33946 are shown as escape sequences. This facility cannot log unrecognized arguments,
33947 because the arguments are checked before the configuration file is read. The
33948 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33949 between the caller and Exim.
33950 .next
33951 .cindex "log" "connection rejections"
33952 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33953 connection is rejected, for whatever reason.
33954 .next
33955 .cindex "log" "delayed delivery"
33956 .cindex "delayed delivery, logging"
33957 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33958 started for an incoming message because the load is too high or too many
33959 messages were received on one connection. Logging does not occur if no delivery
33960 process is started because &%queue_only%& is set or &%-odq%& was used.
33961 .next
33962 .cindex "log" "delivery duration"
33963 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33964 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33965 .next
33966 .cindex "log" "message size on delivery"
33967 .cindex "size" "of message"
33968 &%delivery_size%&: For each delivery, the size of message delivered is added to
33969 the &"=>"& line, tagged with S=.
33970 .next
33971 .cindex "log" "dnslist defer"
33972 .cindex "DNS list" "logging defer"
33973 .cindex "black list (DNS)"
33974 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33975 DNS black list suffers a temporary error.
33976 .next
33977 .cindex "log" "ETRN commands"
33978 .cindex "ETRN" "logging"
33979 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33980 is run to determine whether or not it is actually accepted. An invalid ETRN
33981 command, or one received within a message transaction is not logged by this
33982 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33983 .next
33984 .cindex "log" "host lookup failure"
33985 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33986 any addresses, or when a lookup of an IP address fails to find a host name, a
33987 log line is written. This logging does not apply to direct DNS lookups when
33988 routing email addresses, but it does apply to &"byname"& lookups.
33989 .next
33990 .cindex "log" "ident timeout"
33991 .cindex "RFC 1413" "logging timeout"
33992 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33993 client's ident port times out.
33994 .next
33995 .cindex "log" "incoming interface"
33996 .cindex "interface" "logging"
33997 &%incoming_interface%&: The interface on which a message was received is added
33998 to the &"<="& line as an IP address in square brackets, tagged by I= and
33999 followed by a colon and the port number. The local interface and port are also
34000 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34001 rejection lines.
34002 .next
34003 .cindex "log" "incoming remote port"
34004 .cindex "port" "logging remote"
34005 .cindex "TCP/IP" "logging incoming remote port"
34006 .vindex "&$sender_fullhost$&"
34007 .vindex "&$sender_rcvhost$&"
34008 &%incoming_port%&: The remote port number from which a message was received is
34009 added to log entries and &'Received:'& header lines, following the IP address
34010 in square brackets, and separated from it by a colon. This is implemented by
34011 changing the value that is put in the &$sender_fullhost$& and
34012 &$sender_rcvhost$& variables. Recording the remote port number has become more
34013 important with the widening use of NAT (see RFC 2505).
34014 .next
34015 .cindex "log" "dropped connection"
34016 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34017 connection is unexpectedly dropped.
34018 .next
34019 .cindex "log" "outgoing remote port"
34020 .cindex "port" "logging outgoint remote"
34021 .cindex "TCP/IP" "logging ougtoing remote port"
34022 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34023 containing => tags) following the IP address. This option is not included in
34024 the default setting, because for most ordinary configurations, the remote port
34025 number is always 25 (the SMTP port).
34026 .next
34027 .cindex "log" "process ids in"
34028 .cindex "pid (process id)" "in log lines"
34029 &%pid%&: The current process id is added to every log line, in square brackets,
34030 immediately after the time and date.
34031 .next
34032 .cindex "log" "queue run"
34033 .cindex "queue runner" "logging"
34034 &%queue_run%&: The start and end of every queue run are logged.
34035 .next
34036 .cindex "log" "queue time"
34037 &%queue_time%&: The amount of time the message has been in the queue on the
34038 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34039 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34040 includes reception time as well as the delivery time for the current address.
34041 This means that it may be longer than the difference between the arrival and
34042 delivery log line times, because the arrival log line is not written until the
34043 message has been successfully received.
34044 .next
34045 &%queue_time_overall%&: The amount of time the message has been in the queue on
34046 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34047 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34048 message, so it includes reception time as well as the total delivery time.
34049 .next
34050 .cindex "log" "recipients"
34051 &%received_recipients%&: The recipients of a message are listed in the main log
34052 as soon as the message is received. The list appears at the end of the log line
34053 that is written when a message is received, preceded by the word &"for"&. The
34054 addresses are listed after they have been qualified, but before any rewriting
34055 has taken place.
34056 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34057 in the list.
34058 .next
34059 .cindex "log" "sender reception"
34060 &%received_sender%&: The unrewritten original sender of a message is added to
34061 the end of the log line that records the message's arrival, after the word
34062 &"from"& (before the recipients if &%received_recipients%& is also set).
34063 .next
34064 .cindex "log" "header lines for rejection"
34065 &%rejected_header%&: If a message's header has been received at the time a
34066 rejection is written to the reject log, the complete header is added to the
34067 log. Header logging can be turned off individually for messages that are
34068 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34069 .next
34070 .cindex "log" "retry defer"
34071 &%retry_defer%&: A log line is written if a delivery is deferred because a
34072 retry time has not yet been reached. However, this &"retry time not reached"&
34073 message is always omitted from individual message logs after the first delivery
34074 attempt.
34075 .next
34076 .cindex "log" "return path"
34077 &%return_path_on_delivery%&: The return path that is being transmitted with
34078 the message is included in delivery and bounce lines, using the tag P=.
34079 This is omitted if no delivery actually happens, for example, if routing fails,
34080 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34081 .next
34082 .cindex "log" "sender on delivery"
34083 &%sender_on_delivery%&: The message's sender address is added to every delivery
34084 and bounce line, tagged by F= (for &"from"&).
34085 This is the original sender that was received with the message; it is not
34086 necessarily the same as the outgoing return path.
34087 .next
34088 .cindex "log" "sender verify failure"
34089 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34090 gives details of a sender verification failure is not written. Log lines for
34091 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34092 detail is lost.
34093 .next
34094 .cindex "log" "size rejection"
34095 &%size_reject%&: A log line is written whenever a message is rejected because
34096 it is too big.
34097 .next
34098 .cindex "log" "frozen messages; skipped"
34099 .cindex "frozen messages" "logging skipping"
34100 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34101 queue run because it is frozen or because another process is already delivering
34102 it.
34103 .cindex "&""spool file is locked""&"
34104 The message that is written is &"spool file is locked"&.
34105 .next
34106 .cindex "log" "smtp confirmation"
34107 .cindex "SMTP" "logging confirmation"
34108 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34109 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34110 A number of MTAs (including Exim) return an identifying string in this
34111 response.
34112 .next
34113 .cindex "log" "SMTP connections"
34114 .cindex "SMTP" "logging connections"
34115 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34116 established or closed, unless the connection is from a host that matches
34117 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34118 only when the closure is unexpected.) This applies to connections from local
34119 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34120 dropped in the middle of a message, a log line is always written, whether or
34121 not this selector is set, but otherwise nothing is written at the start and end
34122 of connections unless this selector is enabled.
34123
34124 For TCP/IP connections to an Exim daemon, the current number of connections is
34125 included in the log message for each new connection, but note that the count is
34126 reset if the daemon is restarted.
34127 Also, because connections are closed (and the closure is logged) in
34128 subprocesses, the count may not include connections that have been closed but
34129 whose termination the daemon has not yet noticed. Thus, while it is possible to
34130 match up the opening and closing of connections in the log, the value of the
34131 logged counts may not be entirely accurate.
34132 .next
34133 .cindex "log" "SMTP transaction; incomplete"
34134 .cindex "SMTP" "logging incomplete transactions"
34135 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34136 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34137 and the message sender plus any accepted recipients are included in the log
34138 line. This can provide evidence of dictionary attacks.
34139 .next
34140 .cindex "log" "non-MAIL SMTP sessions"
34141 .cindex "MAIL" "logging session without"
34142 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34143 connection terminates without having issued a MAIL command. This includes both
34144 the case when the connection is dropped, and the case when QUIT is used. It
34145 does not include cases where the connection is rejected right at the start (by
34146 an ACL, or because there are too many connections, or whatever). These cases
34147 already have their own log lines.
34148
34149 The log line that is written contains the identity of the client in the usual
34150 way, followed by D= and a time, which records the duration of the connection.
34151 If the connection was authenticated, this fact is logged exactly as it is for
34152 an incoming message, with an A= item. If the connection was encrypted, CV=,
34153 DN=, and X= items may appear as they do for an incoming message, controlled by
34154 the same logging options.
34155
34156 Finally, if any SMTP commands were issued during the connection, a C= item
34157 is added to the line, listing the commands that were used. For example,
34158 .code
34159 C=EHLO,QUIT
34160 .endd
34161 shows that the client issued QUIT straight after EHLO. If there were fewer
34162 than 20 commands, they are all listed. If there were more than 20 commands,
34163 the last 20 are listed, preceded by &"..."&. However, with the default
34164 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34165 have been aborted before 20 non-mail commands are processed.
34166 .next
34167 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34168 colon-separated, is appended to the A= item for a message arrival or delivery
34169 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34170 was accepted or used.
34171 .next
34172 .cindex "log" "SMTP protocol error"
34173 .cindex "SMTP" "logging protocol error"
34174 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34175 encountered. Exim does not have perfect detection of all protocol errors
34176 because of transmission delays and the use of pipelining. If PIPELINING has
34177 been advertised to a client, an Exim server assumes that the client will use
34178 it, and therefore it does not count &"expected"& errors (for example, RCPT
34179 received after rejecting MAIL) as protocol errors.
34180 .next
34181 .cindex "SMTP" "logging syntax errors"
34182 .cindex "SMTP" "syntax errors; logging"
34183 .cindex "SMTP" "unknown command; logging"
34184 .cindex "log" "unknown SMTP command"
34185 .cindex "log" "SMTP syntax error"
34186 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34187 encountered. An unrecognized command is treated as a syntax error. For an
34188 external connection, the host identity is given; for an internal connection
34189 using &%-bs%& the sender identification (normally the calling user) is given.
34190 .next
34191 .cindex "log" "subject"
34192 .cindex "subject, logging"
34193 &%subject%&: The subject of the message is added to the arrival log line,
34194 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34195 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34196 specifies whether characters with values greater than 127 should be logged
34197 unchanged, or whether they should be rendered as escape sequences.
34198 .next
34199 .cindex "log" "certificate verification"
34200 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34201 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34202 verified, and &`CV=no`& if not.
34203 .next
34204 .cindex "log" "TLS cipher"
34205 .cindex "TLS" "logging cipher"
34206 &%tls_cipher%&: When a message is sent or received over an encrypted
34207 connection, the cipher suite used is added to the log line, preceded by X=.
34208 .next
34209 .cindex "log" "TLS peer DN"
34210 .cindex "TLS" "logging peer DN"
34211 &%tls_peerdn%&: When a message is sent or received over an encrypted
34212 connection, and a certificate is supplied by the remote host, the peer DN is
34213 added to the log line, preceded by DN=.
34214 .next
34215 .cindex "log" "TLS SNI"
34216 .cindex "TLS" "logging SNI"
34217 &%tls_sni%&: When a message is received over an encrypted connection, and
34218 the remote host provided the Server Name Indication extension, the SNI is
34219 added to the log line, preceded by SNI=.
34220 .next
34221 .cindex "log" "DNS failure in list"
34222 &%unknown_in_list%&: This setting causes a log entry to be written when the
34223 result of a list match is failure because a DNS lookup failed.
34224 .endlist
34225
34226
34227 .section "Message log" "SECID260"
34228 .cindex "message" "log file for"
34229 .cindex "log" "message log; description of"
34230 .cindex "&_msglog_& directory"
34231 .oindex "&%preserve_message_logs%&"
34232 In addition to the general log files, Exim writes a log file for each message
34233 that it handles. The names of these per-message logs are the message ids, and
34234 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34235 message log contains copies of the log lines that apply to the message. This
34236 makes it easier to inspect the status of an individual message without having
34237 to search the main log. A message log is deleted when processing of the message
34238 is complete, unless &%preserve_message_logs%& is set, but this should be used
34239 only with great care because they can fill up your disk very quickly.
34240
34241 On a heavily loaded system, it may be desirable to disable the use of
34242 per-message logs, in order to reduce disk I/O. This can be done by setting the
34243 &%message_logs%& option false.
34244 .ecindex IIDloggen
34245
34246
34247
34248
34249 . ////////////////////////////////////////////////////////////////////////////
34250 . ////////////////////////////////////////////////////////////////////////////
34251
34252 .chapter "Exim utilities" "CHAPutils"
34253 .scindex IIDutils "utilities"
34254 A number of utility scripts and programs are supplied with Exim and are
34255 described in this chapter. There is also the Exim Monitor, which is covered in
34256 the next chapter. The utilities described here are:
34257
34258 .itable none 0 0 3  7* left  15* left  40* left
34259 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34260   "list what Exim processes are doing"
34261 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34262 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34263 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34264 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34265                                                 various criteria"
34266 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34267 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34268   "extract statistics from the log"
34269 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34270   "check address acceptance from given IP"
34271 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34272 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34273 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34274 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34275 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34276 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34277 .endtable
34278
34279 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34280 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34281 &url(http://duncanthrax.net/exilog/) for details.
34282
34283
34284
34285
34286 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34287 .cindex "&'exiwhat'&"
34288 .cindex "process, querying"
34289 .cindex "SIGUSR1"
34290 On operating systems that can restart a system call after receiving a signal
34291 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34292 a line describing what it is doing to the file &_exim-process.info_& in the
34293 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34294 processes it can find, having first emptied the file. It then waits for one
34295 second to allow the Exim processes to react before displaying the results. In
34296 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34297 send the signal to the Exim processes, so it is normally run as root.
34298
34299 &*Warning*&: This is not an efficient process. It is intended for occasional
34300 use by system administrators. It is not sensible, for example, to set up a
34301 script that sends SIGUSR1 signals to Exim processes at short intervals.
34302
34303
34304 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34305 varies in different operating systems. Not only are different options used,
34306 but the format of the output is different. For this reason, there are some
34307 system configuration options that configure exactly how &'exiwhat'& works. If
34308 it doesn't seem to be working for you, check the following compile-time
34309 options:
34310 .display
34311 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34312 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34313 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34314 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34315 .endd
34316 An example of typical output from &'exiwhat'& is
34317 .code
34318 164 daemon: -q1h, listening on port 25
34319 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34320 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34321   [10.19.42.42] (editor@ref.example)
34322 10592 handling incoming call from [192.168.243.242]
34323 10628 accepting a local non-SMTP message
34324 .endd
34325 The first number in the output line is the process number. The third line has
34326 been split here, in order to fit it on the page.
34327
34328
34329
34330 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34331 .cindex "&'exiqgrep'&"
34332 .cindex "queue" "grepping"
34333 This utility is a Perl script contributed by Matt Hubbard. It runs
34334 .code
34335 exim -bpu
34336 .endd
34337 to obtain a queue listing with undelivered recipients only, and then greps the
34338 output to select messages that match given criteria. The following selection
34339 options are available:
34340
34341 .vlist
34342 .vitem &*-f*&&~<&'regex'&>
34343 Match the sender address. The field that is tested is enclosed in angle
34344 brackets, so you can test for bounce messages with
34345 .code
34346 exiqgrep -f '^<>$'
34347 .endd
34348 .vitem &*-r*&&~<&'regex'&>
34349 Match a recipient address. The field that is tested is not enclosed in angle
34350 brackets.
34351
34352 .vitem &*-s*&&~<&'regex'&>
34353 Match against the size field.
34354
34355 .vitem &*-y*&&~<&'seconds'&>
34356 Match messages that are younger than the given time.
34357
34358 .vitem &*-o*&&~<&'seconds'&>
34359 Match messages that are older than the given time.
34360
34361 .vitem &*-z*&
34362 Match only frozen messages.
34363
34364 .vitem &*-x*&
34365 Match only non-frozen messages.
34366 .endlist
34367
34368 The following options control the format of the output:
34369
34370 .vlist
34371 .vitem &*-c*&
34372 Display only the count of matching messages.
34373
34374 .vitem &*-l*&
34375 Long format &-- display the full message information as output by Exim. This is
34376 the default.
34377
34378 .vitem &*-i*&
34379 Display message ids only.
34380
34381 .vitem &*-b*&
34382 Brief format &-- one line per message.
34383
34384 .vitem &*-R*&
34385 Display messages in reverse order.
34386 .endlist
34387
34388 There is one more option, &%-h%&, which outputs a list of options.
34389
34390
34391
34392 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34393 .cindex "&'exiqsumm'&"
34394 .cindex "queue" "summary"
34395 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34396 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34397 running a command such as
34398 .code
34399 exim -bp | exiqsumm
34400 .endd
34401 The output consists of one line for each domain that has messages waiting for
34402 it, as in the following example:
34403 .code
34404 3   2322   74m   66m  msn.com.example
34405 .endd
34406 Each line lists the number of pending deliveries for a domain, their total
34407 volume, and the length of time that the oldest and the newest messages have
34408 been waiting. Note that the number of pending deliveries is greater than the
34409 number of messages when messages have more than one recipient.
34410
34411 A summary line is output at the end. By default the output is sorted on the
34412 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34413 the output to be sorted by oldest message and by count of messages,
34414 respectively. There are also three options that split the messages for each
34415 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34416 separates frozen messages, and &%-s%& separates messages according to their
34417 sender.
34418
34419 The output of &'exim -bp'& contains the original addresses in the message, so
34420 this also applies to the output from &'exiqsumm'&. No domains from addresses
34421 generated by aliasing or forwarding are included (unless the &%one_time%&
34422 option of the &(redirect)& router has been used to convert them into &"top
34423 level"& addresses).
34424
34425
34426
34427
34428 .section "Extracting specific information from the log (exigrep)" &&&
34429          "SECTextspeinf"
34430 .cindex "&'exigrep'&"
34431 .cindex "log" "extracts; grepping for"
34432 The &'exigrep'& utility is a Perl script that searches one or more main log
34433 files for entries that match a given pattern. When it finds a match, it
34434 extracts all the log entries for the relevant message, not just those that
34435 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34436 given message, or all mail for a given user, or for a given host, for example.
34437 The input files can be in Exim log format or syslog format.
34438 If a matching log line is not associated with a specific message, it is
34439 included in &'exigrep'&'s output without any additional lines. The usage is:
34440 .display
34441 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34442 .endd
34443 If no log file names are given on the command line, the standard input is read.
34444
34445 The &%-t%& argument specifies a number of seconds. It adds an additional
34446 condition for message selection. Messages that are complete are shown only if
34447 they spent more than <&'n'&> seconds on the queue.
34448
34449 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34450 makes it case-sensitive. This may give a performance improvement when searching
34451 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34452 option; with &%-I%& they do not. In both cases it is possible to change the
34453 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34454
34455 The &%-l%& option means &"literal"&, that is, treat all characters in the
34456 pattern as standing for themselves. Otherwise the pattern must be a Perl
34457 regular expression.
34458
34459 The &%-v%& option inverts the matching condition. That is, a line is selected
34460 if it does &'not'& match the pattern.
34461
34462 If the location of a &'zcat'& command is known from the definition of
34463 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34464 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34465
34466
34467 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34468 .cindex "&'exipick'&"
34469 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34470 lists messages from the queue according to a variety of criteria. For details
34471 of &'exipick'&'s facilities, visit the web page at
34472 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34473 the &%--help%& option.
34474
34475
34476 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34477 .cindex "log" "cycling local files"
34478 .cindex "cycling logs"
34479 .cindex "&'exicyclog'&"
34480 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34481 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34482 you are using log files with datestamps in their names (see section
34483 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34484 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34485 There are two command line options for &'exicyclog'&:
34486 .ilist
34487 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34488 default that is set when Exim is built. The default default is 10.
34489 .next
34490 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34491 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34492 overriding the script's default, which is to find the setting from Exim's
34493 configuration.
34494 .endlist
34495
34496 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34497 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34498 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34499 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34500 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34501 logs are handled similarly.
34502
34503 If the limit is greater than 99, the script uses 3-digit numbers such as
34504 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34505 to one that is greater, or &'vice versa'&, you will have to fix the names of
34506 any existing log files.
34507
34508 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34509 the end are deleted. All files with numbers greater than 01 are compressed,
34510 using a compression command which is configured by the COMPRESS_COMMAND
34511 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34512 root &%crontab%& entry of the form
34513 .code
34514 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34515 .endd
34516 assuming you have used the name &"exim"& for the Exim user. You can run
34517 &'exicyclog'& as root if you wish, but there is no need.
34518
34519
34520
34521 .section "Mail statistics (eximstats)" "SECTmailstat"
34522 .cindex "statistics"
34523 .cindex "&'eximstats'&"
34524 A Perl script called &'eximstats'& is provided for extracting statistical
34525 information from log files. The output is either plain text, or HTML.
34526 Exim log files are also supported by the &'Lire'& system produced by the
34527 LogReport Foundation &url(http://www.logreport.org).
34528
34529 The &'eximstats'& script has been hacked about quite a bit over time. The
34530 latest version is the result of some extensive revision by Steve Campbell. A
34531 lot of information is given by default, but there are options for suppressing
34532 various parts of it. Following any options, the arguments to the script are a
34533 list of files, which should be main log files. For example:
34534 .code
34535 eximstats -nr /var/spool/exim/log/mainlog.01
34536 .endd
34537 By default, &'eximstats'& extracts information about the number and volume of
34538 messages received from or delivered to various hosts. The information is sorted
34539 both by message count and by volume, and the top fifty hosts in each category
34540 are listed on the standard output. Similar information, based on email
34541 addresses or domains instead of hosts can be requested by means of various
34542 options. For messages delivered and received locally, similar statistics are
34543 also produced per user.
34544
34545 The output also includes total counts and statistics about delivery errors, and
34546 histograms showing the number of messages received and deliveries made in each
34547 hour of the day. A delivery with more than one address in its envelope (for
34548 example, an SMTP transaction with more than one RCPT command) is counted
34549 as a single delivery by &'eximstats'&.
34550
34551 Though normally more deliveries than receipts are reported (as messages may
34552 have multiple recipients), it is possible for &'eximstats'& to report more
34553 messages received than delivered, even though the queue is empty at the start
34554 and end of the period in question. If an incoming message contains no valid
34555 recipients, no deliveries are recorded for it. A bounce message is handled as
34556 an entirely separate message.
34557
34558 &'eximstats'& always outputs a grand total summary giving the volume and number
34559 of messages received and deliveries made, and the number of hosts involved in
34560 each case. It also outputs the number of messages that were delayed (that is,
34561 not completely delivered at the first attempt), and the number that had at
34562 least one address that failed.
34563
34564 The remainder of the output is in sections that can be independently disabled
34565 or modified by various options. It consists of a summary of deliveries by
34566 transport, histograms of messages received and delivered per time interval
34567 (default per hour), information about the time messages spent on the queue,
34568 a list of relayed messages, lists of the top fifty sending hosts, local
34569 senders, destination hosts, and destination local users by count and by volume,
34570 and a list of delivery errors that occurred.
34571
34572 The relay information lists messages that were actually relayed, that is, they
34573 came from a remote host and were directly delivered to some other remote host,
34574 without being processed (for example, for aliasing or forwarding) locally.
34575
34576 There are quite a few options for &'eximstats'& to control exactly what it
34577 outputs. These are documented in the Perl script itself, and can be extracted
34578 by running the command &(perldoc)& on the script. For example:
34579 .code
34580 perldoc /usr/exim/bin/eximstats
34581 .endd
34582
34583 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34584 .cindex "&'exim_checkaccess'&"
34585 .cindex "policy control" "checking access"
34586 .cindex "checking access"
34587 The &%-bh%& command line argument allows you to run a fake SMTP session with
34588 debugging output, in order to check what Exim is doing when it is applying
34589 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34590 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34591 sometimes you just want to answer the question &"Does this address have
34592 access?"& without bothering with any further details.
34593
34594 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34595 two arguments, an IP address and an email address:
34596 .code
34597 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34598 .endd
34599 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34600 given email address would be accepted in a RCPT command in a TCP/IP
34601 connection from the host with the given IP address. The output of the utility
34602 is either the word &"accepted"&, or the SMTP error response, for example:
34603 .code
34604 Rejected:
34605 550 Relay not permitted
34606 .endd
34607 When running this test, the utility uses &`<>`& as the envelope sender address
34608 for the MAIL command, but you can change this by providing additional
34609 options. These are passed directly to the Exim command. For example, to specify
34610 that the test is to be run with the sender address &'himself@there.example'&
34611 you can use:
34612 .code
34613 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34614                  -f himself@there.example
34615 .endd
34616 Note that these additional Exim command line items must be given after the two
34617 mandatory arguments.
34618
34619 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34620 while running its checks. You can run checks that include callouts by using
34621 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34622
34623
34624
34625 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34626 .cindex "DBM" "building dbm files"
34627 .cindex "building DBM files"
34628 .cindex "&'exim_dbmbuild'&"
34629 .cindex "lower casing"
34630 .cindex "binary zero" "in lookup key"
34631 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34632 the format used by the &(lsearch)& lookup (see section
34633 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34634 names as keys and the remainder of the information as data. The lower-casing
34635 can be prevented by calling the program with the &%-nolc%& option.
34636
34637 A terminating zero is included as part of the key string. This is expected by
34638 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34639 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34640 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34641 files.
34642
34643 The program requires two arguments: the name of the input file (which can be a
34644 single hyphen to indicate the standard input), and the name of the output file.
34645 It creates the output under a temporary name, and then renames it if all went
34646 well.
34647
34648 .cindex "USE_DB"
34649 If the native DB interface is in use (USE_DB is set in a compile-time
34650 configuration file &-- this is common in free versions of Unix) the two file
34651 names must be different, because in this mode the Berkeley DB functions create
34652 a single output file using exactly the name given. For example,
34653 .code
34654 exim_dbmbuild /etc/aliases /etc/aliases.db
34655 .endd
34656 reads the system alias file and creates a DBM version of it in
34657 &_/etc/aliases.db_&.
34658
34659 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34660 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34661 environment, the suffixes are added to the second argument of
34662 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34663 when the Berkeley functions are used in compatibility mode (though this is not
34664 recommended), because in that case it adds a &_.db_& suffix to the file name.
34665
34666 If a duplicate key is encountered, the program outputs a warning, and when it
34667 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34668 option is used. By default, only the first of a set of duplicates is used &--
34669 this makes it compatible with &(lsearch)& lookups. There is an option
34670 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34671 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34672 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34673 return code is 2.
34674
34675
34676
34677
34678 .section "Finding individual retry times (exinext)" "SECTfinindret"
34679 .cindex "retry" "times"
34680 .cindex "&'exinext'&"
34681 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34682 fish specific information out of the retry database. Given a mail domain (or a
34683 complete address), it looks up the hosts for that domain, and outputs any retry
34684 information for the hosts or for the domain. At present, the retry information
34685 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34686 output. For example:
34687 .code
34688 $ exinext piglet@milne.fict.example
34689 kanga.milne.example:192.168.8.1 error 146: Connection refused
34690   first failed: 21-Feb-1996 14:57:34
34691   last tried:   21-Feb-1996 14:57:34
34692   next try at:  21-Feb-1996 15:02:34
34693 roo.milne.example:192.168.8.3 error 146: Connection refused
34694   first failed: 20-Jan-1996 13:12:08
34695   last tried:   21-Feb-1996 11:42:03
34696   next try at:  21-Feb-1996 19:42:03
34697   past final cutoff time
34698 .endd
34699 You can also give &'exinext'& a local part, without a domain, and it
34700 will give any retry information for that local part in your default domain.
34701 A message id can be used to obtain retry information pertaining to a specific
34702 message. This exists only when an attempt to deliver a message to a remote host
34703 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34704 &'exinext'& is not particularly efficient, but then it is not expected to be
34705 run very often.
34706
34707 The &'exinext'& utility calls Exim to find out information such as the location
34708 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34709 passed on to the &'exim'& commands. The first specifies an alternate Exim
34710 configuration file, and the second sets macros for use within the configuration
34711 file. These features are mainly to help in testing, but might also be useful in
34712 environments where more than one configuration file is in use.
34713
34714
34715
34716 .section "Hints database maintenance" "SECThindatmai"
34717 .cindex "hints database" "maintenance"
34718 .cindex "maintaining Exim's hints database"
34719 Three utility programs are provided for maintaining the DBM files that Exim
34720 uses to contain its delivery hint information. Each program requires two
34721 arguments. The first specifies the name of Exim's spool directory, and the
34722 second is the name of the database it is to operate on. These are as follows:
34723
34724 .ilist
34725 &'retry'&: the database of retry information
34726 .next
34727 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34728 for remote hosts
34729 .next
34730 &'callout'&: the callout cache
34731 .next
34732 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34733 .next
34734 &'misc'&: other hints data
34735 .endlist
34736
34737 The &'misc'& database is used for
34738
34739 .ilist
34740 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34741 .next
34742 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34743 &(smtp)& transport)
34744 .endlist
34745
34746
34747
34748 .section "exim_dumpdb" "SECID261"
34749 .cindex "&'exim_dumpdb'&"
34750 The entire contents of a database are written to the standard output by the
34751 &'exim_dumpdb'& program, which has no options or arguments other than the
34752 spool and database names. For example, to dump the retry database:
34753 .code
34754 exim_dumpdb /var/spool/exim retry
34755 .endd
34756 Two lines of output are produced for each entry:
34757 .code
34758 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34759 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34760 .endd
34761 The first item on the first line is the key of the record. It starts with one
34762 of the letters R, or T, depending on whether it refers to a routing or
34763 transport retry. For a local delivery, the next part is the local address; for
34764 a remote delivery it is the name of the remote host, followed by its failing IP
34765 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34766 transport). If the remote port is not the standard one (port 25), it is added
34767 to the IP address. Then there follows an error code, an additional error code,
34768 and a textual description of the error.
34769
34770 The three times on the second line are the time of first failure, the time of
34771 the last delivery attempt, and the computed time for the next attempt. The line
34772 ends with an asterisk if the cutoff time for the last retry rule has been
34773 exceeded.
34774
34775 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34776 consists of a host name followed by a list of ids for messages that are or were
34777 waiting to be delivered to that host. If there are a very large number for any
34778 one host, continuation records, with a sequence number added to the host name,
34779 may be seen. The data in these records is often out of date, because a message
34780 may be routed to several alternative hosts, and Exim makes no effort to keep
34781 cross-references.
34782
34783
34784
34785 .section "exim_tidydb" "SECID262"
34786 .cindex "&'exim_tidydb'&"
34787 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34788 database. If run with no options, it removes all records that are more than 30
34789 days old. The age is calculated from the date and time that the record was last
34790 updated. Note that, in the case of the retry database, it is &'not'& the time
34791 since the first delivery failure. Information about a host that has been down
34792 for more than 30 days will remain in the database, provided that the record is
34793 updated sufficiently often.
34794
34795 The cutoff date can be altered by means of the &%-t%& option, which must be
34796 followed by a time. For example, to remove all records older than a week from
34797 the retry database:
34798 .code
34799 exim_tidydb -t 7d /var/spool/exim retry
34800 .endd
34801 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34802 message ids. In the former these appear as data in records keyed by host &--
34803 they were messages that were waiting for that host &-- and in the latter they
34804 are the keys for retry information for messages that have suffered certain
34805 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34806 message ids in database records are those of messages that are still on the
34807 queue. Message ids for messages that no longer exist are removed from
34808 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34809 For the &'retry'& database, records whose keys are non-existent message ids are
34810 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34811 whenever it removes information from the database.
34812
34813 Certain records are automatically removed by Exim when they are no longer
34814 needed, but others are not. For example, if all the MX hosts for a domain are
34815 down, a retry record is created for each one. If the primary MX host comes back
34816 first, its record is removed when Exim successfully delivers to it, but the
34817 records for the others remain because Exim has not tried to use those hosts.
34818
34819 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34820 hints databases. You should do this at a quiet time of day, because it requires
34821 a database to be locked (and therefore inaccessible to Exim) while it does its
34822 work. Removing records from a DBM file does not normally make the file smaller,
34823 but all the common DBM libraries are able to re-use the space that is released.
34824 After an initial phase of increasing in size, the databases normally reach a
34825 point at which they no longer get any bigger, as long as they are regularly
34826 tidied.
34827
34828 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34829 databases is likely to keep on increasing.
34830
34831
34832
34833
34834 .section "exim_fixdb" "SECID263"
34835 .cindex "&'exim_fixdb'&"
34836 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34837 Its main use is for testing Exim, but it might also be occasionally useful for
34838 getting round problems in a live system. It has no options, and its interface
34839 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34840 key of a database record can then be entered, and the data for that record is
34841 displayed.
34842
34843 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34844 except the &'retry'& database, that is the only operation that can be carried
34845 out. For the &'retry'& database, each field is output preceded by a number, and
34846 data for individual fields can be changed by typing the field number followed
34847 by new data, for example:
34848 .code
34849 > 4 951102:1000
34850 .endd
34851 resets the time of the next delivery attempt. Time values are given as a
34852 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34853 used as optional separators.
34854
34855
34856
34857
34858 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34859 .cindex "mailbox" "maintenance"
34860 .cindex "&'exim_lock'&"
34861 .cindex "locking mailboxes"
34862 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34863 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34864 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34865 a user agent while investigating a problem. The utility requires the name of
34866 the file as its first argument. If the locking is successful, the second
34867 argument is run as a command (using C's &[system()]& function); if there is no
34868 second argument, the value of the SHELL environment variable is used; if this
34869 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34870 is unlocked and the utility ends. The following options are available:
34871
34872 .vlist
34873 .vitem &%-fcntl%&
34874 Use &[fcntl()]& locking on the open mailbox.
34875
34876 .vitem &%-flock%&
34877 Use &[flock()]& locking on the open mailbox, provided the operating system
34878 supports it.
34879
34880 .vitem &%-interval%&
34881 This must be followed by a number, which is a number of seconds; it sets the
34882 interval to sleep between retries (default 3).
34883
34884 .vitem &%-lockfile%&
34885 Create a lock file before opening the mailbox.
34886
34887 .vitem &%-mbx%&
34888 Lock the mailbox using MBX rules.
34889
34890 .vitem &%-q%&
34891 Suppress verification output.
34892
34893 .vitem &%-retries%&
34894 This must be followed by a number; it sets the number of times to try to get
34895 the lock (default 10).
34896
34897 .vitem &%-restore_time%&
34898 This option causes &%exim_lock%& to restore the modified and read times to the
34899 locked file before exiting. This allows you to access a locked mailbox (for
34900 example, to take a backup copy) without disturbing the times that the user
34901 subsequently sees.
34902
34903 .vitem &%-timeout%&
34904 This must be followed by a number, which is a number of seconds; it sets a
34905 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34906 default), a non-blocking call is used.
34907
34908 .vitem &%-v%&
34909 Generate verbose output.
34910 .endlist
34911
34912 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34913 default is to create a lock file and also to use &[fcntl()]& locking on the
34914 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34915 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34916 requires that the directory containing the file be writeable. Locking by lock
34917 file does not last for ever; Exim assumes that a lock file is expired if it is
34918 more than 30 minutes old.
34919
34920 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34921 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34922 to be taken out on the open mailbox, and an exclusive lock on the file
34923 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34924 number of the mailbox file. When the locking is released, if an exclusive lock
34925 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34926
34927 The default output contains verification of the locking that takes place. The
34928 &%-v%& option causes some additional information to be given. The &%-q%& option
34929 suppresses all output except error messages.
34930
34931 A command such as
34932 .code
34933 exim_lock /var/spool/mail/spqr
34934 .endd
34935 runs an interactive shell while the file is locked, whereas
34936 .display
34937 &`exim_lock -q /var/spool/mail/spqr <<End`&
34938 <&'some commands'&>
34939 &`End`&
34940 .endd
34941 runs a specific non-interactive sequence of commands while the file is locked,
34942 suppressing all verification output. A single command can be run by a command
34943 such as
34944 .code
34945 exim_lock -q /var/spool/mail/spqr \
34946   "cp /var/spool/mail/spqr /some/where"
34947 .endd
34948 Note that if a command is supplied, it must be entirely contained within the
34949 second argument &-- hence the quotes.
34950 .ecindex IIDutils
34951
34952
34953 . ////////////////////////////////////////////////////////////////////////////
34954 . ////////////////////////////////////////////////////////////////////////////
34955
34956 .chapter "The Exim monitor" "CHAPeximon"
34957 .scindex IIDeximon "Exim monitor" "description"
34958 .cindex "X-windows"
34959 .cindex "&'eximon'&"
34960 .cindex "Local/eximon.conf"
34961 .cindex "&_exim_monitor/EDITME_&"
34962 The Exim monitor is an application which displays in an X window information
34963 about the state of Exim's queue and what Exim is doing. An admin user can
34964 perform certain operations on messages from this GUI interface; however all
34965 such facilities are also available from the command line, and indeed, the
34966 monitor itself makes use of the command line to perform any actions requested.
34967
34968
34969
34970 .section "Running the monitor" "SECID264"
34971 The monitor is started by running the script called &'eximon'&. This is a shell
34972 script that sets up a number of environment variables, and then runs the
34973 binary called &_eximon.bin_&. The default appearance of the monitor window can
34974 be changed by editing the &_Local/eximon.conf_& file created by editing
34975 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34976 parameters are for.
34977
34978 The parameters that get built into the &'eximon'& script can be overridden for
34979 a particular invocation by setting up environment variables of the same names,
34980 preceded by &`EXIMON_`&. For example, a shell command such as
34981 .code
34982 EXIMON_LOG_DEPTH=400 eximon
34983 .endd
34984 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34985 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34986 overrides the Exim log file configuration. This makes it possible to have
34987 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34988 syslog messages are routed to a file on the local host.
34989
34990 X resources can be used to change the appearance of the window in the normal
34991 way. For example, a resource setting of the form
34992 .code
34993 Eximon*background: gray94
34994 .endd
34995 changes the colour of the background to light grey rather than white. The
34996 stripcharts are drawn with both the data lines and the reference lines in
34997 black. This means that the reference lines are not visible when on top of the
34998 data. However, their colour can be changed by setting a resource called
34999 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35000 For example, if your X server is running Unix, you could set up lighter
35001 reference lines in the stripcharts by obeying
35002 .code
35003 xrdb -merge <<End
35004 Eximon*highlight: gray
35005 End
35006 .endd
35007 .cindex "admin user"
35008 In order to see the contents of messages on the queue, and to operate on them,
35009 &'eximon'& must either be run as root or by an admin user.
35010
35011 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35012 contain X11 resource parameters interpreted by the X11 library.  In addition,
35013 if the first parameter starts with the string "gdb" then it is removed and the
35014 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35015 versioned variants of gdb can be invoked).
35016
35017 The monitor's window is divided into three parts. The first contains one or
35018 more stripcharts and two action buttons, the second contains a &"tail"& of the
35019 main log file, and the third is a display of the queue of messages awaiting
35020 delivery, with two more action buttons. The following sections describe these
35021 different parts of the display.
35022
35023
35024
35025
35026 .section "The stripcharts" "SECID265"
35027 .cindex "stripchart"
35028 The first stripchart is always a count of messages on the queue. Its name can
35029 be configured by setting QUEUE_STRIPCHART_NAME in the
35030 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35031 configuration script by regular expression matches on log file entries, making
35032 it possible to display, for example, counts of messages delivered to certain
35033 hosts or using certain transports. The supplied defaults display counts of
35034 received and delivered messages, and of local and SMTP deliveries. The default
35035 period between stripchart updates is one minute; this can be adjusted by a
35036 parameter in the &_Local/eximon.conf_& file.
35037
35038 The stripchart displays rescale themselves automatically as the value they are
35039 displaying changes. There are always 10 horizontal lines in each chart; the
35040 title string indicates the value of each division when it is greater than one.
35041 For example, &"x2"& means that each division represents a value of 2.
35042
35043 It is also possible to have a stripchart which shows the percentage fullness of
35044 a particular disk partition, which is useful when local deliveries are confined
35045 to a single partition.
35046
35047 .cindex "&%statvfs%& function"
35048 This relies on the availability of the &[statvfs()]& function or equivalent in
35049 the operating system. Most, but not all versions of Unix that support Exim have
35050 this. For this particular stripchart, the top of the chart always represents
35051 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35052 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35053 &_Local/eximon.conf_& file.
35054
35055
35056
35057
35058 .section "Main action buttons" "SECID266"
35059 .cindex "size" "of monitor window"
35060 .cindex "Exim monitor" "window size"
35061 .cindex "window size"
35062 Below the stripcharts there is an action button for quitting the monitor. Next
35063 to this is another button marked &"Size"&. They are placed here so that
35064 shrinking the window to its default minimum size leaves just the queue count
35065 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35066 the window to expand to its maximum size, unless it is already at the maximum,
35067 in which case it is reduced to its minimum.
35068
35069 When expanding to the maximum, if the window cannot be fully seen where it
35070 currently is, it is moved back to where it was the last time it was at full
35071 size. When it is expanding from its minimum size, the old position is
35072 remembered, and next time it is reduced to the minimum it is moved back there.
35073
35074 The idea is that you can keep a reduced window just showing one or two
35075 stripcharts at a convenient place on your screen, easily expand it to show
35076 the full window when required, and just as easily put it back to what it was.
35077 The idea is copied from what the &'twm'& window manager does for its
35078 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35079 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35080
35081 Normally, the monitor starts up with the window at its full size, but it can be
35082 built so that it starts up with the window at its smallest size, by setting
35083 START_SMALL=yes in &_Local/eximon.conf_&.
35084
35085
35086
35087 .section "The log display" "SECID267"
35088 .cindex "log" "tail of; in monitor"
35089 The second section of the window is an area in which a display of the tail of
35090 the main log is maintained.
35091 To save space on the screen, the timestamp on each log line is shortened by
35092 removing the date and, if &%log_timezone%& is set, the timezone.
35093 The log tail is not available when the only destination for logging data is
35094 syslog, unless the syslog lines are routed to a local file whose name is passed
35095 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35096
35097 The log sub-window has a scroll bar at its lefthand side which can be used to
35098 move back to look at earlier text, and the up and down arrow keys also have a
35099 scrolling effect. The amount of log that is kept depends on the setting of
35100 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35101 to use. When this is full, the earlier 50% of data is discarded &-- this is
35102 much more efficient than throwing it away line by line. The sub-window also has
35103 a horizontal scroll bar for accessing the ends of long log lines. This is the
35104 only means of horizontal scrolling; the right and left arrow keys are not
35105 available. Text can be cut from this part of the window using the mouse in the
35106 normal way. The size of this subwindow is controlled by parameters in the
35107 configuration file &_Local/eximon.conf_&.
35108
35109 Searches of the text in the log window can be carried out by means of the ^R
35110 and ^S keystrokes, which default to a reverse and a forward search,
35111 respectively. The search covers only the text that is displayed in the window.
35112 It cannot go further back up the log.
35113
35114 The point from which the search starts is indicated by a caret marker. This is
35115 normally at the end of the text in the window, but can be positioned explicitly
35116 by pointing and clicking with the left mouse button, and is moved automatically
35117 by a successful search. If new text arrives in the window when it is scrolled
35118 back, the caret remains where it is, but if the window is not scrolled back,
35119 the caret is moved to the end of the new text.
35120
35121 Pressing ^R or ^S pops up a window into which the search text can be typed.
35122 There are buttons for selecting forward or reverse searching, for carrying out
35123 the search, and for cancelling. If the &"Search"& button is pressed, the search
35124 happens and the window remains so that further searches can be done. If the
35125 &"Return"& key is pressed, a single search is done and the window is closed. If
35126 ^C is typed the search is cancelled.
35127
35128 The searching facility is implemented using the facilities of the Athena text
35129 widget. By default this pops up a window containing both &"search"& and
35130 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35131 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35132 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35133 provided version of &%TextPop%& when the remaining parts of the text widget
35134 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35135 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35136 on these systems, at the expense of having unwanted items in the search popup
35137 window.
35138
35139
35140
35141 .section "The queue display" "SECID268"
35142 .cindex "queue" "display in monitor"
35143 The bottom section of the monitor window contains a list of all messages that
35144 are on the queue, which includes those currently being received or delivered,
35145 as well as those awaiting delivery. The size of this subwindow is controlled by
35146 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35147 at which it is updated is controlled by another parameter in the same file &--
35148 the default is 5 minutes, since queue scans can be quite expensive. However,
35149 there is an &"Update"& action button just above the display which can be used
35150 to force an update of the queue display at any time.
35151
35152 When a host is down for some time, a lot of pending mail can build up for it,
35153 and this can make it hard to deal with other messages on the queue. To help
35154 with this situation there is a button next to &"Update"& called &"Hide"&. If
35155 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35156 type anything in here and press &"Return"&, the text is added to a chain of
35157 such texts, and if every undelivered address in a message matches at least one
35158 of the texts, the message is not displayed.
35159
35160 If there is an address that does not match any of the texts, all the addresses
35161 are displayed as normal. The matching happens on the ends of addresses so, for
35162 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35163 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35164 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35165 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35166 a hide request is automatically cancelled after one hour.
35167
35168 While the dialogue box is displayed, you can't press any buttons or do anything
35169 else to the monitor window. For this reason, if you want to cut text from the
35170 queue display to use in the dialogue box, you have to do the cutting before
35171 pressing the &"Hide"& button.
35172
35173 The queue display contains, for each unhidden queued message, the length of
35174 time it has been on the queue, the size of the message, the message id, the
35175 message sender, and the first undelivered recipient, all on one line. If it is
35176 a bounce message, the sender is shown as &"<>"&. If there is more than one
35177 recipient to which the message has not yet been delivered, subsequent ones are
35178 listed on additional lines, up to a maximum configured number, following which
35179 an ellipsis is displayed. Recipients that have already received the message are
35180 not shown.
35181
35182 .cindex "frozen messages" "display"
35183 If a message is frozen, an asterisk is displayed at the left-hand side.
35184
35185 The queue display has a vertical scroll bar, and can also be scrolled by means
35186 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35187 The text searching facilities, as described above for the log window, are also
35188 available, but the caret is always moved to the end of the text when the queue
35189 display is updated.
35190
35191
35192
35193 .section "The queue menu" "SECID269"
35194 .cindex "queue" "menu in monitor"
35195 If the &%shift%& key is held down and the left button is clicked when the mouse
35196 pointer is over the text for any message, an action menu pops up, and the first
35197 line of the queue display for the message is highlighted. This does not affect
35198 any selected text.
35199
35200 If you want to use some other event for popping up the menu, you can set the
35201 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35202 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35203 value set in this parameter is a standard X event description. For example, to
35204 run eximon using &%ctrl%& rather than &%shift%& you could use
35205 .code
35206 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35207 .endd
35208 The title of the menu is the message id, and it contains entries which act as
35209 follows:
35210
35211 .ilist
35212 &'message log'&: The contents of the message log for the message are displayed
35213 in a new text window.
35214 .next
35215 &'headers'&: Information from the spool file that contains the envelope
35216 information and headers is displayed in a new text window. See chapter
35217 &<<CHAPspool>>& for a description of the format of spool files.
35218 .next
35219 &'body'&: The contents of the spool file containing the body of the message are
35220 displayed in a new text window. There is a default limit of 20,000 bytes to the
35221 amount of data displayed. This can be changed by setting the BODY_MAX
35222 option at compile time, or the EXIMON_BODY_MAX option at run time.
35223 .next
35224 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35225 delivery of the message. This causes an automatic thaw if the message is
35226 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35227 a new text window. The delivery is run in a separate process, to avoid holding
35228 up the monitor while the delivery proceeds.
35229 .next
35230 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35231 that the message be frozen.
35232 .next
35233 .cindex "thawing messages"
35234 .cindex "unfreezing messages"
35235 .cindex "frozen messages" "thawing"
35236 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35237 that the message be thawed.
35238 .next
35239 .cindex "delivery" "forcing failure"
35240 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35241 that Exim gives up trying to deliver the message. A bounce message is generated
35242 for any remaining undelivered addresses.
35243 .next
35244 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35245 that the message be deleted from the system without generating a bounce
35246 message.
35247 .next
35248 &'add recipient'&: A dialog box is displayed into which a recipient address can
35249 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35250 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35251 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35252 causes a call to Exim to be made using the &%-Mar%& option to request that an
35253 additional recipient be added to the message, unless the entry box is empty, in
35254 which case no action is taken.
35255 .next
35256 &'mark delivered'&: A dialog box is displayed into which a recipient address
35257 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35258 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35259 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35260 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35261 recipient address as already delivered, unless the entry box is empty, in which
35262 case no action is taken.
35263 .next
35264 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35265 mark all recipient addresses as already delivered.
35266 .next
35267 &'edit sender'&: A dialog box is displayed initialized with the current
35268 sender's address. Pressing RETURN causes a call to Exim to be made using the
35269 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35270 in which case no action is taken. If you want to set an empty sender (as in
35271 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35272 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35273 the address is qualified with that domain.
35274 .endlist
35275
35276 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35277 other cases when a call to Exim is made, if there is any output from Exim (in
35278 particular, if the command fails) a window containing the command and the
35279 output is displayed. Otherwise, the results of the action are normally apparent
35280 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35281 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35282 if no output is generated.
35283
35284 The queue display is automatically updated for actions such as freezing and
35285 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35286 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35287 force an update of the display after one of these actions.
35288
35289 In any text window that is displayed as result of a menu action, the normal
35290 cut-and-paste facility is available, and searching can be carried out using ^R
35291 and ^S, as described above for the log tail window.
35292 .ecindex IIDeximon
35293
35294
35295
35296
35297
35298 . ////////////////////////////////////////////////////////////////////////////
35299 . ////////////////////////////////////////////////////////////////////////////
35300
35301 .chapter "Security considerations" "CHAPsecurity"
35302 .scindex IIDsecurcon "security" "discussion of"
35303 This chapter discusses a number of issues concerned with security, some of
35304 which are also covered in other parts of this manual.
35305
35306 For reasons that this author does not understand, some people have promoted
35307 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35308 existence of this chapter in the documentation. However, the intent of the
35309 chapter is simply to describe the way Exim works in relation to certain
35310 security concerns, not to make any specific claims about the effectiveness of
35311 its security as compared with other MTAs.
35312
35313 What follows is a description of the way Exim is supposed to be. Best efforts
35314 have been made to try to ensure that the code agrees with the theory, but an
35315 absence of bugs can never be guaranteed. Any that are reported will get fixed
35316 as soon as possible.
35317
35318
35319 .section "Building a more &""hardened""& Exim" "SECID286"
35320 .cindex "security" "build-time features"
35321 There are a number of build-time options that can be set in &_Local/Makefile_&
35322 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35323 Exim administrator who does not have the root password, or by someone who has
35324 penetrated the Exim (but not the root) account. These options are as follows:
35325
35326 .ilist
35327 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35328 start of any file names used with the &%-C%& option. When it is set, these file
35329 names are also not allowed to contain the sequence &"/../"&. (However, if the
35330 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35331 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35332 default setting for &%ALT_CONFIG_PREFIX%&.
35333
35334 If the permitted configuration files are confined to a directory to
35335 which only root has access, this guards against someone who has broken
35336 into the Exim account from running a privileged Exim with an arbitrary
35337 configuration file, and using it to break into other accounts.
35338 .next
35339
35340 If a non-trusted configuration file (i.e. not the default configuration file
35341 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35342 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35343 the next item), then root privilege is retained only if the caller of Exim is
35344 root. This locks out the possibility of testing a configuration using &%-C%&
35345 right through message reception and delivery, even if the caller is root. The
35346 reception works, but by that time, Exim is running as the Exim user, so when
35347 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35348 privilege to be lost. However, root can test reception and delivery using two
35349 separate commands.
35350
35351 .next
35352 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35353 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35354 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35355 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35356 the restrictive side.  Requiring build-time selection of safe macros is onerous
35357 but this option is intended solely as a transition mechanism to permit
35358 previously-working configurations to continue to work after release 4.73.
35359 .next
35360 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35361 is disabled.
35362 .next
35363 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35364 never to be used for any deliveries. This is like the &%never_users%& runtime
35365 option, but it cannot be overridden; the runtime option adds additional users
35366 to the list. The default setting is &"root"&; this prevents a non-root user who
35367 is permitted to modify the runtime file from using Exim as a way to get root.
35368 .endlist
35369
35370
35371
35372 .section "Root privilege" "SECID270"
35373 .cindex "setuid"
35374 .cindex "root privilege"
35375 The Exim binary is normally setuid to root, which means that it gains root
35376 privilege (runs as root) when it starts execution. In some special cases (for
35377 example, when the daemon is not in use and there are no local deliveries), it
35378 may be possible to run Exim setuid to some user other than root. This is
35379 discussed in the next section. However, in most installations, root privilege
35380 is required for two things:
35381
35382 .ilist
35383 To set up a socket connected to the standard SMTP port (25) when initialising
35384 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35385 not required.
35386 .next
35387 To be able to change uid and gid in order to read users' &_.forward_& files and
35388 perform local deliveries as the receiving user or as specified in the
35389 configuration.
35390 .endlist
35391
35392 It is not necessary to be root to do any of the other things Exim does, such as
35393 receiving messages and delivering them externally over SMTP, and it is
35394 obviously more secure if Exim does not run as root except when necessary.
35395 For this reason, a user and group for Exim to use must be defined in
35396 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35397 group"&. Their values can be changed by the run time configuration, though this
35398 is not recommended. Often a user called &'exim'& is used, but some sites use
35399 &'mail'& or another user name altogether.
35400
35401 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35402 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35403 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35404
35405 After a new Exim process has interpreted its command line options, it changes
35406 uid and gid in the following cases:
35407
35408 .ilist
35409 .oindex "&%-C%&"
35410 .oindex "&%-D%&"
35411 If the &%-C%& option is used to specify an alternate configuration file, or if
35412 the &%-D%& option is used to define macro values for the configuration, and the
35413 calling process is not running as root, the uid and gid are changed to those of
35414 the calling process.
35415 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35416 option may not be used at all.
35417 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35418 can be supplied if the calling process is running as root, the Exim run-time
35419 user or CONFIGURE_OWNER, if defined.
35420 .next
35421 .oindex "&%-be%&"
35422 .oindex "&%-bf%&"
35423 .oindex "&%-bF%&"
35424 If the expansion test option (&%-be%&) or one of the filter testing options
35425 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35426 calling process.
35427 .next
35428 If the process is not a daemon process or a queue runner process or a delivery
35429 process or a process for testing address routing (started with &%-bt%&), the
35430 uid and gid are changed to the Exim user and group. This means that Exim always
35431 runs under its own uid and gid when receiving messages. This also applies when
35432 testing address verification
35433 .oindex "&%-bv%&"
35434 .oindex "&%-bh%&"
35435 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35436 option).
35437 .next
35438 For a daemon, queue runner, delivery, or address testing process, the uid
35439 remains as root at this stage, but the gid is changed to the Exim group.
35440 .endlist
35441
35442 The processes that initially retain root privilege behave as follows:
35443
35444 .ilist
35445 A daemon process changes the gid to the Exim group and the uid to the Exim
35446 user after setting up one or more listening sockets. The &[initgroups()]&
35447 function is called, so that if the Exim user is in any additional groups, they
35448 will be used during message reception.
35449 .next
35450 A queue runner process retains root privilege throughout its execution. Its
35451 job is to fork a controlled sequence of delivery processes.
35452 .next
35453 A delivery process retains root privilege throughout most of its execution,
35454 but any actual deliveries (that is, the transports themselves) are run in
35455 subprocesses which always change to a non-root uid and gid. For local
35456 deliveries this is typically the uid and gid of the owner of the mailbox; for
35457 remote deliveries, the Exim uid and gid are used. Once all the delivery
35458 subprocesses have been run, a delivery process changes to the Exim uid and gid
35459 while doing post-delivery tidying up such as updating the retry database and
35460 generating bounce and warning messages.
35461
35462 While the recipient addresses in a message are being routed, the delivery
35463 process runs as root. However, if a user's filter file has to be processed,
35464 this is done in a subprocess that runs under the individual user's uid and
35465 gid. A system filter is run as root unless &%system_filter_user%& is set.
35466 .next
35467 A process that is testing addresses (the &%-bt%& option) runs as root so that
35468 the routing is done in the same environment as a message delivery.
35469 .endlist
35470
35471
35472
35473
35474 .section "Running Exim without privilege" "SECTrunexiwitpri"
35475 .cindex "privilege, running without"
35476 .cindex "unprivileged running"
35477 .cindex "root privilege" "running without"
35478 Some installations like to run Exim in an unprivileged state for more of its
35479 operation, for added security. Support for this mode of operation is provided
35480 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35481 gid are changed to the Exim user and group at the start of a delivery process
35482 (and also queue runner and address testing processes). This means that address
35483 routing is no longer run as root, and the deliveries themselves cannot change
35484 to any other uid.
35485
35486 .cindex SIGHUP
35487 .cindex "daemon" "restarting"
35488 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35489 that the daemon can still be started in the usual way, and it can respond
35490 correctly to SIGHUP because the re-invocation regains root privilege.
35491
35492 An alternative approach is to make Exim setuid to the Exim user and also setgid
35493 to the Exim group. If you do this, the daemon must be started from a root
35494 process. (Calling Exim from a root process makes it behave in the way it does
35495 when it is setuid root.) However, the daemon cannot restart itself after a
35496 SIGHUP signal because it cannot regain privilege.
35497
35498 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35499 stops Exim from trying to re-invoke itself to do a delivery after a message has
35500 been received. Such a re-invocation is a waste of resources because it has no
35501 effect.
35502
35503 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35504 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35505 to the Exim user seems a clean approach, but there is one complication:
35506
35507 In this style of operation, Exim is running with the real uid and gid set to
35508 those of the calling process, and the effective uid/gid set to Exim's values.
35509 Ideally, any association with the calling process' uid/gid should be dropped,
35510 that is, the real uid/gid should be reset to the effective values so as to
35511 discard any privileges that the caller may have. While some operating systems
35512 have a function that permits this action for a non-root effective uid, quite a
35513 number of them do not. Because of this lack of standardization, Exim does not
35514 address this problem at this time.
35515
35516 For this reason, the recommended approach for &"mostly unprivileged"& running
35517 is to keep the Exim binary setuid to root, and to set
35518 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35519 be used in the most straightforward way.
35520
35521 If you configure Exim not to run delivery processes as root, there are a
35522 number of restrictions on what you can do:
35523
35524 .ilist
35525 You can deliver only as the Exim user/group. You should  explicitly use the
35526 &%user%& and &%group%& options to override routers or local transports that
35527 normally deliver as the recipient. This makes sure that configurations that
35528 work in this mode function the same way in normal mode. Any implicit or
35529 explicit specification of another user causes an error.
35530 .next
35531 Use of &_.forward_& files is severely restricted, such that it is usually
35532 not worthwhile to include them in the configuration.
35533 .next
35534 Users who wish to use &_.forward_& would have to make their home directory and
35535 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35536 and their equivalents in Exim filters, cannot be used. While they could be
35537 enabled in the Exim user's name, that would be insecure and not very useful.
35538 .next
35539 Unless the local user mailboxes are all owned by the Exim user (possible in
35540 some POP3 or IMAP-only environments):
35541
35542 .olist
35543 They must be owned by the Exim group and be writeable by that group. This
35544 implies you must set &%mode%& in the appendfile configuration, as well as the
35545 mode of the mailbox files themselves.
35546 .next
35547 You must set &%no_check_owner%&, since most or all of the files will not be
35548 owned by the Exim user.
35549 .next
35550 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35551 on a newly created mailbox when unprivileged. This also implies that new
35552 mailboxes need to be created manually.
35553 .endlist olist
35554 .endlist ilist
35555
35556
35557 These restrictions severely restrict what can be done in local deliveries.
35558 However, there are no restrictions on remote deliveries. If you are running a
35559 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35560 gives more security at essentially no cost.
35561
35562 If you are using the &%mua_wrapper%& facility (see chapter
35563 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35564
35565
35566
35567
35568 .section "Delivering to local files" "SECID271"
35569 Full details of the checks applied by &(appendfile)& before it writes to a file
35570 are given in chapter &<<CHAPappendfile>>&.
35571
35572
35573
35574 .section "IPv4 source routing" "SECID272"
35575 .cindex "source routing" "in IP packets"
35576 .cindex "IP source routing"
35577 Many operating systems suppress IP source-routed packets in the kernel, but
35578 some cannot be made to do this, so Exim does its own check. It logs incoming
35579 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35580 IPv6. No special checking is currently done.
35581
35582
35583
35584 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35585 Support for these SMTP commands is disabled by default. If required, they can
35586 be enabled by defining suitable ACLs.
35587
35588
35589
35590
35591 .section "Privileged users" "SECID274"
35592 .cindex "trusted users"
35593 .cindex "admin user"
35594 .cindex "privileged user"
35595 .cindex "user" "trusted"
35596 .cindex "user" "admin"
35597 Exim recognizes two sets of users with special privileges. Trusted users are
35598 able to submit new messages to Exim locally, but supply their own sender
35599 addresses and information about a sending host. For other users submitting
35600 local messages, Exim sets up the sender address from the uid, and doesn't
35601 permit a remote host to be specified.
35602
35603 .oindex "&%-f%&"
35604 However, an untrusted user is permitted to use the &%-f%& command line option
35605 in the special form &%-f <>%& to indicate that a delivery failure for the
35606 message should not cause an error report. This affects the message's envelope,
35607 but it does not affect the &'Sender:'& header. Untrusted users may also be
35608 permitted to use specific forms of address with the &%-f%& option by setting
35609 the &%untrusted_set_sender%& option.
35610
35611 Trusted users are used to run processes that receive mail messages from some
35612 other mail domain and pass them on to Exim for delivery either locally, or over
35613 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35614 as any user listed in the &%trusted_users%& configuration option, or under any
35615 group listed in the &%trusted_groups%& option.
35616
35617 Admin users are permitted to do things to the messages on Exim's queue. They
35618 can freeze or thaw messages, cause them to be returned to their senders, remove
35619 them entirely, or modify them in various ways. In addition, admin users can run
35620 the Exim monitor and see all the information it is capable of providing, which
35621 includes the contents of files on the spool.
35622
35623 .oindex "&%-M%&"
35624 .oindex "&%-q%&"
35625 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35626 delivery of messages on its queue is restricted to admin users. This
35627 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35628 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35629 queue is also restricted to admin users. This restriction can be relaxed by
35630 setting &%no_queue_list_requires_admin%&.
35631
35632 Exim recognizes an admin user if the calling process is running as root or as
35633 the Exim user or if any of the groups associated with the calling process is
35634 the Exim group. It is not necessary actually to be running under the Exim
35635 group. However, if admin users who are not root or the Exim user are to access
35636 the contents of files on the spool via the Exim monitor (which runs
35637 unprivileged), Exim must be built to allow group read access to its spool
35638 files.
35639
35640
35641
35642 .section "Spool files" "SECID275"
35643 .cindex "spool directory" "files"
35644 Exim's spool directory and everything it contains is owned by the Exim user and
35645 set to the Exim group. The mode for spool files is defined in the
35646 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35647 any user who is a member of the Exim group can access these files.
35648
35649
35650
35651 .section "Use of argv[0]" "SECID276"
35652 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35653 of specific strings, Exim assumes certain options. For example, calling Exim
35654 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35655 to calling it with the option &%-bS%&. There are no security implications in
35656 this.
35657
35658
35659
35660 .section "Use of %f formatting" "SECID277"
35661 The only use made of &"%f"& by Exim is in formatting load average values. These
35662 are actually stored in integer variables as 1000 times the load average.
35663 Consequently, their range is limited and so therefore is the length of the
35664 converted output.
35665
35666
35667
35668 .section "Embedded Exim path" "SECID278"
35669 Exim uses its own path name, which is embedded in the code, only when it needs
35670 to re-exec in order to regain root privilege. Therefore, it is not root when it
35671 does so. If some bug allowed the path to get overwritten, it would lead to an
35672 arbitrary program's being run as exim, not as root.
35673
35674
35675
35676 .section "Dynamic module directory" "SECTdynmoddir"
35677 Any dynamically loadable modules must be installed into the directory
35678 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35679 loading it.
35680
35681
35682 .section "Use of sprintf()" "SECID279"
35683 .cindex "&[sprintf()]&"
35684 A large number of occurrences of &"sprintf"& in the code are actually calls to
35685 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35686 The intermediate formatting is done into a large fixed buffer by a function
35687 that runs through the format string itself, and checks the length of each
35688 conversion before performing it, thus preventing buffer overruns.
35689
35690 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35691 the output buffer is known to be sufficiently long to contain the converted
35692 string.
35693
35694
35695
35696 .section "Use of debug_printf() and log_write()" "SECID280"
35697 Arbitrary strings are passed to both these functions, but they do their
35698 formatting by calling the function &'string_vformat()'&, which runs through
35699 the format string itself, and checks the length of each conversion.
35700
35701
35702
35703 .section "Use of strcat() and strcpy()" "SECID281"
35704 These are used only in cases where the output buffer is known to be large
35705 enough to hold the result.
35706 .ecindex IIDsecurcon
35707
35708
35709
35710
35711 . ////////////////////////////////////////////////////////////////////////////
35712 . ////////////////////////////////////////////////////////////////////////////
35713
35714 .chapter "Format of spool files" "CHAPspool"
35715 .scindex IIDforspo1 "format" "spool files"
35716 .scindex IIDforspo2 "spool directory" "format of files"
35717 .scindex IIDforspo3 "spool files" "format of"
35718 .cindex "spool files" "editing"
35719 A message on Exim's queue consists of two files, whose names are the message id
35720 followed by -D and -H, respectively. The data portion of the message is kept in
35721 the -D file on its own. The message's envelope, status, and headers are all
35722 kept in the -H file, whose format is described in this chapter. Each of these
35723 two files contains the final component of its own name as its first line. This
35724 is insurance against disk crashes where the directory is lost but the files
35725 themselves are recoverable.
35726
35727 Some people are tempted into editing -D files in order to modify messages. You
35728 need to be extremely careful if you do this; it is not recommended and you are
35729 on your own if you do it. Here are some of the pitfalls:
35730
35731 .ilist
35732 You must ensure that Exim does not try to deliver the message while you are
35733 fiddling with it. The safest way is to take out a write lock on the -D file,
35734 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35735 place, the lock will be retained. If you write a new file and rename it, the
35736 lock will be lost at the instant of rename.
35737 .next
35738 .vindex "&$body_linecount$&"
35739 If you change the number of lines in the file, the value of
35740 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35741 present, this value is not used by Exim, but there is no guarantee that this
35742 will always be the case.
35743 .next
35744 If the message is in MIME format, you must take care not to break it.
35745 .next
35746 If the message is cryptographically signed, any change will invalidate the
35747 signature.
35748 .endlist
35749 All in all, modifying -D files is fraught with danger.
35750
35751 Files whose names end with -J may also be seen in the &_input_& directory (or
35752 its subdirectories when &%split_spool_directory%& is set). These are journal
35753 files, used to record addresses to which the message has been delivered during
35754 the course of a delivery attempt. If there are still undelivered recipients at
35755 the end, the -H file is updated, and the -J file is deleted. If, however, there
35756 is some kind of crash (for example, a power outage) before this happens, the -J
35757 file remains in existence. When Exim next processes the message, it notices the
35758 -J file and uses it to update the -H file before starting the next delivery
35759 attempt.
35760
35761 .section "Format of the -H file" "SECID282"
35762 .cindex "uid (user id)" "in spool file"
35763 .cindex "gid (group id)" "in spool file"
35764 The second line of the -H file contains the login name for the uid of the
35765 process that called Exim to read the message, followed by the numerical uid and
35766 gid. For a locally generated message, this is normally the user who sent the
35767 message. For a message received over TCP/IP via the daemon, it is
35768 normally the Exim user.
35769
35770 The third line of the file contains the address of the message's sender as
35771 transmitted in the envelope, contained in angle brackets. The sender address is
35772 empty for bounce messages. For incoming SMTP mail, the sender address is given
35773 in the MAIL command. For locally generated mail, the sender address is
35774 created by Exim from the login name of the current user and the configured
35775 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35776 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35777 &"<>"& or an address that matches &%untrusted_set_senders%&.
35778
35779 The fourth line contains two numbers. The first is the time that the message
35780 was received, in the conventional Unix form &-- the number of seconds since the
35781 start of the epoch. The second number is a count of the number of messages
35782 warning of delayed delivery that have been sent to the sender.
35783
35784 There follow a number of lines starting with a hyphen. These can appear in any
35785 order, and are omitted when not relevant:
35786
35787 .vlist
35788 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35789 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35790 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35791 recognized, to provide backward compatibility. In the old format, a line of
35792 this form is present for every ACL variable that is not empty. The number
35793 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35794 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35795 the data string for the variable. The string itself starts at the beginning of
35796 the next line, and is followed by a newline character. It may contain internal
35797 newlines.
35798
35799 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35800 A line of this form is present for every ACL connection variable that is
35801 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35802 The length is the length of the data string for the variable. The string itself
35803 starts at the beginning of the next line, and is followed by a newline
35804 character. It may contain internal newlines.
35805
35806 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35807 A line of this form is present for every ACL message variable that is defined.
35808 Note that there is a space between &%-aclm%& and the rest of the name. The
35809 length is the length of the data string for the variable. The string itself
35810 starts at the beginning of the next line, and is followed by a newline
35811 character. It may contain internal newlines.
35812
35813 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35814 This is present if, when the message was received over SMTP, the value of
35815 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35816
35817 .vitem &%-allow_unqualified_recipient%&
35818 This is present if unqualified recipient addresses are permitted in header
35819 lines (to stop such addresses from being qualified if rewriting occurs at
35820 transport time). Local messages that were input using &%-bnq%& and remote
35821 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35822
35823 .vitem &%-allow_unqualified_sender%&
35824 This is present if unqualified sender addresses are permitted in header lines
35825 (to stop such addresses from being qualified if rewriting occurs at transport
35826 time). Local messages that were input using &%-bnq%& and remote messages from
35827 hosts that match &%sender_unqualified_hosts%& set this flag.
35828
35829 .vitem "&%-auth_id%&&~<&'text'&>"
35830 The id information for a message received on an authenticated SMTP connection
35831 &-- the value of the &$authenticated_id$& variable.
35832
35833 .vitem "&%-auth_sender%&&~<&'address'&>"
35834 The address of an authenticated sender &-- the value of the
35835 &$authenticated_sender$& variable.
35836
35837 .vitem "&%-body_linecount%&&~<&'number'&>"
35838 This records the number of lines in the body of the message, and is always
35839 present.
35840
35841 .vitem "&%-body_zerocount%&&~<&'number'&>"
35842 This records the number of binary zero bytes in the body of the message, and is
35843 present if the number is greater than zero.
35844
35845 .vitem &%-deliver_firsttime%&
35846 This is written when a new message is first added to the spool. When the spool
35847 file is updated after a deferral, it is omitted.
35848
35849 .vitem "&%-frozen%&&~<&'time'&>"
35850 .cindex "frozen messages" "spool data"
35851 The message is frozen, and the freezing happened at <&'time'&>.
35852
35853 .vitem "&%-helo_name%&&~<&'text'&>"
35854 This records the host name as specified by a remote host in a HELO or EHLO
35855 command.
35856
35857 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35858 This records the IP address of the host from which the message was received and
35859 the remote port number that was used. It is omitted for locally generated
35860 messages.
35861
35862 .vitem "&%-host_auth%&&~<&'text'&>"
35863 If the message was received on an authenticated SMTP connection, this records
35864 the name of the authenticator &-- the value of the
35865 &$sender_host_authenticated$& variable.
35866
35867 .vitem &%-host_lookup_failed%&
35868 This is present if an attempt to look up the sending host's name from its IP
35869 address failed. It corresponds to the &$host_lookup_failed$& variable.
35870
35871 .vitem "&%-host_name%&&~<&'text'&>"
35872 .cindex "reverse DNS lookup"
35873 .cindex "DNS" "reverse lookup"
35874 This records the name of the remote host from which the message was received,
35875 if the host name was looked up from the IP address when the message was being
35876 received. It is not present if no reverse lookup was done.
35877
35878 .vitem "&%-ident%&&~<&'text'&>"
35879 For locally submitted messages, this records the login of the originating user,
35880 unless it was a trusted user and the &%-oMt%& option was used to specify an
35881 ident value. For messages received over TCP/IP, this records the ident string
35882 supplied by the remote host, if any.
35883
35884 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35885 This records the IP address of the local interface and the port number through
35886 which a message was received from a remote host. It is omitted for locally
35887 generated messages.
35888
35889 .vitem &%-local%&
35890 The message is from a local sender.
35891
35892 .vitem &%-localerror%&
35893 The message is a locally-generated bounce message.
35894
35895 .vitem "&%-local_scan%&&~<&'string'&>"
35896 This records the data string that was returned by the &[local_scan()]& function
35897 when the message was received &-- the value of the &$local_scan_data$&
35898 variable. It is omitted if no data was returned.
35899
35900 .vitem &%-manual_thaw%&
35901 The message was frozen but has been thawed manually, that is, by an explicit
35902 Exim command rather than via the auto-thaw process.
35903
35904 .vitem &%-N%&
35905 A testing delivery process was started using the &%-N%& option to suppress any
35906 actual deliveries, but delivery was deferred. At any further delivery attempts,
35907 &%-N%& is assumed.
35908
35909 .vitem &%-received_protocol%&
35910 This records the value of the &$received_protocol$& variable, which contains
35911 the name of the protocol by which the message was received.
35912
35913 .vitem &%-sender_set_untrusted%&
35914 The envelope sender of this message was set by an untrusted local caller (used
35915 to ensure that the caller is displayed in queue listings).
35916
35917 .vitem "&%-spam_score_int%&&~<&'number'&>"
35918 If a message was scanned by SpamAssassin, this is present. It records the value
35919 of &$spam_score_int$&.
35920
35921 .vitem &%-tls_certificate_verified%&
35922 A TLS certificate was received from the client that sent this message, and the
35923 certificate was verified by the server.
35924
35925 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35926 When the message was received over an encrypted connection, this records the
35927 name of the cipher suite that was used.
35928
35929 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35930 When the message was received over an encrypted connection, and a certificate
35931 was received from the client, this records the Distinguished Name from that
35932 certificate.
35933 .endlist
35934
35935 Following the options there is a list of those addresses to which the message
35936 is not to be delivered. This set of addresses is initialized from the command
35937 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35938 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35939 the address is added to this set. The addresses are kept internally as a
35940 balanced binary tree, and it is a representation of that tree which is written
35941 to the spool file. If an address is expanded via an alias or forward file, the
35942 original address is added to the tree when deliveries to all its child
35943 addresses are complete.
35944
35945 If the tree is empty, there is a single line in the spool file containing just
35946 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35947 Y or N, followed by an address. The address is the value for the node of the
35948 tree, and the letters indicate whether the node has a left branch and/or a
35949 right branch attached to it, respectively. If branches exist, they immediately
35950 follow. Here is an example of a three-node tree:
35951 .code
35952 YY darcy@austen.fict.example
35953 NN alice@wonderland.fict.example
35954 NN editor@thesaurus.ref.example
35955 .endd
35956 After the non-recipients tree, there is a list of the message's recipients.
35957 This is a simple list, preceded by a count. It includes all the original
35958 recipients of the message, including those to whom the message has already been
35959 delivered. In the simplest case, the list contains one address per line. For
35960 example:
35961 .code
35962 4
35963 editor@thesaurus.ref.example
35964 darcy@austen.fict.example
35965 rdo@foundation
35966 alice@wonderland.fict.example
35967 .endd
35968 However, when a child address has been added to the top-level addresses as a
35969 result of the use of the &%one_time%& option on a &(redirect)& router, each
35970 line is of the following form:
35971 .display
35972 <&'top-level address'&> <&'errors_to address'&> &&&
35973   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35974 .endd
35975 The 01 flag bit indicates the presence of the three other fields that follow
35976 the top-level address. Other bits may be used in future to support additional
35977 fields. The <&'parent number'&> is the offset in the recipients list of the
35978 original parent of the &"one time"& address. The first two fields are the
35979 envelope sender that is associated with this address and its length. If the
35980 length is zero, there is no special envelope sender (there are then two space
35981 characters in the line). A non-empty field can arise from a &(redirect)& router
35982 that has an &%errors_to%& setting.
35983
35984
35985 A blank line separates the envelope and status information from the headers
35986 which follow. A header may occupy several lines of the file, and to save effort
35987 when reading it in, each header is preceded by a number and an identifying
35988 character. The number is the number of characters in the header, including any
35989 embedded newlines and the terminating newline. The character is one of the
35990 following:
35991
35992 .table2 50pt
35993 .row <&'blank'&>         "header in which Exim has no special interest"
35994 .row &`B`&               "&'Bcc:'& header"
35995 .row &`C`&               "&'Cc:'& header"
35996 .row &`F`&               "&'From:'& header"
35997 .row &`I`&               "&'Message-id:'& header"
35998 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35999 .row &`R`&               "&'Reply-To:'& header"
36000 .row &`S`&               "&'Sender:'& header"
36001 .row &`T`&               "&'To:'& header"
36002 .row &`*`&               "replaced or deleted header"
36003 .endtable
36004
36005 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36006 purposes. They are not transmitted when the message is delivered. Here is a
36007 typical set of headers:
36008 .code
36009 111P Received: by hobbit.fict.example with local (Exim 4.00)
36010 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36011 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36012 038* X-rewrote-sender: bb@hobbit.fict.example
36013 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36014 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36015 099* To: alice@wonderland.fict.example, rdo@foundation,
36016 darcy@austen.fict.example, editor@thesaurus.ref.example
36017 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36018 darcy@austen.fict.example, editor@thesaurus.ref.example
36019 038  Date: Fri, 11 May 2001 10:28:59 +0100
36020 .endd
36021 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36022 &'To:'& header have been rewritten, the last one because routing expanded the
36023 unqualified domain &'foundation'&.
36024 .ecindex IIDforspo1
36025 .ecindex IIDforspo2
36026 .ecindex IIDforspo3
36027
36028 . ////////////////////////////////////////////////////////////////////////////
36029 . ////////////////////////////////////////////////////////////////////////////
36030
36031 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36032          "DKIM Support"
36033 .cindex "DKIM"
36034
36035 DKIM is a mechanism by which messages sent by some entity can be provably
36036 linked to a domain which that entity controls.  It permits reputation to
36037 be tracked on a per-domain basis, rather than merely upon source IP address.
36038 DKIM is documented in RFC 4871.
36039
36040 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36041 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36042
36043 Exim's DKIM implementation allows to
36044 .olist
36045 Sign outgoing messages: This function is implemented in the SMTP transport.
36046 It can co-exist with all other Exim features, including transport filters.
36047 .next
36048 Verify signatures in incoming messages: This is implemented by an additional
36049 ACL (acl_smtp_dkim), which can be called several times per message, with
36050 different signature contexts.
36051 .endlist
36052
36053 In typical Exim style, the verification implementation does not include any
36054 default "policy". Instead it enables you to build your own policy using
36055 Exim's standard controls.
36056
36057 Please note that verification of DKIM signatures in incoming mail is turned
36058 on by default for logging purposes. For each signature in incoming email,
36059 exim will log a line displaying the most important signature details, and the
36060 signature status. Here is an example (with line-breaks added for clarity):
36061 .code
36062 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36063     d=facebookmail.com s=q1-2009b
36064     c=relaxed/relaxed a=rsa-sha1
36065     i=@facebookmail.com t=1252484542 [verification succeeded]
36066 .endd
36067 You might want to turn off DKIM verification processing entirely for internal
36068 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36069 control modifier. This should typically be done in the RCPT ACL, at points
36070 where you accept mail from relay sources (internal hosts or authenticated
36071 senders).
36072
36073
36074 .section "Signing outgoing messages" "SECID513"
36075 .cindex "DKIM" "signing"
36076
36077 Signing is implemented by setting private options on the SMTP transport.
36078 These options take (expandable) strings as arguments.
36079
36080 .option dkim_domain smtp string&!! unset
36081 MANDATORY:
36082 The domain you want to sign with. The result of this expanded
36083 option is put into the &%$dkim_domain%& expansion variable.
36084
36085 .option dkim_selector smtp string&!! unset
36086 MANDATORY:
36087 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36088 variable to look up a matching selector. The result is put in the expansion
36089 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36090 option along with &%$dkim_domain%&.
36091
36092 .option dkim_private_key smtp string&!! unset
36093 MANDATORY:
36094 This sets the private key to use. You can use the &%$dkim_domain%& and
36095 &%$dkim_selector%& expansion variables to determine the private key to use.
36096 The result can either
36097 .ilist
36098 be a valid RSA private key in ASCII armor, including line breaks.
36099 .next
36100 start with a slash, in which case it is treated as a file that contains
36101 the private key.
36102 .next
36103 be "0", "false" or the empty string, in which case the message will not
36104 be signed. This case will not result in an error, even if &%dkim_strict%&
36105 is set.
36106 .endlist
36107
36108 .option dkim_canon smtp string&!! unset
36109 OPTIONAL:
36110 This option sets the canonicalization method used when signing a message.
36111 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36112 The option defaults to "relaxed" when unset. Note: the current implementation
36113 only supports using the same canonicalization method for both headers and body.
36114
36115 .option dkim_strict smtp string&!! unset
36116 OPTIONAL:
36117 This  option  defines  how  Exim  behaves  when  signing a message that
36118 should be signed fails for some reason.  When the expansion evaluates to
36119 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36120 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36121 variables here.
36122
36123 .option dkim_sign_headers smtp string&!! unset
36124 OPTIONAL:
36125 When set, this option must expand to (or be specified as) a colon-separated
36126 list of header names. Headers with these names will be included in the message
36127 signature. When unspecified, the header names recommended in RFC4871 will be
36128 used.
36129
36130
36131 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36132 .cindex "DKIM" "verification"
36133
36134 Verification of DKIM signatures in incoming email is implemented via the
36135 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36136 syntactically(!) correct signature in the incoming message.
36137
36138 To evaluate the signature in the ACL a large number of expansion variables
36139 containing the signature status and its details are set up during the
36140 runtime of the ACL.
36141
36142 Calling the ACL only for existing signatures is not sufficient to build
36143 more advanced policies. For that reason, the global option
36144 &%dkim_verify_signers%&, and a global expansion variable
36145 &%$dkim_signers%& exist.
36146
36147 The global option &%dkim_verify_signers%& can be set to a colon-separated
36148 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36149 called. It is expanded when the message has been received. At this point,
36150 the expansion variable &%$dkim_signers%& already contains a colon-separated
36151 list of signer domains and identities for the message. When
36152 &%dkim_verify_signers%& is not specified in the main configuration,
36153 it defaults as:
36154 .code
36155 dkim_verify_signers = $dkim_signers
36156 .endd
36157 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36158 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36159 call the ACL for known domains or identities. This would be achieved as follows:
36160 .code
36161 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36162 .endd
36163 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36164 and "ebay.com", plus all domains and identities that have signatures in the message.
36165 You can also be more creative in constructing your policy. For example:
36166 .code
36167 dkim_verify_signers = $sender_address_domain:$dkim_signers
36168 .endd
36169
36170 If a domain or identity is listed several times in the (expanded) value of
36171 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36172
36173
36174 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36175 available (from most to least important):
36176
36177
36178 .vlist
36179 .vitem &%$dkim_cur_signer%&
36180 The signer that is being evaluated in this ACL run. This can be a domain or
36181 an identity. This is one of the list items from the expanded main option
36182 &%dkim_verify_signers%& (see above).
36183 .vitem &%$dkim_verify_status%&
36184 A string describing the general status of the signature. One of
36185 .ilist
36186 &%none%&: There is no signature in the message for the current domain or
36187 identity (as reflected by &%$dkim_cur_signer%&).
36188 .next
36189 &%invalid%&: The signature could not be verified due to a processing error.
36190 More detail is available in &%$dkim_verify_reason%&.
36191 .next
36192 &%fail%&: Verification of the signature failed.  More detail is
36193 available in &%$dkim_verify_reason%&.
36194 .next
36195 &%pass%&: The signature passed verification. It is valid.
36196 .endlist
36197 .vitem &%$dkim_verify_reason%&
36198 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36199 "fail" or "invalid". One of
36200 .ilist
36201 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36202 key for the domain could not be retrieved. This may be a temporary problem.
36203 .next
36204 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36205 record for the domain is syntactically invalid.
36206 .next
36207 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36208 body hash does not match the one specified in the signature header. This
36209 means that the message body was modified in transit.
36210 .next
36211 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36212 could not be verified. This may mean that headers were modified,
36213 re-written or otherwise changed in a way which is incompatible with
36214 DKIM verification. It may of course also mean that the signature is forged.
36215 .endlist
36216 .vitem &%$dkim_domain%&
36217 The signing domain. IMPORTANT: This variable is only populated if there is
36218 an actual signature in the message for the current domain or identity (as
36219 reflected by &%$dkim_cur_signer%&).
36220 .vitem &%$dkim_identity%&
36221 The signing identity, if present. IMPORTANT: This variable is only populated
36222 if there is an actual signature in the message for the current domain or
36223 identity (as reflected by &%$dkim_cur_signer%&).
36224 .vitem &%$dkim_selector%&
36225 The key record selector string.
36226 .vitem &%$dkim_algo%&
36227 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36228 .vitem &%$dkim_canon_body%&
36229 The body canonicalization method. One of 'relaxed' or 'simple'.
36230 .vitem &%dkim_canon_headers%&
36231 The header canonicalization method. One of 'relaxed' or 'simple'.
36232 .vitem &%$dkim_copiedheaders%&
36233 A transcript of headers and their values which are included in the signature
36234 (copied from the 'z=' tag of the signature).
36235 .vitem &%$dkim_bodylength%&
36236 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36237 limit was set by the signer, "9999999999999" is returned. This makes sure
36238 that this variable always expands to an integer value.
36239 .vitem &%$dkim_created%&
36240 UNIX timestamp reflecting the date and time when the signature was created.
36241 When this was not specified by the signer, "0" is returned.
36242 .vitem &%$dkim_expires%&
36243 UNIX timestamp reflecting the date and time when the signer wants the
36244 signature to be treated as "expired". When this was not specified by the
36245 signer, "9999999999999" is returned. This makes it possible to do useful
36246 integer size comparisons against this value.
36247 .vitem &%$dkim_headernames%&
36248 A colon-separated list of names of headers included in the signature.
36249 .vitem &%$dkim_key_testing%&
36250 "1" if the key record has the "testing" flag set, "0" if not.
36251 .vitem &%$nosubdomains%&
36252 "1" if the key record forbids subdomaining, "0" otherwise.
36253 .vitem &%$dkim_key_srvtype%&
36254 Service type (tag s=) from the key record. Defaults to "*" if not specified
36255 in the key record.
36256 .vitem &%$dkim_key_granularity%&
36257 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36258 in the key record.
36259 .vitem &%$dkim_key_notes%&
36260 Notes from the key record (tag n=).
36261 .endlist
36262
36263 In addition, two ACL conditions are provided:
36264
36265 .vlist
36266 .vitem &%dkim_signers%&
36267 ACL condition that checks a colon-separated list of domains or identities
36268 for a match against the domain or identity that the ACL is currently verifying
36269 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36270 verb to a group of domains or identities. For example:
36271
36272 .code
36273 # Warn when Mail purportedly from GMail has no signature at all
36274 warn log_message = GMail sender without DKIM signature
36275      sender_domains = gmail.com
36276      dkim_signers = gmail.com
36277      dkim_status = none
36278 .endd
36279
36280 .vitem &%dkim_status%&
36281 ACL condition that checks a colon-separated list of possible DKIM verification
36282 results against the actual result of verification. This is typically used
36283 to restrict an ACL verb to a list of verification outcomes, for example:
36284
36285 .code
36286 deny message = Mail from Paypal with invalid/missing signature
36287      sender_domains = paypal.com:paypal.de
36288      dkim_signers = paypal.com:paypal.de
36289      dkim_status = none:invalid:fail
36290 .endd
36291
36292 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36293 see the documentation of the &%$dkim_verify_status%& expansion variable above
36294 for more information of what they mean.
36295 .endlist
36296
36297 . ////////////////////////////////////////////////////////////////////////////
36298 . ////////////////////////////////////////////////////////////////////////////
36299
36300 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36301          "Adding drivers or lookups"
36302 .cindex "adding drivers"
36303 .cindex "new drivers, adding"
36304 .cindex "drivers" "adding new"
36305 The following actions have to be taken in order to add a new router, transport,
36306 authenticator, or lookup type to Exim:
36307
36308 .olist
36309 Choose a name for the driver or lookup type that does not conflict with any
36310 existing name; I will use &"newdriver"& in what follows.
36311 .next
36312 Add to &_src/EDITME_& the line:
36313 .display
36314 <&'type'&>&`_NEWDRIVER=yes`&
36315 .endd
36316 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36317 code is not to be included in the binary by default, comment this line out. You
36318 should also add any relevant comments about the driver or lookup type.
36319 .next
36320 Add to &_src/config.h.defaults_& the line:
36321 .code
36322 #define <type>_NEWDRIVER
36323 .endd
36324 .next
36325 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36326 and create a table entry as is done for all the other drivers and lookup types.
36327 .next
36328 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36329 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36330 Add your &`NEWDRIVER`& to that list.
36331 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36332 simple form that most lookups have.
36333 .next
36334 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36335 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36336 driver or lookup type and add it to the definition of OBJ.
36337 .next
36338 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36339 &_src_&.
36340 .next
36341 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36342 as for other drivers and lookups.
36343 .endlist
36344
36345 Then all you need to do is write the code! A good way to start is to make a
36346 proforma by copying an existing module of the same type, globally changing all
36347 occurrences of the name, and cutting out most of the code. Note that any
36348 options you create must be listed in alphabetical order, because the tables are
36349 searched using a binary chop procedure.
36350
36351 There is a &_README_& file in each of the sub-directories of &_src_& describing
36352 the interface that is expected.
36353
36354
36355
36356
36357 . ////////////////////////////////////////////////////////////////////////////
36358 . ////////////////////////////////////////////////////////////////////////////
36359
36360 . /////////////////////////////////////////////////////////////////////////////
36361 . These lines are processing instructions for the Simple DocBook Processor that
36362 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36363 . PDFs than using xmlto and fop. They will be ignored by all other XML
36364 . processors.
36365 . /////////////////////////////////////////////////////////////////////////////
36366
36367 .literal xml
36368 <?sdop
36369   format="newpage"
36370   foot_right_recto="&chaptertitle;"
36371   foot_right_verso="&chaptertitle;"
36372 ?>
36373 .literal off
36374
36375 .makeindex "Options index"   "option"
36376 .makeindex "Variables index" "variable"
36377 .makeindex "Concept index"   "concept"
36378
36379
36380 . /////////////////////////////////////////////////////////////////////////////
36381 . /////////////////////////////////////////////////////////////////////////////