Introduce EXPERIMENTAL_DANE feature
[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.83"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
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 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$sender_domain$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
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
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCP%&
3815 .oindex "&%-MCP%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMm%&&~<&'message&~reference'&>
4225 .oindex "&%-oMm%&"
4226 .cindex "message reference" "message reference, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4228 option sets the message reference, e.g. message-id, and is logged during
4229 delivery. This is useful when some kind of audit trail is required to tie
4230 messages together. The format of the message reference is checked and will
4231 abort if the format is invalid. The option will only be accepted if exim is
4232 running in trusted mode, not as any regular user.
4233
4234 The best example of a message reference is when Exim sends a bounce message.
4235 The message reference is the message-id of the original message for which Exim
4236 is sending the bounce.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .vitem &%-X%&&~<&'logfile'&>
4640 .oindex "&%-X%&"
4641 This option is interpreted by Sendmail to cause debug information to be sent
4642 to the named file.  It is ignored by Exim.
4643 .endlist
4644
4645 .ecindex IIDclo1
4646 .ecindex IIDclo2
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . Insert a stylized DocBook comment here, to identify the end of the command
4651 . line options. This is for the benefit of the Perl script that automatically
4652 . creates a man page for the options.
4653 . ////////////////////////////////////////////////////////////////////////////
4654
4655 .literal xml
4656 <!-- === End of command line options === -->
4657 .literal off
4658
4659
4660
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666
4667 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4668          "The runtime configuration file"
4669
4670 .cindex "run time configuration"
4671 .cindex "configuration file" "general description"
4672 .cindex "CONFIGURE_FILE"
4673 .cindex "configuration file" "errors in"
4674 .cindex "error" "in configuration file"
4675 .cindex "return code" "for bad configuration"
4676 Exim uses a single run time configuration file that is read whenever an Exim
4677 binary is executed. Note that in normal operation, this happens frequently,
4678 because Exim is designed to operate in a distributed manner, without central
4679 control.
4680
4681 If a syntax error is detected while reading the configuration file, Exim
4682 writes a message on the standard error, and exits with a non-zero return code.
4683 The message is also written to the panic log. &*Note*&: Only simple syntax
4684 errors can be detected at this time. The values of any expanded options are
4685 not checked until the expansion happens, even when the expansion does not
4686 actually alter the string.
4687
4688 The name of the configuration file is compiled into the binary for security
4689 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4690 most configurations, this specifies a single file. However, it is permitted to
4691 give a colon-separated list of file names, in which case Exim uses the first
4692 existing file in the list.
4693
4694 .cindex "EXIM_USER"
4695 .cindex "EXIM_GROUP"
4696 .cindex "CONFIGURE_OWNER"
4697 .cindex "CONFIGURE_GROUP"
4698 .cindex "configuration file" "ownership"
4699 .cindex "ownership" "configuration file"
4700 The run time configuration file must be owned by root or by the user that is
4701 specified at compile time by the CONFIGURE_OWNER option (if set). The
4702 configuration file must not be world-writeable, or group-writeable unless its
4703 group is the root group or the one specified at compile time by the
4704 CONFIGURE_GROUP option.
4705
4706 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4707 to root, anybody who is able to edit the run time configuration file has an
4708 easy way to run commands as root. If you specify a user or group in the
4709 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4710 who are members of that group will trivially be able to obtain root privileges.
4711
4712 Up to Exim version 4.72, the run time configuration file was also permitted to
4713 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4714 since it offered a simple privilege escalation for any attacker who managed to
4715 compromise the Exim user account.
4716
4717 A default configuration file, which will work correctly in simple situations,
4718 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4719 defines just one file name, the installation process copies the default
4720 configuration to a new file of that name if it did not previously exist. If
4721 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4722 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4723 configuration.
4724
4725
4726
4727 .section "Using a different configuration file" "SECID40"
4728 .cindex "configuration file" "alternate"
4729 A one-off alternate configuration can be specified by the &%-C%& command line
4730 option, which may specify a single file or a list of files. However, when
4731 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4732 unless the argument for &%-C%& is identical to the built-in value from
4733 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4734 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4735 is useful mainly for checking the syntax of configuration files before
4736 installing them. No owner or group checks are done on a configuration file
4737 specified by &%-C%&, if root privilege has been dropped.
4738
4739 Even the Exim user is not trusted to specify an arbitrary configuration file
4740 with the &%-C%& option to be used with root privileges, unless that file is
4741 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4742 testing a configuration using &%-C%& right through message reception and
4743 delivery, even if the caller is root. The reception works, but by that time,
4744 Exim is running as the Exim user, so when it re-execs to regain privilege for
4745 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4746 can test reception and delivery using two separate commands (one to put a
4747 message on the queue, using &%-odq%&, and another to do the delivery, using
4748 &%-M%&).
4749
4750 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4751 prefix string with which any file named in a &%-C%& command line option must
4752 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4753 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4754 name can be used with &%-C%&.
4755
4756 One-off changes to a configuration can be specified by the &%-D%& command line
4757 option, which defines and overrides values for macros used inside the
4758 configuration file. However, like &%-C%&, the use of this option by a
4759 non-privileged user causes Exim to discard its root privilege.
4760 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4761 completely disabled, and its use causes an immediate error exit.
4762
4763 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4764 to declare certain macro names trusted, such that root privilege will not
4765 necessarily be discarded.
4766 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4767 considered safe and, if &%-D%& only supplies macros from this list, and the
4768 values are acceptable, then Exim will not give up root privilege if the caller
4769 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4770 transition mechanism and is expected to be removed in the future.  Acceptable
4771 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4772
4773 Some sites may wish to use the same Exim binary on different machines that
4774 share a file system, but to use different configuration files on each machine.
4775 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4776 looks for a file whose name is the configuration file name followed by a dot
4777 and the machine's node name, as obtained from the &[uname()]& function. If this
4778 file does not exist, the standard name is tried. This processing occurs for
4779 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4780
4781 In some esoteric situations different versions of Exim may be run under
4782 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4783 help with this. See the comments in &_src/EDITME_& for details.
4784
4785
4786
4787 .section "Configuration file format" "SECTconffilfor"
4788 .cindex "configuration file" "format of"
4789 .cindex "format" "configuration file"
4790 Exim's configuration file is divided into a number of different parts. General
4791 option settings must always appear at the start of the file. The other parts
4792 are all optional, and may appear in any order. Each part other than the first
4793 is introduced by the word &"begin"& followed by the name of the part. The
4794 optional parts are:
4795
4796 .ilist
4797 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4798 &<<CHAPACL>>&).
4799 .next
4800 .cindex "AUTH" "configuration"
4801 &'authenticators'&: Configuration settings for the authenticator drivers. These
4802 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4803 .next
4804 &'routers'&: Configuration settings for the router drivers. Routers process
4805 addresses and determine how the message is to be delivered (see chapters
4806 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4807 .next
4808 &'transports'&: Configuration settings for the transport drivers. Transports
4809 define mechanisms for copying messages to destinations (see chapters
4810 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4811 .next
4812 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4813 If there is no retry section, or if it is empty (that is, no retry rules are
4814 defined), Exim will not retry deliveries. In this situation, temporary errors
4815 are treated the same as permanent errors. Retry rules are discussed in chapter
4816 &<<CHAPretry>>&.
4817 .next
4818 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4819 when new addresses are generated during delivery. Rewriting is discussed in
4820 chapter &<<CHAPrewrite>>&.
4821 .next
4822 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4823 want to use this feature, you must set
4824 .code
4825 LOCAL_SCAN_HAS_OPTIONS=yes
4826 .endd
4827 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4828 facility are given in chapter &<<CHAPlocalscan>>&.
4829 .endlist
4830
4831 .cindex "configuration file" "leading white space in"
4832 .cindex "configuration file" "trailing white space in"
4833 .cindex "white space" "in configuration file"
4834 Leading and trailing white space in configuration lines is always ignored.
4835
4836 Blank lines in the file, and lines starting with a # character (ignoring
4837 leading white space) are treated as comments and are ignored. &*Note*&: A
4838 # character other than at the beginning of a line is not treated specially,
4839 and does not introduce a comment.
4840
4841 Any non-comment line can be continued by ending it with a backslash. Note that
4842 the general rule for white space means that trailing white space after the
4843 backslash and leading white space at the start of continuation
4844 lines is ignored. Comment lines beginning with # (but not empty lines) may
4845 appear in the middle of a sequence of continuation lines.
4846
4847 A convenient way to create a configuration file is to start from the
4848 default, which is supplied in &_src/configure.default_&, and add, delete, or
4849 change settings as required.
4850
4851 The ACLs, retry rules, and rewriting rules have their own syntax which is
4852 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4853 respectively. The other parts of the configuration file have some syntactic
4854 items in common, and these are described below, from section &<<SECTcos>>&
4855 onwards. Before that, the inclusion, macro, and conditional facilities are
4856 described.
4857
4858
4859
4860 .section "File inclusions in the configuration file" "SECID41"
4861 .cindex "inclusions in configuration file"
4862 .cindex "configuration file" "including other files"
4863 .cindex "&`.include`& in configuration file"
4864 .cindex "&`.include_if_exists`& in configuration file"
4865 You can include other files inside Exim's run time configuration file by
4866 using this syntax:
4867 .display
4868 &`.include`& <&'file name'&>
4869 &`.include_if_exists`& <&'file name'&>
4870 .endd
4871 on a line by itself. Double quotes round the file name are optional. If you use
4872 the first form, a configuration error occurs if the file does not exist; the
4873 second form does nothing for non-existent files. In all cases, an absolute file
4874 name is required.
4875
4876 Includes may be nested to any depth, but remember that Exim reads its
4877 configuration file often, so it is a good idea to keep them to a minimum.
4878 If you change the contents of an included file, you must HUP the daemon,
4879 because an included file is read only when the configuration itself is read.
4880
4881 The processing of inclusions happens early, at a physical line level, so, like
4882 comment lines, an inclusion can be used in the middle of an option setting,
4883 for example:
4884 .code
4885 hosts_lookup = a.b.c \
4886                .include /some/file
4887 .endd
4888 Include processing happens after macro processing (see below). Its effect is to
4889 process the lines of the included file as if they occurred inline where the
4890 inclusion appears.
4891
4892
4893
4894 .section "Macros in the configuration file" "SECTmacrodefs"
4895 .cindex "macro" "description of"
4896 .cindex "configuration file" "macros"
4897 If a line in the main part of the configuration (that is, before the first
4898 &"begin"& line) begins with an upper case letter, it is taken as a macro
4899 definition, and must be of the form
4900 .display
4901 <&'name'&> = <&'rest of line'&>
4902 .endd
4903 The name must consist of letters, digits, and underscores, and need not all be
4904 in upper case, though that is recommended. The rest of the line, including any
4905 continuations, is the replacement text, and has leading and trailing white
4906 space removed. Quotes are not removed. The replacement text can never end with
4907 a backslash character, but this doesn't seem to be a serious limitation.
4908
4909 Macros may also be defined between router, transport, authenticator, or ACL
4910 definitions. They may not, however, be defined within an individual driver or
4911 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4912
4913 .section "Macro substitution" "SECID42"
4914 Once a macro is defined, all subsequent lines in the file (and any included
4915 files) are scanned for the macro name; if there are several macros, the line is
4916 scanned for each in turn, in the order in which the macros are defined. The
4917 replacement text is not re-scanned for the current macro, though it is scanned
4918 for subsequently defined macros. For this reason, a macro name may not contain
4919 the name of a previously defined macro as a substring. You could, for example,
4920 define
4921 .display
4922 &`ABCD_XYZ = `&<&'something'&>
4923 &`ABCD = `&<&'something else'&>
4924 .endd
4925 but putting the definitions in the opposite order would provoke a configuration
4926 error. Macro expansion is applied to individual physical lines from the file,
4927 before checking for line continuation or file inclusion (see above). If a line
4928 consists solely of a macro name, and the expansion of the macro is empty, the
4929 line is ignored. A macro at the start of a line may turn the line into a
4930 comment line or a &`.include`& line.
4931
4932
4933 .section "Redefining macros" "SECID43"
4934 Once defined, the value of a macro can be redefined later in the configuration
4935 (or in an included file). Redefinition is specified by using &'=='& instead of
4936 &'='&. For example:
4937 .code
4938 MAC =  initial value
4939 ...
4940 MAC == updated value
4941 .endd
4942 Redefinition does not alter the order in which the macros are applied to the
4943 subsequent lines of the configuration file. It is still the same order in which
4944 the macros were originally defined. All that changes is the macro's value.
4945 Redefinition makes it possible to accumulate values. For example:
4946 .code
4947 MAC =  initial value
4948 ...
4949 MAC == MAC and something added
4950 .endd
4951 This can be helpful in situations where the configuration file is built
4952 from a number of other files.
4953
4954 .section "Overriding macro values" "SECID44"
4955 The values set for macros in the configuration file can be overridden by the
4956 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4957 used, unless called by root or the Exim user. A definition on the command line
4958 using the &%-D%& option causes all definitions and redefinitions within the
4959 file to be ignored.
4960
4961
4962
4963 .section "Example of macro usage" "SECID45"
4964 As an example of macro usage, consider a configuration where aliases are looked
4965 up in a MySQL database. It helps to keep the file less cluttered if long
4966 strings such as SQL statements are defined separately as macros, for example:
4967 .code
4968 ALIAS_QUERY = select mailbox from user where \
4969               login='${quote_mysql:$local_part}';
4970 .endd
4971 This can then be used in a &(redirect)& router setting like this:
4972 .code
4973 data = ${lookup mysql{ALIAS_QUERY}}
4974 .endd
4975 In earlier versions of Exim macros were sometimes used for domain, host, or
4976 address lists. In Exim 4 these are handled better by named lists &-- see
4977 section &<<SECTnamedlists>>&.
4978
4979
4980 .section "Conditional skips in the configuration file" "SECID46"
4981 .cindex "configuration file" "conditional skips"
4982 .cindex "&`.ifdef`&"
4983 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4984 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4985 portions of the configuration file. The processing happens whenever the file is
4986 read (that is, when an Exim binary starts to run).
4987
4988 The implementation is very simple. Instances of the first four directives must
4989 be followed by text that includes the names of one or macros. The condition
4990 that is tested is whether or not any macro substitution has taken place in the
4991 line. Thus:
4992 .code
4993 .ifdef AAA
4994 message_size_limit = 50M
4995 .else
4996 message_size_limit = 100M
4997 .endif
4998 .endd
4999 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5000 otherwise. If there is more than one macro named on the line, the condition
5001 is true if any of them are defined. That is, it is an &"or"& condition. To
5002 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5003
5004 Although you can use a macro expansion to generate one of these directives,
5005 it is not very useful, because the condition &"there was a macro substitution
5006 in this line"& will always be true.
5007
5008 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5009 to clarify complicated nestings.
5010
5011
5012
5013 .section "Common option syntax" "SECTcos"
5014 .cindex "common option syntax"
5015 .cindex "syntax of common options"
5016 .cindex "configuration file" "common option syntax"
5017 For the main set of options, driver options, and &[local_scan()]& options,
5018 each setting is on a line by itself, and starts with a name consisting of
5019 lower-case letters and underscores. Many options require a data value, and in
5020 these cases the name must be followed by an equals sign (with optional white
5021 space) and then the value. For example:
5022 .code
5023 qualify_domain = mydomain.example.com
5024 .endd
5025 .cindex "hiding configuration option values"
5026 .cindex "configuration options" "hiding value of"
5027 .cindex "options" "hiding value of"
5028 Some option settings may contain sensitive data, for example, passwords for
5029 accessing databases. To stop non-admin users from using the &%-bP%& command
5030 line option to read these values, you can precede the option settings with the
5031 word &"hide"&. For example:
5032 .code
5033 hide mysql_servers = localhost/users/admin/secret-password
5034 .endd
5035 For non-admin users, such options are displayed like this:
5036 .code
5037 mysql_servers = <value not displayable>
5038 .endd
5039 If &"hide"& is used on a driver option, it hides the value of that option on
5040 all instances of the same driver.
5041
5042 The following sections describe the syntax used for the different data types
5043 that are found in option settings.
5044
5045
5046 .section "Boolean options" "SECID47"
5047 .cindex "format" "boolean"
5048 .cindex "boolean configuration values"
5049 .oindex "&%no_%&&'xxx'&"
5050 .oindex "&%not_%&&'xxx'&"
5051 Options whose type is given as boolean are on/off switches. There are two
5052 different ways of specifying such options: with and without a data value. If
5053 the option name is specified on its own without data, the switch is turned on;
5054 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5055 boolean options may be followed by an equals sign and one of the words
5056 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5057 the following two settings have exactly the same effect:
5058 .code
5059 queue_only
5060 queue_only = true
5061 .endd
5062 The following two lines also have the same (opposite) effect:
5063 .code
5064 no_queue_only
5065 queue_only = false
5066 .endd
5067 You can use whichever syntax you prefer.
5068
5069
5070
5071
5072 .section "Integer values" "SECID48"
5073 .cindex "integer configuration values"
5074 .cindex "format" "integer"
5075 If an option's type is given as &"integer"&, the value can be given in decimal,
5076 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5077 number is assumed. Otherwise, it is treated as an octal number unless it starts
5078 with the characters &"0x"&, in which case the remainder is interpreted as a
5079 hexadecimal number.
5080
5081 If an integer value is followed by the letter K, it is multiplied by 1024; if
5082 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5083 of integer option settings are output, values which are an exact multiple of
5084 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5085 and M. The printing style is independent of the actual input format that was
5086 used.
5087
5088
5089 .section "Octal integer values" "SECID49"
5090 .cindex "integer format"
5091 .cindex "format" "octal integer"
5092 If an option's type is given as &"octal integer"&, its value is always
5093 interpreted as an octal number, whether or not it starts with the digit zero.
5094 Such options are always output in octal.
5095
5096
5097 .section "Fixed point numbers" "SECID50"
5098 .cindex "fixed point configuration values"
5099 .cindex "format" "fixed point"
5100 If an option's type is given as &"fixed-point"&, its value must be a decimal
5101 integer, optionally followed by a decimal point and up to three further digits.
5102
5103
5104
5105 .section "Time intervals" "SECTtimeformat"
5106 .cindex "time interval" "specifying in configuration"
5107 .cindex "format" "time interval"
5108 A time interval is specified as a sequence of numbers, each followed by one of
5109 the following letters, with no intervening white space:
5110
5111 .table2 30pt
5112 .irow &%s%& seconds
5113 .irow &%m%& minutes
5114 .irow &%h%& hours
5115 .irow &%d%& days
5116 .irow &%w%& weeks
5117 .endtable
5118
5119 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5120 intervals are output in the same format. Exim does not restrict the values; it
5121 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5122
5123
5124
5125 .section "String values" "SECTstrings"
5126 .cindex "string" "format of configuration values"
5127 .cindex "format" "string"
5128 If an option's type is specified as &"string"&, the value can be specified with
5129 or without double-quotes. If it does not start with a double-quote, the value
5130 consists of the remainder of the line plus any continuation lines, starting at
5131 the first character after any leading white space, with trailing white space
5132 removed, and with no interpretation of the characters in the string. Because
5133 Exim removes comment lines (those beginning with #) at an early stage, they can
5134 appear in the middle of a multi-line string. The following two settings are
5135 therefore equivalent:
5136 .code
5137 trusted_users = uucp:mail
5138 trusted_users = uucp:\
5139                 # This comment line is ignored
5140                 mail
5141 .endd
5142 .cindex "string" "quoted"
5143 .cindex "escape characters in quoted strings"
5144 If a string does start with a double-quote, it must end with a closing
5145 double-quote, and any backslash characters other than those used for line
5146 continuation are interpreted as escape characters, as follows:
5147
5148 .table2 100pt
5149 .irow &`\\`&                     "single backslash"
5150 .irow &`\n`&                     "newline"
5151 .irow &`\r`&                     "carriage return"
5152 .irow &`\t`&                     "tab"
5153 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5154 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5155                                    character"
5156 .endtable
5157
5158 If a backslash is followed by some other character, including a double-quote
5159 character, that character replaces the pair.
5160
5161 Quoting is necessary only if you want to make use of the backslash escapes to
5162 insert special characters, or if you need to specify a value with leading or
5163 trailing spaces. These cases are rare, so quoting is almost never needed in
5164 current versions of Exim. In versions of Exim before 3.14, quoting was required
5165 in order to continue lines, so you may come across older configuration files
5166 and examples that apparently quote unnecessarily.
5167
5168
5169 .section "Expanded strings" "SECID51"
5170 .cindex "expansion" "definition of"
5171 Some strings in the configuration file are subjected to &'string expansion'&,
5172 by which means various parts of the string may be changed according to the
5173 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5174 is as just described; in particular, the handling of backslashes in quoted
5175 strings is done as part of the input process, before expansion takes place.
5176 However, backslash is also an escape character for the expander, so any
5177 backslashes that are required for that reason must be doubled if they are
5178 within a quoted configuration string.
5179
5180
5181 .section "User and group names" "SECID52"
5182 .cindex "user name" "format of"
5183 .cindex "format" "user name"
5184 .cindex "groups" "name format"
5185 .cindex "format" "group name"
5186 User and group names are specified as strings, using the syntax described
5187 above, but the strings are interpreted specially. A user or group name must
5188 either consist entirely of digits, or be a name that can be looked up using the
5189 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5190
5191
5192 .section "List construction" "SECTlistconstruct"
5193 .cindex "list" "syntax of in configuration"
5194 .cindex "format" "list item in configuration"
5195 .cindex "string" "list, definition of"
5196 The data for some configuration options is a list of items, with colon as the
5197 default separator. Many of these options are shown with type &"string list"& in
5198 the descriptions later in this document. Others are listed as &"domain list"&,
5199 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5200 are all the same; however, those other than &"string list"& are subject to
5201 particular kinds of interpretation, as described in chapter
5202 &<<CHAPdomhosaddlists>>&.
5203
5204 In all these cases, the entire list is treated as a single string as far as the
5205 input syntax is concerned. The &%trusted_users%& setting in section
5206 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5207 in a list, it must be entered as two colons. Leading and trailing white space
5208 on each item in a list is ignored. This makes it possible to include items that
5209 start with a colon, and in particular, certain forms of IPv6 address. For
5210 example, the list
5211 .code
5212 local_interfaces = 127.0.0.1 : ::::1
5213 .endd
5214 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5215
5216 &*Note*&: Although leading and trailing white space is ignored in individual
5217 list items, it is not ignored when parsing the list. The space after the first
5218 colon in the example above is necessary. If it were not there, the list would
5219 be interpreted as the two items 127.0.0.1:: and 1.
5220
5221 .section "Changing list separators" "SECID53"
5222 .cindex "list separator" "changing"
5223 .cindex "IPv6" "addresses in lists"
5224 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5225 introduced to allow the separator character to be changed. If a list begins
5226 with a left angle bracket, followed by any punctuation character, that
5227 character is used instead of colon as the list separator. For example, the list
5228 above can be rewritten to use a semicolon separator like this:
5229 .code
5230 local_interfaces = <; 127.0.0.1 ; ::1
5231 .endd
5232 This facility applies to all lists, with the exception of the list in
5233 &%log_file_path%&. It is recommended that the use of non-colon separators be
5234 confined to circumstances where they really are needed.
5235
5236 .cindex "list separator" "newline as"
5237 .cindex "newline" "as list separator"
5238 It is also possible to use newline and other control characters (those with
5239 code values less than 32, plus DEL) as separators in lists. Such separators
5240 must be provided literally at the time the list is processed. For options that
5241 are string-expanded, you can write the separator using a normal escape
5242 sequence. This will be processed by the expander before the string is
5243 interpreted as a list. For example, if a newline-separated list of domains is
5244 generated by a lookup, you can process it directly by a line such as this:
5245 .code
5246 domains = <\n ${lookup mysql{.....}}
5247 .endd
5248 This avoids having to change the list separator in such data. You are unlikely
5249 to want to use a control character as a separator in an option that is not
5250 expanded, because the value is literal text. However, it can be done by giving
5251 the value in quotes. For example:
5252 .code
5253 local_interfaces = "<\n 127.0.0.1 \n ::1"
5254 .endd
5255 Unlike printing character separators, which can be included in list items by
5256 doubling, it is not possible to include a control character as data when it is
5257 set as the separator. Two such characters in succession are interpreted as
5258 enclosing an empty list item.
5259
5260
5261
5262 .section "Empty items in lists" "SECTempitelis"
5263 .cindex "list" "empty item in"
5264 An empty item at the end of a list is always ignored. In other words, trailing
5265 separator characters are ignored. Thus, the list in
5266 .code
5267 senders = user@domain :
5268 .endd
5269 contains only a single item. If you want to include an empty string as one item
5270 in a list, it must not be the last item. For example, this list contains three
5271 items, the second of which is empty:
5272 .code
5273 senders = user1@domain : : user2@domain
5274 .endd
5275 &*Note*&: There must be white space between the two colons, as otherwise they
5276 are interpreted as representing a single colon data character (and the list
5277 would then contain just one item). If you want to specify a list that contains
5278 just one, empty item, you can do it as in this example:
5279 .code
5280 senders = :
5281 .endd
5282 In this case, the first item is empty, and the second is discarded because it
5283 is at the end of the list.
5284
5285
5286
5287
5288 .section "Format of driver configurations" "SECTfordricon"
5289 .cindex "drivers" "configuration format"
5290 There are separate parts in the configuration for defining routers, transports,
5291 and authenticators. In each part, you are defining a number of driver
5292 instances, each with its own set of options. Each driver instance is defined by
5293 a sequence of lines like this:
5294 .display
5295 <&'instance name'&>:
5296   <&'option'&>
5297   ...
5298   <&'option'&>
5299 .endd
5300 In the following example, the instance name is &(localuser)&, and it is
5301 followed by three options settings:
5302 .code
5303 localuser:
5304   driver = accept
5305   check_local_user
5306   transport = local_delivery
5307 .endd
5308 For each driver instance, you specify which Exim code module it uses &-- by the
5309 setting of the &%driver%& option &-- and (optionally) some configuration
5310 settings. For example, in the case of transports, if you want a transport to
5311 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5312 a local file you would use the &(appendfile)& driver. Each of the drivers is
5313 described in detail in its own separate chapter later in this manual.
5314
5315 You can have several routers, transports, or authenticators that are based on
5316 the same underlying driver (each must have a different instance name).
5317
5318 The order in which routers are defined is important, because addresses are
5319 passed to individual routers one by one, in order. The order in which
5320 transports are defined does not matter at all. The order in which
5321 authenticators are defined is used only when Exim, as a client, is searching
5322 them to find one that matches an authentication mechanism offered by the
5323 server.
5324
5325 .cindex "generic options"
5326 .cindex "options" "generic &-- definition of"
5327 Within a driver instance definition, there are two kinds of option: &'generic'&
5328 and &'private'&. The generic options are those that apply to all drivers of the
5329 same type (that is, all routers, all transports or all authenticators). The
5330 &%driver%& option is a generic option that must appear in every definition.
5331 .cindex "private options"
5332 The private options are special for each driver, and none need appear, because
5333 they all have default values.
5334
5335 The options may appear in any order, except that the &%driver%& option must
5336 precede any private options, since these depend on the particular driver. For
5337 this reason, it is recommended that &%driver%& always be the first option.
5338
5339 Driver instance names, which are used for reference in log entries and
5340 elsewhere, can be any sequence of letters, digits, and underscores (starting
5341 with a letter) and must be unique among drivers of the same type. A router and
5342 a transport (for example) can each have the same name, but no two router
5343 instances can have the same name. The name of a driver instance should not be
5344 confused with the name of the underlying driver module. For example, the
5345 configuration lines:
5346 .code
5347 remote_smtp:
5348   driver = smtp
5349 .endd
5350 create an instance of the &(smtp)& transport driver whose name is
5351 &(remote_smtp)&. The same driver code can be used more than once, with
5352 different instance names and different option settings each time. A second
5353 instance of the &(smtp)& transport, with different options, might be defined
5354 thus:
5355 .code
5356 special_smtp:
5357   driver = smtp
5358   port = 1234
5359   command_timeout = 10s
5360 .endd
5361 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5362 these transport instances from routers, and these names would appear in log
5363 lines.
5364
5365 Comment lines may be present in the middle of driver specifications. The full
5366 list of option settings for any particular driver instance, including all the
5367 defaulted values, can be extracted by making use of the &%-bP%& command line
5368 option.
5369
5370
5371
5372
5373
5374
5375 . ////////////////////////////////////////////////////////////////////////////
5376 . ////////////////////////////////////////////////////////////////////////////
5377
5378 .chapter "The default configuration file" "CHAPdefconfil"
5379 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5380 .cindex "default" "configuration file &""walk through""&"
5381 The default configuration file supplied with Exim as &_src/configure.default_&
5382 is sufficient for a host with simple mail requirements. As an introduction to
5383 the way Exim is configured, this chapter &"walks through"& the default
5384 configuration, giving brief explanations of the settings. Detailed descriptions
5385 of the options are given in subsequent chapters. The default configuration file
5386 itself contains extensive comments about ways you might want to modify the
5387 initial settings. However, note that there are many options that are not
5388 mentioned at all in the default configuration.
5389
5390
5391
5392 .section "Main configuration settings" "SECTdefconfmain"
5393 The main (global) configuration option settings must always come first in the
5394 file. The first thing you'll see in the file, after some initial comments, is
5395 the line
5396 .code
5397 # primary_hostname =
5398 .endd
5399 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5400 to know the official, fully qualified name of your host, and this is where you
5401 can specify it. However, in most cases you do not need to set this option. When
5402 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5403
5404 The first three non-comment configuration lines are as follows:
5405 .code
5406 domainlist local_domains    = @
5407 domainlist relay_to_domains =
5408 hostlist   relay_from_hosts = 127.0.0.1
5409 .endd
5410 These are not, in fact, option settings. They are definitions of two named
5411 domain lists and one named host list. Exim allows you to give names to lists of
5412 domains, hosts, and email addresses, in order to make it easier to manage the
5413 configuration file (see section &<<SECTnamedlists>>&).
5414
5415 The first line defines a domain list called &'local_domains'&; this is used
5416 later in the configuration to identify domains that are to be delivered
5417 on the local host.
5418
5419 .cindex "@ in a domain list"
5420 There is just one item in this list, the string &"@"&. This is a special form
5421 of entry which means &"the name of the local host"&. Thus, if the local host is
5422 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5423 be delivered locally. Because the local host's name is referenced indirectly,
5424 the same configuration file can be used on different hosts.
5425
5426 The second line defines a domain list called &'relay_to_domains'&, but the
5427 list itself is empty. Later in the configuration we will come to the part that
5428 controls mail relaying through the local host; it allows relaying to any
5429 domains in this list. By default, therefore, no relaying on the basis of a mail
5430 domain is permitted.
5431
5432 The third line defines a host list called &'relay_from_hosts'&. This list is
5433 used later in the configuration to permit relaying from any host or IP address
5434 that matches the list. The default contains just the IP address of the IPv4
5435 loopback interface, which means that processes on the local host are able to
5436 submit mail for relaying by sending it over TCP/IP to that interface. No other
5437 hosts are permitted to submit messages for relaying.
5438
5439 Just to be sure there's no misunderstanding: at this point in the configuration
5440 we aren't actually setting up any controls. We are just defining some domains
5441 and hosts that will be used in the controls that are specified later.
5442
5443 The next two configuration lines are genuine option settings:
5444 .code
5445 acl_smtp_rcpt = acl_check_rcpt
5446 acl_smtp_data = acl_check_data
5447 .endd
5448 These options specify &'Access Control Lists'& (ACLs) that are to be used
5449 during an incoming SMTP session for every recipient of a message (every RCPT
5450 command), and after the contents of the message have been received,
5451 respectively. The names of the lists are &'acl_check_rcpt'& and
5452 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5453 section of the configuration. The RCPT ACL controls which recipients are
5454 accepted for an incoming message &-- if a configuration does not provide an ACL
5455 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5456 contents of a message to be checked.
5457
5458 Two commented-out option settings are next:
5459 .code
5460 # av_scanner = clamd:/tmp/clamd
5461 # spamd_address = 127.0.0.1 783
5462 .endd
5463 These are example settings that can be used when Exim is compiled with the
5464 content-scanning extension. The first specifies the interface to the virus
5465 scanner, and the second specifies the interface to SpamAssassin. Further
5466 details are given in chapter &<<CHAPexiscan>>&.
5467
5468 Three more commented-out option settings follow:
5469 .code
5470 # tls_advertise_hosts = *
5471 # tls_certificate = /etc/ssl/exim.crt
5472 # tls_privatekey = /etc/ssl/exim.pem
5473 .endd
5474 These are example settings that can be used when Exim is compiled with
5475 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5476 first one specifies the list of clients that are allowed to use TLS when
5477 connecting to this server; in this case the wildcard means all clients. The
5478 other options specify where Exim should find its TLS certificate and private
5479 key, which together prove the server's identity to any clients that connect.
5480 More details are given in chapter &<<CHAPTLS>>&.
5481
5482 Another two commented-out option settings follow:
5483 .code
5484 # daemon_smtp_ports = 25 : 465 : 587
5485 # tls_on_connect_ports = 465
5486 .endd
5487 .cindex "port" "465 and 587"
5488 .cindex "port" "for message submission"
5489 .cindex "message" "submission, ports for"
5490 .cindex "ssmtp protocol"
5491 .cindex "smtps protocol"
5492 .cindex "SMTP" "ssmtp protocol"
5493 .cindex "SMTP" "smtps protocol"
5494 These options provide better support for roaming users who wish to use this
5495 server for message submission. They are not much use unless you have turned on
5496 TLS (as described in the previous paragraph) and authentication (about which
5497 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5498 on end-user networks, so RFC 4409 specifies that message submission should use
5499 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5500 configured to use port 587 correctly, so these settings also enable the
5501 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5502 &<<SECTsupobssmt>>&).
5503
5504 Two more commented-out options settings follow:
5505 .code
5506 # qualify_domain =
5507 # qualify_recipient =
5508 .endd
5509 The first of these specifies a domain that Exim uses when it constructs a
5510 complete email address from a local login name. This is often needed when Exim
5511 receives a message from a local process. If you do not set &%qualify_domain%&,
5512 the value of &%primary_hostname%& is used. If you set both of these options,
5513 you can have different qualification domains for sender and recipient
5514 addresses. If you set only the first one, its value is used in both cases.
5515
5516 .cindex "domain literal" "recognizing format"
5517 The following line must be uncommented if you want Exim to recognize
5518 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5519 (an IP address within square brackets) instead of a named domain.
5520 .code
5521 # allow_domain_literals
5522 .endd
5523 The RFCs still require this form, but many people think that in the modern
5524 Internet it makes little sense to permit mail to be sent to specific hosts by
5525 quoting their IP addresses. This ancient format has been used by people who
5526 try to abuse hosts by using them for unwanted relaying. However, some
5527 people believe there are circumstances (for example, messages addressed to
5528 &'postmaster'&) where domain literals are still useful.
5529
5530 The next configuration line is a kind of trigger guard:
5531 .code
5532 never_users = root
5533 .endd
5534 It specifies that no delivery must ever be run as the root user. The normal
5535 convention is to set up &'root'& as an alias for the system administrator. This
5536 setting is a guard against slips in the configuration.
5537 The list of users specified by &%never_users%& is not, however, the complete
5538 list; the build-time configuration in &_Local/Makefile_& has an option called
5539 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5540 contents of &%never_users%& are added to this list. By default
5541 FIXED_NEVER_USERS also specifies root.
5542
5543 When a remote host connects to Exim in order to send mail, the only information
5544 Exim has about the host's identity is its IP address. The next configuration
5545 line,
5546 .code
5547 host_lookup = *
5548 .endd
5549 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5550 in order to get a host name. This improves the quality of the logging
5551 information, but if you feel it is too expensive, you can remove it entirely,
5552 or restrict the lookup to hosts on &"nearby"& networks.
5553 Note that it is not always possible to find a host name from an IP address,
5554 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5555 unreachable.
5556
5557 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5558 1413 (hence their names):
5559 .code
5560 rfc1413_hosts = *
5561 rfc1413_query_timeout = 0s
5562 .endd
5563 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5564 Few hosts offer RFC1413 service these days; calls have to be
5565 terminated by a timeout and this needlessly delays the startup
5566 of an incoming SMTP connection.
5567 If you have hosts for which you trust RFC1413 and need this
5568 information, you can change this.
5569
5570 This line enables an efficiency SMTP option.  It is negociated by clients
5571 and not expected to cause problems but can be disabled if needed.
5572 .code
5573 prdr_enable = true
5574 .endd
5575
5576 When Exim receives messages over SMTP connections, it expects all addresses to
5577 be fully qualified with a domain, as required by the SMTP definition. However,
5578 if you are running a server to which simple clients submit messages, you may
5579 find that they send unqualified addresses. The two commented-out options:
5580 .code
5581 # sender_unqualified_hosts =
5582 # recipient_unqualified_hosts =
5583 .endd
5584 show how you can specify hosts that are permitted to send unqualified sender
5585 and recipient addresses, respectively.
5586
5587 The &%percent_hack_domains%& option is also commented out:
5588 .code
5589 # percent_hack_domains =
5590 .endd
5591 It provides a list of domains for which the &"percent hack"& is to operate.
5592 This is an almost obsolete form of explicit email routing. If you do not know
5593 anything about it, you can safely ignore this topic.
5594
5595 The last two settings in the main part of the default configuration are
5596 concerned with messages that have been &"frozen"& on Exim's queue. When a
5597 message is frozen, Exim no longer continues to try to deliver it. Freezing
5598 occurs when a bounce message encounters a permanent failure because the sender
5599 address of the original message that caused the bounce is invalid, so the
5600 bounce cannot be delivered. This is probably the most common case, but there
5601 are also other conditions that cause freezing, and frozen messages are not
5602 always bounce messages.
5603 .code
5604 ignore_bounce_errors_after = 2d
5605 timeout_frozen_after = 7d
5606 .endd
5607 The first of these options specifies that failing bounce messages are to be
5608 discarded after 2 days on the queue. The second specifies that any frozen
5609 message (whether a bounce message or not) is to be timed out (and discarded)
5610 after a week. In this configuration, the first setting ensures that no failing
5611 bounce message ever lasts a week.
5612
5613
5614
5615 .section "ACL configuration" "SECID54"
5616 .cindex "default" "ACLs"
5617 .cindex "&ACL;" "default configuration"
5618 In the default configuration, the ACL section follows the main configuration.
5619 It starts with the line
5620 .code
5621 begin acl
5622 .endd
5623 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5624 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5625 and &%acl_smtp_data%& above.
5626
5627 .cindex "RCPT" "ACL for"
5628 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5629 RCPT command specifies one of the message's recipients. The ACL statements
5630 are considered in order, until the recipient address is either accepted or
5631 rejected. The RCPT command is then accepted or rejected, according to the
5632 result of the ACL processing.
5633 .code
5634 acl_check_rcpt:
5635 .endd
5636 This line, consisting of a name terminated by a colon, marks the start of the
5637 ACL, and names it.
5638 .code
5639 accept  hosts = :
5640 .endd
5641 This ACL statement accepts the recipient if the sending host matches the list.
5642 But what does that strange list mean? It doesn't actually contain any host
5643 names or IP addresses. The presence of the colon puts an empty item in the
5644 list; Exim matches this only if the incoming message did not come from a remote
5645 host, because in that case, the remote hostname is empty. The colon is
5646 important. Without it, the list itself is empty, and can never match anything.
5647
5648 What this statement is doing is to accept unconditionally all recipients in
5649 messages that are submitted by SMTP from local processes using the standard
5650 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5651 manner.
5652 .code
5653 deny    message       = Restricted characters in address
5654         domains       = +local_domains
5655         local_parts   = ^[.] : ^.*[@%!/|]
5656
5657 deny    message       = Restricted characters in address
5658         domains       = !+local_domains
5659         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5660 .endd
5661 These statements are concerned with local parts that contain any of the
5662 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5663 Although these characters are entirely legal in local parts (in the case of
5664 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5665 in Internet mail addresses.
5666
5667 The first three have in the past been associated with explicitly routed
5668 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5669 option). Addresses containing these characters are regularly tried by spammers
5670 in an attempt to bypass relaying restrictions, and also by open relay testing
5671 programs. Unless you really need them it is safest to reject these characters
5672 at this early stage. This configuration is heavy-handed in rejecting these
5673 characters for all messages it accepts from remote hosts. This is a deliberate
5674 policy of being as safe as possible.
5675
5676 The first rule above is stricter, and is applied to messages that are addressed
5677 to one of the local domains handled by this host. This is implemented by the
5678 first condition, which restricts it to domains that are listed in the
5679 &'local_domains'& domain list. The &"+"& character is used to indicate a
5680 reference to a named list. In this configuration, there is just one domain in
5681 &'local_domains'&, but in general there may be many.
5682
5683 The second condition on the first statement uses two regular expressions to
5684 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5685 or &"|"&. If you have local accounts that include these characters, you will
5686 have to modify this rule.
5687
5688 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5689 allows them because they have been encountered in practice. (Consider the
5690 common convention of local parts constructed as
5691 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5692 the author of Exim, who has no second initial.) However, a local part starting
5693 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5694 file name (for example, for a mailing list). This is also true for local parts
5695 that contain slashes. A pipe symbol can also be troublesome if the local part
5696 is incorporated unthinkingly into a shell command line.
5697
5698 The second rule above applies to all other domains, and is less strict. This
5699 allows your own users to send outgoing messages to sites that use slashes
5700 and vertical bars in their local parts. It blocks local parts that begin
5701 with a dot, slash, or vertical bar, but allows these characters within the
5702 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5703 and &"!"& is blocked, as before. The motivation here is to prevent your users
5704 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5705 .code
5706 accept  local_parts   = postmaster
5707         domains       = +local_domains
5708 .endd
5709 This statement, which has two conditions, accepts an incoming address if the
5710 local part is &'postmaster'& and the domain is one of those listed in the
5711 &'local_domains'& domain list. The &"+"& character is used to indicate a
5712 reference to a named list. In this configuration, there is just one domain in
5713 &'local_domains'&, but in general there may be many.
5714
5715 The presence of this statement means that mail to postmaster is never blocked
5716 by any of the subsequent tests. This can be helpful while sorting out problems
5717 in cases where the subsequent tests are incorrectly denying access.
5718 .code
5719 require verify        = sender
5720 .endd
5721 This statement requires the sender address to be verified before any subsequent
5722 ACL statement can be used. If verification fails, the incoming recipient
5723 address is refused. Verification consists of trying to route the address, to
5724 see if a bounce message could be delivered to it. In the case of remote
5725 addresses, basic verification checks only the domain, but &'callouts'& can be
5726 used for more verification if required. Section &<<SECTaddressverification>>&
5727 discusses the details of address verification.
5728 .code
5729 accept  hosts         = +relay_from_hosts
5730         control       = submission
5731 .endd
5732 This statement accepts the address if the message is coming from one of the
5733 hosts that are defined as being allowed to relay through this host. Recipient
5734 verification is omitted here, because in many cases the clients are dumb MUAs
5735 that do not cope well with SMTP error responses. For the same reason, the
5736 second line specifies &"submission mode"& for messages that are accepted. This
5737 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5738 messages that are deficient in some way, for example, because they lack a
5739 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5740 probably add recipient verification here, and disable submission mode.
5741 .code
5742 accept  authenticated = *
5743         control       = submission
5744 .endd
5745 This statement accepts the address if the client host has authenticated itself.
5746 Submission mode is again specified, on the grounds that such messages are most
5747 likely to come from MUAs. The default configuration does not define any
5748 authenticators, though it does include some nearly complete commented-out
5749 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5750 fact authenticate until you complete the authenticator definitions.
5751 .code
5752 require message = relay not permitted
5753         domains = +local_domains : +relay_to_domains
5754 .endd
5755 This statement rejects the address if its domain is neither a local domain nor
5756 one of the domains for which this host is a relay.
5757 .code
5758 require verify = recipient
5759 .endd
5760 This statement requires the recipient address to be verified; if verification
5761 fails, the address is rejected.
5762 .code
5763 # deny    message     = rejected because $sender_host_address \
5764 #                       is in a black list at $dnslist_domain\n\
5765 #                       $dnslist_text
5766 #         dnslists    = black.list.example
5767 #
5768 # warn    dnslists    = black.list.example
5769 #         add_header  = X-Warning: $sender_host_address is in \
5770 #                       a black list at $dnslist_domain
5771 #         log_message = found in $dnslist_domain
5772 .endd
5773 These commented-out lines are examples of how you could configure Exim to check
5774 sending hosts against a DNS black list. The first statement rejects messages
5775 from blacklisted hosts, whereas the second just inserts a warning header
5776 line.
5777 .code
5778 # require verify = csa
5779 .endd
5780 This commented-out line is an example of how you could turn on client SMTP
5781 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5782 records.
5783 .code
5784 accept
5785 .endd
5786 The final statement in the first ACL unconditionally accepts any recipient
5787 address that has successfully passed all the previous tests.
5788 .code
5789 acl_check_data:
5790 .endd
5791 This line marks the start of the second ACL, and names it. Most of the contents
5792 of this ACL are commented out:
5793 .code
5794 # deny    malware   = *
5795 #         message   = This message contains a virus \
5796 #                     ($malware_name).
5797 .endd
5798 These lines are examples of how to arrange for messages to be scanned for
5799 viruses when Exim has been compiled with the content-scanning extension, and a
5800 suitable virus scanner is installed. If the message is found to contain a
5801 virus, it is rejected with the given custom error message.
5802 .code
5803 # warn    spam      = nobody
5804 #         message   = X-Spam_score: $spam_score\n\
5805 #                     X-Spam_score_int: $spam_score_int\n\
5806 #                     X-Spam_bar: $spam_bar\n\
5807 #                     X-Spam_report: $spam_report
5808 .endd
5809 These lines are an example of how to arrange for messages to be scanned by
5810 SpamAssassin when Exim has been compiled with the content-scanning extension,
5811 and SpamAssassin has been installed. The SpamAssassin check is run with
5812 &`nobody`& as its user parameter, and the results are added to the message as a
5813 series of extra header line. In this case, the message is not rejected,
5814 whatever the spam score.
5815 .code
5816 accept
5817 .endd
5818 This final line in the DATA ACL accepts the message unconditionally.
5819
5820
5821 .section "Router configuration" "SECID55"
5822 .cindex "default" "routers"
5823 .cindex "routers" "default"
5824 The router configuration comes next in the default configuration, introduced
5825 by the line
5826 .code
5827 begin routers
5828 .endd
5829 Routers are the modules in Exim that make decisions about where to send
5830 messages. An address is passed to each router in turn, until it is either
5831 accepted, or failed. This means that the order in which you define the routers
5832 matters. Each router is fully described in its own chapter later in this
5833 manual. Here we give only brief overviews.
5834 .code
5835 # domain_literal:
5836 #   driver = ipliteral
5837 #   domains = !+local_domains
5838 #   transport = remote_smtp
5839 .endd
5840 .cindex "domain literal" "default router"
5841 This router is commented out because the majority of sites do not want to
5842 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5843 you uncomment this router, you also need to uncomment the setting of
5844 &%allow_domain_literals%& in the main part of the configuration.
5845 .code
5846 dnslookup:
5847   driver = dnslookup
5848   domains = ! +local_domains
5849   transport = remote_smtp
5850   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5851   no_more
5852 .endd
5853 The first uncommented router handles addresses that do not involve any local
5854 domains. This is specified by the line
5855 .code
5856 domains = ! +local_domains
5857 .endd
5858 The &%domains%& option lists the domains to which this router applies, but the
5859 exclamation mark is a negation sign, so the router is used only for domains
5860 that are not in the domain list called &'local_domains'& (which was defined at
5861 the start of the configuration). The plus sign before &'local_domains'&
5862 indicates that it is referring to a named list. Addresses in other domains are
5863 passed on to the following routers.
5864
5865 The name of the router driver is &(dnslookup)&,
5866 and is specified by the &%driver%& option. Do not be confused by the fact that
5867 the name of this router instance is the same as the name of the driver. The
5868 instance name is arbitrary, but the name set in the &%driver%& option must be
5869 one of the driver modules that is in the Exim binary.
5870
5871 The &(dnslookup)& router routes addresses by looking up their domains in the
5872 DNS in order to obtain a list of hosts to which the address is routed. If the
5873 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5874 specified by the &%transport%& option. If the router does not find the domain
5875 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5876 the address fails and is bounced.
5877
5878 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5879 be entirely ignored. This option is present because a number of cases have been
5880 encountered where MX records in the DNS point to host names
5881 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5882 Completely ignoring these IP addresses causes Exim to fail to route the
5883 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5884 continue to try to deliver the message periodically until the address timed
5885 out.
5886 .code
5887 system_aliases:
5888   driver = redirect
5889   allow_fail
5890   allow_defer
5891   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5892 # user = exim
5893   file_transport = address_file
5894   pipe_transport = address_pipe
5895 .endd
5896 Control reaches this and subsequent routers only for addresses in the local
5897 domains. This router checks to see whether the local part is defined as an
5898 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5899 data that it looks up from that file. If no data is found for the local part,
5900 the value of the &%data%& option is empty, causing the address to be passed to
5901 the next router.
5902
5903 &_/etc/aliases_& is a conventional name for the system aliases file that is
5904 often used. That is why it is referenced by from the default configuration
5905 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5906 &_Local/Makefile_& before building Exim.
5907 .code
5908 userforward:
5909   driver = redirect
5910   check_local_user
5911 # local_part_suffix = +* : -*
5912 # local_part_suffix_optional
5913   file = $home/.forward
5914 # allow_filter
5915   no_verify
5916   no_expn
5917   check_ancestor
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920   reply_transport = address_reply
5921 .endd
5922 This is the most complicated router in the default configuration. It is another
5923 redirection router, but this time it is looking for forwarding data set up by
5924 individual users. The &%check_local_user%& setting specifies a check that the
5925 local part of the address is the login name of a local user. If it is not, the
5926 router is skipped. The two commented options that follow &%check_local_user%&,
5927 namely:
5928 .code
5929 # local_part_suffix = +* : -*
5930 # local_part_suffix_optional
5931 .endd
5932 .vindex "&$local_part_suffix$&"
5933 show how you can specify the recognition of local part suffixes. If the first
5934 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5935 by any sequence of characters, is removed from the local part and placed in the
5936 variable &$local_part_suffix$&. The second suffix option specifies that the
5937 presence of a suffix in the local part is optional. When a suffix is present,
5938 the check for a local login uses the local part with the suffix removed.
5939
5940 When a local user account is found, the file called &_.forward_& in the user's
5941 home directory is consulted. If it does not exist, or is empty, the router
5942 declines. Otherwise, the contents of &_.forward_& are interpreted as
5943 redirection data (see chapter &<<CHAPredirect>>& for more details).
5944
5945 .cindex "Sieve filter" "enabling in default router"
5946 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5947 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5948 is commented out by default), the contents of the file are interpreted as a set
5949 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5950 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5951 separate document entitled &'Exim's interfaces to mail filtering'&.
5952
5953 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5954 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5955 There are two reasons for doing this:
5956
5957 .olist
5958 Whether or not a local user has a &_.forward_& file is not really relevant when
5959 checking an address for validity; it makes sense not to waste resources doing
5960 unnecessary work.
5961 .next
5962 More importantly, when Exim is verifying addresses or handling an EXPN
5963 command during an SMTP session, it is running as the Exim user, not as root.
5964 The group is the Exim group, and no additional groups are set up.
5965 It may therefore not be possible for Exim to read users' &_.forward_& files at
5966 this time.
5967 .endlist
5968
5969 The setting of &%check_ancestor%& prevents the router from generating a new
5970 address that is the same as any previous address that was redirected. (This
5971 works round a problem concerning a bad interaction between aliasing and
5972 forwarding &-- see section &<<SECTredlocmai>>&).
5973
5974 The final three option settings specify the transports that are to be used when
5975 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5976 auto-reply, respectively. For example, if a &_.forward_& file contains
5977 .code
5978 a.nother@elsewhere.example, /home/spqr/archive
5979 .endd
5980 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5981 transport.
5982 .code
5983 localuser:
5984   driver = accept
5985   check_local_user
5986 # local_part_suffix = +* : -*
5987 # local_part_suffix_optional
5988   transport = local_delivery
5989 .endd
5990 The final router sets up delivery into local mailboxes, provided that the local
5991 part is the name of a local login, by accepting the address and assigning it to
5992 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5993 routers, so the address is bounced. The commented suffix settings fulfil the
5994 same purpose as they do for the &(userforward)& router.
5995
5996
5997 .section "Transport configuration" "SECID56"
5998 .cindex "default" "transports"
5999 .cindex "transports" "default"
6000 Transports define mechanisms for actually delivering messages. They operate
6001 only when referenced from routers, so the order in which they are defined does
6002 not matter. The transports section of the configuration starts with
6003 .code
6004 begin transports
6005 .endd
6006 One remote transport and four local transports are defined.
6007 .code
6008 remote_smtp:
6009   driver = smtp
6010   hosts_try_prdr = *
6011 .endd
6012 This transport is used for delivering messages over SMTP connections.
6013 The list of remote hosts comes from the router.
6014 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6015 It is negotiated between client and server
6016 and not expected to cause problems but can be disabled if needed.
6017 All other options are defaulted.
6018 .code
6019 local_delivery:
6020   driver = appendfile
6021   file = /var/mail/$local_part
6022   delivery_date_add
6023   envelope_to_add
6024   return_path_add
6025 # group = mail
6026 # mode = 0660
6027 .endd
6028 This &(appendfile)& transport is used for local delivery to user mailboxes in
6029 traditional BSD mailbox format. By default it runs under the uid and gid of the
6030 local user, which requires the sticky bit to be set on the &_/var/mail_&
6031 directory. Some systems use the alternative approach of running mail deliveries
6032 under a particular group instead of using the sticky bit. The commented options
6033 show how this can be done.
6034
6035 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6036 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6037 similarly-named options above.
6038 .code
6039 address_pipe:
6040   driver = pipe
6041   return_output
6042 .endd
6043 This transport is used for handling deliveries to pipes that are generated by
6044 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6045 option specifies that any output generated by the pipe is to be returned to the
6046 sender.
6047 .code
6048 address_file:
6049   driver = appendfile
6050   delivery_date_add
6051   envelope_to_add
6052   return_path_add
6053 .endd
6054 This transport is used for handling deliveries to files that are generated by
6055 redirection. The name of the file is not specified in this instance of
6056 &(appendfile)&, because it comes from the &(redirect)& router.
6057 .code
6058 address_reply:
6059   driver = autoreply
6060 .endd
6061 This transport is used for handling automatic replies generated by users'
6062 filter files.
6063
6064
6065
6066 .section "Default retry rule" "SECID57"
6067 .cindex "retry" "default rule"
6068 .cindex "default" "retry rule"
6069 The retry section of the configuration file contains rules which affect the way
6070 Exim retries deliveries that cannot be completed at the first attempt. It is
6071 introduced by the line
6072 .code
6073 begin retry
6074 .endd
6075 In the default configuration, there is just one rule, which applies to all
6076 errors:
6077 .code
6078 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6079 .endd
6080 This causes any temporarily failing address to be retried every 15 minutes for
6081 2 hours, then at intervals starting at one hour and increasing by a factor of
6082 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6083 is not delivered after 4 days of temporary failure, it is bounced.
6084
6085 If the retry section is removed from the configuration, or is empty (that is,
6086 if no retry rules are defined), Exim will not retry deliveries. This turns
6087 temporary errors into permanent errors.
6088
6089
6090 .section "Rewriting configuration" "SECID58"
6091 The rewriting section of the configuration, introduced by
6092 .code
6093 begin rewrite
6094 .endd
6095 contains rules for rewriting addresses in messages as they arrive. There are no
6096 rewriting rules in the default configuration file.
6097
6098
6099
6100 .section "Authenticators configuration" "SECTdefconfauth"
6101 .cindex "AUTH" "configuration"
6102 The authenticators section of the configuration, introduced by
6103 .code
6104 begin authenticators
6105 .endd
6106 defines mechanisms for the use of the SMTP AUTH command. The default
6107 configuration file contains two commented-out example authenticators
6108 which support plaintext username/password authentication using the
6109 standard PLAIN mechanism and the traditional but non-standard LOGIN
6110 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6111 to support most MUA software.
6112
6113 The example PLAIN authenticator looks like this:
6114 .code
6115 #PLAIN:
6116 #  driver                  = plaintext
6117 #  server_set_id           = $auth2
6118 #  server_prompts          = :
6119 #  server_condition        = Authentication is not yet configured
6120 #  server_advertise_condition = ${if def:tls_in_cipher }
6121 .endd
6122 And the example LOGIN authenticator looks like this:
6123 .code
6124 #LOGIN:
6125 #  driver                  = plaintext
6126 #  server_set_id           = $auth1
6127 #  server_prompts          = <| Username: | Password:
6128 #  server_condition        = Authentication is not yet configured
6129 #  server_advertise_condition = ${if def:tls_in_cipher }
6130 .endd
6131
6132 The &%server_set_id%& option makes Exim remember the authenticated username
6133 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6134 &%server_prompts%& option configures the &(plaintext)& authenticator so
6135 that it implements the details of the specific authentication mechanism,
6136 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6137 when Exim offers authentication to clients; in the examples, this is only
6138 when TLS or SSL has been started, so to enable the authenticators you also
6139 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6140
6141 The &%server_condition%& setting defines how to verify that the username and
6142 password are correct. In the examples it just produces an error message.
6143 To make the authenticators work, you can use a string expansion
6144 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6145
6146 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6147 usercode and password are in different positions.
6148 Chapter &<<CHAPplaintext>>& covers both.
6149
6150 .ecindex IIDconfiwal
6151
6152
6153
6154 . ////////////////////////////////////////////////////////////////////////////
6155 . ////////////////////////////////////////////////////////////////////////////
6156
6157 .chapter "Regular expressions" "CHAPregexp"
6158
6159 .cindex "regular expressions" "library"
6160 .cindex "PCRE"
6161 Exim supports the use of regular expressions in many of its options. It
6162 uses the PCRE regular expression library; this provides regular expression
6163 matching that is compatible with Perl 5. The syntax and semantics of
6164 regular expressions is discussed in many Perl reference books, and also in
6165 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6166 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6167
6168 The documentation for the syntax and semantics of the regular expressions that
6169 are supported by PCRE is included in the PCRE distribution, and no further
6170 description is included here. The PCRE functions are called from Exim using
6171 the default option settings (that is, with no PCRE options set), except that
6172 the PCRE_CASELESS option is set when the matching is required to be
6173 case-insensitive.
6174
6175 In most cases, when a regular expression is required in an Exim configuration,
6176 it has to start with a circumflex, in order to distinguish it from plain text
6177 or an &"ends with"& wildcard. In this example of a configuration setting, the
6178 second item in the colon-separated list is a regular expression.
6179 .code
6180 domains = a.b.c : ^\\d{3} : *.y.z : ...
6181 .endd
6182 The doubling of the backslash is required because of string expansion that
6183 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6184 of this issue, and a way of avoiding the need for doubling backslashes. The
6185 regular expression that is eventually used in this example contains just one
6186 backslash. The circumflex is included in the regular expression, and has the
6187 normal effect of &"anchoring"& it to the start of the string that is being
6188 matched.
6189
6190 There are, however, two cases where a circumflex is not required for the
6191 recognition of a regular expression: these are the &%match%& condition in a
6192 string expansion, and the &%matches%& condition in an Exim filter file. In
6193 these cases, the relevant string is always treated as a regular expression; if
6194 it does not start with a circumflex, the expression is not anchored, and can
6195 match anywhere in the subject string.
6196
6197 In all cases, if you want a regular expression to match at the end of a string,
6198 you must code the $ metacharacter to indicate this. For example:
6199 .code
6200 domains = ^\\d{3}\\.example
6201 .endd
6202 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6203 You need to use:
6204 .code
6205 domains = ^\\d{3}\\.example\$
6206 .endd
6207 if you want &'example'& to be the top-level domain. The backslash before the
6208 $ is needed because string expansion also interprets dollar characters.
6209
6210
6211
6212 . ////////////////////////////////////////////////////////////////////////////
6213 . ////////////////////////////////////////////////////////////////////////////
6214
6215 .chapter "File and database lookups" "CHAPfdlookup"
6216 .scindex IIDfidalo1 "file" "lookups"
6217 .scindex IIDfidalo2 "database" "lookups"
6218 .cindex "lookup" "description of"
6219 Exim can be configured to look up data in files or databases as it processes
6220 messages. Two different kinds of syntax are used:
6221
6222 .olist
6223 A string that is to be expanded may contain explicit lookup requests. These
6224 cause parts of the string to be replaced by data that is obtained from the
6225 lookup. Lookups of this type are conditional expansion items. Different results
6226 can be defined for the cases of lookup success and failure. See chapter
6227 &<<CHAPexpand>>&, where string expansions are described in detail.
6228 .next
6229 Lists of domains, hosts, and email addresses can contain lookup requests as a
6230 way of avoiding excessively long linear lists. In this case, the data that is
6231 returned by the lookup is often (but not always) discarded; whether the lookup
6232 succeeds or fails is what really counts. These kinds of list are described in
6233 chapter &<<CHAPdomhosaddlists>>&.
6234 .endlist
6235
6236 String expansions, lists, and lookups interact with each other in such a way
6237 that there is no order in which to describe any one of them that does not
6238 involve references to the others. Each of these three chapters makes more sense
6239 if you have read the other two first. If you are reading this for the first
6240 time, be aware that some of it will make a lot more sense after you have read
6241 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6242
6243 .section "Examples of different lookup syntax" "SECID60"
6244 It is easy to confuse the two different kinds of lookup, especially as the
6245 lists that may contain the second kind are always expanded before being
6246 processed as lists. Therefore, they may also contain lookups of the first kind.
6247 Be careful to distinguish between the following two examples:
6248 .code
6249 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6250 domains = lsearch;/some/file
6251 .endd
6252 The first uses a string expansion, the result of which must be a domain list.
6253 No strings have been specified for a successful or a failing lookup; the
6254 defaults in this case are the looked-up data and an empty string, respectively.
6255 The expansion takes place before the string is processed as a list, and the
6256 file that is searched could contain lines like this:
6257 .code
6258 192.168.3.4: domain1:domain2:...
6259 192.168.1.9: domain3:domain4:...
6260 .endd
6261 When the lookup succeeds, the result of the expansion is a list of domains (and
6262 possibly other types of item that are allowed in domain lists).
6263
6264 In the second example, the lookup is a single item in a domain list. It causes
6265 Exim to use a lookup to see if the domain that is being processed can be found
6266 in the file. The file could contains lines like this:
6267 .code
6268 domain1:
6269 domain2:
6270 .endd
6271 Any data that follows the keys is not relevant when checking that the domain
6272 matches the list item.
6273
6274 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6275 Consider a file containing lines like this:
6276 .code
6277 192.168.5.6: lsearch;/another/file
6278 .endd
6279 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6280 first &%domains%& setting above generates the second setting, which therefore
6281 causes a second lookup to occur.
6282
6283 The rest of this chapter describes the different lookup types that are
6284 available. Any of them can be used in any part of the configuration where a
6285 lookup is permitted.
6286
6287
6288 .section "Lookup types" "SECID61"
6289 .cindex "lookup" "types of"
6290 .cindex "single-key lookup" "definition of"
6291 Two different types of data lookup are implemented:
6292
6293 .ilist
6294 The &'single-key'& type requires the specification of a file in which to look,
6295 and a single key to search for. The key must be a non-empty string for the
6296 lookup to succeed. The lookup type determines how the file is searched.
6297 .next
6298 .cindex "query-style lookup" "definition of"
6299 The &'query-style'& type accepts a generalized database query. No particular
6300 key value is assumed by Exim for query-style lookups. You can use whichever
6301 Exim variables you need to construct the database query.
6302 .endlist
6303
6304 The code for each lookup type is in a separate source file that is included in
6305 the binary of Exim only if the corresponding compile-time option is set. The
6306 default settings in &_src/EDITME_& are:
6307 .code
6308 LOOKUP_DBM=yes
6309 LOOKUP_LSEARCH=yes
6310 .endd
6311 which means that only linear searching and DBM lookups are included by default.
6312 For some types of lookup (e.g. SQL databases), you need to install appropriate
6313 libraries and header files before building Exim.
6314
6315
6316
6317
6318 .section "Single-key lookup types" "SECTsinglekeylookups"
6319 .cindex "lookup" "single-key types"
6320 .cindex "single-key lookup" "list of types"
6321 The following single-key lookup types are implemented:
6322
6323 .ilist
6324 .cindex "cdb" "description of"
6325 .cindex "lookup" "cdb"
6326 .cindex "binary zero" "in lookup key"
6327 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6328 string without a terminating binary zero. The cdb format is designed for
6329 indexed files that are read frequently and never updated, except by total
6330 re-creation. As such, it is particularly suitable for large files containing
6331 aliases or other indexed data referenced by an MTA. Information about cdb can
6332 be found in several places:
6333 .display
6334 &url(http://www.pobox.com/~djb/cdb.html)
6335 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6336 &url(http://packages.debian.org/stable/utils/freecdb.html)
6337 .endd
6338 A cdb distribution is not needed in order to build Exim with cdb support,
6339 because the code for reading cdb files is included directly in Exim itself.
6340 However, no means of building or testing cdb files is provided with Exim, so
6341 you need to obtain a cdb distribution in order to do this.
6342 .next
6343 .cindex "DBM" "lookup type"
6344 .cindex "lookup" "dbm"
6345 .cindex "binary zero" "in lookup key"
6346 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6347 DBM file by looking up the record with the given key. A terminating binary
6348 zero is included in the key that is passed to the DBM library. See section
6349 &<<SECTdb>>& for a discussion of DBM libraries.
6350
6351 .cindex "Berkeley DB library" "file format"
6352 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6353 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6354 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6355 the DB_UNKNOWN option. This enables it to handle any of the types of database
6356 that the library supports, and can be useful for accessing DBM files created by
6357 other applications. (For earlier DB versions, DB_HASH is always used.)
6358 .next
6359 .cindex "lookup" "dbmjz"
6360 .cindex "lookup" "dbm &-- embedded NULs"
6361 .cindex "sasldb2"
6362 .cindex "dbmjz lookup type"
6363 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6364 interpreted as an Exim list; the elements of the list are joined together with
6365 ASCII NUL characters to form the lookup key.  An example usage would be to
6366 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6367 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6368 &(cram_md5)& authenticator.
6369 .next
6370 .cindex "lookup" "dbmnz"
6371 .cindex "lookup" "dbm &-- terminating zero"
6372 .cindex "binary zero" "in lookup key"
6373 .cindex "Courier"
6374 .cindex "&_/etc/userdbshadow.dat_&"
6375 .cindex "dbmnz lookup type"
6376 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6377 is not included in the key that is passed to the DBM library. You may need this
6378 if you want to look up data in files that are created by or shared with some
6379 other application that does not use terminating zeros. For example, you need to
6380 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6381 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6382 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6383 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6384 .next
6385 .cindex "lookup" "dsearch"
6386 .cindex "dsearch lookup type"
6387 &(dsearch)&: The given file must be a directory; this is searched for an entry
6388 whose name is the key by calling the &[lstat()]& function. The key may not
6389 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6390 the lookup is the name of the entry, which may be a file, directory,
6391 symbolic link, or any other kind of directory entry. An example of how this
6392 lookup can be used to support virtual domains is given in section
6393 &<<SECTvirtualdomains>>&.
6394 .next
6395 .cindex "lookup" "iplsearch"
6396 .cindex "iplsearch lookup type"
6397 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6398 terminated by a colon or white space or the end of the line. The keys in the
6399 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6400 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6401 being interpreted as a key terminator. For example:
6402 .code
6403 1.2.3.4:           data for 1.2.3.4
6404 192.168.0.0/16:    data for 192.168.0.0/16
6405 "abcd::cdab":      data for abcd::cdab
6406 "abcd:abcd::/32"   data for abcd:abcd::/32
6407 .endd
6408 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6409 file is searched linearly, using the CIDR masks where present, until a matching
6410 key is found. The first key that matches is used; there is no attempt to find a
6411 &"best"& match. Apart from the way the keys are matched, the processing for
6412 &(iplsearch)& is the same as for &(lsearch)&.
6413
6414 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6415 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6416 lookup types support only literal keys.
6417
6418 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6419 the implicit key is the host's IP address rather than its name (see section
6420 &<<SECThoslispatsikey>>&).
6421 .next
6422 .cindex "linear search"
6423 .cindex "lookup" "lsearch"
6424 .cindex "lsearch lookup type"
6425 .cindex "case sensitivity" "in lsearch lookup"
6426 &(lsearch)&: The given file is a text file that is searched linearly for a
6427 line beginning with the search key, terminated by a colon or white space or the
6428 end of the line. The search is case-insensitive; that is, upper and lower case
6429 letters are treated as the same. The first occurrence of the key that is found
6430 in the file is used.
6431
6432 White space between the key and the colon is permitted. The remainder of the
6433 line, with leading and trailing white space removed, is the data. This can be
6434 continued onto subsequent lines by starting them with any amount of white
6435 space, but only a single space character is included in the data at such a
6436 junction. If the data begins with a colon, the key must be terminated by a
6437 colon, for example:
6438 .code
6439 baduser:  :fail:
6440 .endd
6441 Empty lines and lines beginning with # are ignored, even if they occur in the
6442 middle of an item. This is the traditional textual format of alias files. Note
6443 that the keys in an &(lsearch)& file are literal strings. There is no
6444 wildcarding of any kind.
6445
6446 .cindex "lookup" "lsearch &-- colons in keys"
6447 .cindex "white space" "in lsearch key"
6448 In most &(lsearch)& files, keys are not required to contain colons or #
6449 characters, or white space. However, if you need this feature, it is available.
6450 If a key begins with a doublequote character, it is terminated only by a
6451 matching quote (or end of line), and the normal escaping rules apply to its
6452 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6453 quoted keys (exactly as for unquoted keys). There is no special handling of
6454 quotes for the data part of an &(lsearch)& line.
6455
6456 .next
6457 .cindex "NIS lookup type"
6458 .cindex "lookup" "NIS"
6459 .cindex "binary zero" "in lookup key"
6460 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6461 the given key, without a terminating binary zero. There is a variant called
6462 &(nis0)& which does include the terminating binary zero in the key. This is
6463 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6464 aliases; the full map names must be used.
6465
6466 .next
6467 .cindex "wildlsearch lookup type"
6468 .cindex "lookup" "wildlsearch"
6469 .cindex "nwildlsearch lookup type"
6470 .cindex "lookup" "nwildlsearch"
6471 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6472 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6473 the file may be wildcarded. The difference between these two lookup types is
6474 that for &(wildlsearch)&, each key in the file is string-expanded before being
6475 used, whereas for &(nwildlsearch)&, no expansion takes place.
6476
6477 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6478 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6479 file that are regular expressions can be made case-sensitive by the use of
6480 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6481
6482 . ==== As this is a nested list, any displays it contains must be indented
6483 . ==== as otherwise they are too far to the left.
6484
6485 .olist
6486 The string may begin with an asterisk to mean &"ends with"&. For example:
6487 .code
6488     *.a.b.c       data for anything.a.b.c
6489     *fish         data for anythingfish
6490 .endd
6491 .next
6492 The string may begin with a circumflex to indicate a regular expression. For
6493 example, for &(wildlsearch)&:
6494 .code
6495     ^\N\d+\.a\.b\N    data for <digits>.a.b
6496 .endd
6497 Note the use of &`\N`& to disable expansion of the contents of the regular
6498 expression. If you are using &(nwildlsearch)&, where the keys are not
6499 string-expanded, the equivalent entry is:
6500 .code
6501     ^\d+\.a\.b        data for <digits>.a.b
6502 .endd
6503 The case-insensitive flag is set at the start of compiling the regular
6504 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6505 For example, to make the entire pattern case-sensitive:
6506 .code
6507     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509
6510 If the regular expression contains white space or colon characters, you must
6511 either quote it (see &(lsearch)& above), or represent these characters in other
6512 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6513 colon. This may be easier than quoting, because if you quote, you have to
6514 escape all the backslashes inside the quotes.
6515
6516 &*Note*&: It is not possible to capture substrings in a regular expression
6517 match for later use, because the results of all lookups are cached. If a lookup
6518 is repeated, the result is taken from the cache, and no actual pattern matching
6519 takes place. The values of all the numeric variables are unset after a
6520 &((n)wildlsearch)& match.
6521
6522 .next
6523 Although I cannot see it being of much use, the general matching function that
6524 is used to implement &((n)wildlsearch)& means that the string may begin with a
6525 lookup name terminated by a semicolon, and followed by lookup data. For
6526 example:
6527 .code
6528     cdb;/some/file  data for keys that match the file
6529 .endd
6530 The data that is obtained from the nested lookup is discarded.
6531 .endlist olist
6532
6533 Keys that do not match any of these patterns are interpreted literally. The
6534 continuation rules for the data are the same as for &(lsearch)&, and keys may
6535 be followed by optional colons.
6536
6537 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6538 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6539 lookup types support only literal keys.
6540 .endlist ilist
6541
6542
6543 .section "Query-style lookup types" "SECID62"
6544 .cindex "lookup" "query-style types"
6545 .cindex "query-style lookup" "list of types"
6546 The supported query-style lookup types are listed below. Further details about
6547 many of them are given in later sections.
6548
6549 .ilist
6550 .cindex "DNS" "as a lookup type"
6551 .cindex "lookup" "DNS"
6552 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6553 are given in the supplied query. The resulting data is the contents of the
6554 records. See section &<<SECTdnsdb>>&.
6555 .next
6556 .cindex "InterBase lookup type"
6557 .cindex "lookup" "InterBase"
6558 &(ibase)&: This does a lookup in an InterBase database.
6559 .next
6560 .cindex "LDAP" "lookup type"
6561 .cindex "lookup" "LDAP"
6562 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6563 returns attributes from a single entry. There is a variant called &(ldapm)&
6564 that permits values from multiple entries to be returned. A third variant
6565 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6566 any attribute values. See section &<<SECTldap>>&.
6567 .next
6568 .cindex "MySQL" "lookup type"
6569 .cindex "lookup" "MySQL"
6570 &(mysql)&: The format of the query is an SQL statement that is passed to a
6571 MySQL database. See section &<<SECTsql>>&.
6572 .next
6573 .cindex "NIS+ lookup type"
6574 .cindex "lookup" "NIS+"
6575 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6576 the field to be returned. See section &<<SECTnisplus>>&.
6577 .next
6578 .cindex "Oracle" "lookup type"
6579 .cindex "lookup" "Oracle"
6580 &(oracle)&: The format of the query is an SQL statement that is passed to an
6581 Oracle database. See section &<<SECTsql>>&.
6582 .next
6583 .cindex "lookup" "passwd"
6584 .cindex "passwd lookup type"
6585 .cindex "&_/etc/passwd_&"
6586 &(passwd)& is a query-style lookup with queries that are just user names. The
6587 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6588 success, the result string is the same as you would get from an &(lsearch)&
6589 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6590 password value. For example:
6591 .code
6592 *:42:42:King Rat:/home/kr:/bin/bash
6593 .endd
6594 .next
6595 .cindex "PostgreSQL lookup type"
6596 .cindex "lookup" "PostgreSQL"
6597 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6598 PostgreSQL database. See section &<<SECTsql>>&.
6599
6600 .next
6601 .cindex "sqlite lookup type"
6602 .cindex "lookup" "sqlite"
6603 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6604 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6605
6606 .next
6607 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6608 not likely to be useful in normal operation.
6609 .next
6610 .cindex "whoson lookup type"
6611 .cindex "lookup" "whoson"
6612 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6613 allows a server to check whether a particular (dynamically allocated) IP
6614 address is currently allocated to a known (trusted) user and, optionally, to
6615 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6616 at one time for &"POP before SMTP"& authentication, but that approach has been
6617 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6618 &"POP before SMTP"& checking using ACL statements such as
6619 .code
6620 require condition = \
6621   ${lookup whoson {$sender_host_address}{yes}{no}}
6622 .endd
6623 The query consists of a single IP address. The value returned is the name of
6624 the authenticated user, which is stored in the variable &$value$&. However, in
6625 this example, the data in &$value$& is not used; the result of the lookup is
6626 one of the fixed strings &"yes"& or &"no"&.
6627 .endlist
6628
6629
6630
6631 .section "Temporary errors in lookups" "SECID63"
6632 .cindex "lookup" "temporary error in"
6633 Lookup functions can return temporary error codes if the lookup cannot be
6634 completed. For example, an SQL or LDAP database might be unavailable. For this
6635 reason, it is not advisable to use a lookup that might do this for critical
6636 options such as a list of local domains.
6637
6638 When a lookup cannot be completed in a router or transport, delivery
6639 of the message (to the relevant address) is deferred, as for any other
6640 temporary error. In other circumstances Exim may assume the lookup has failed,
6641 or may give up altogether.
6642
6643
6644
6645 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6646 .cindex "wildcard lookups"
6647 .cindex "lookup" "default values"
6648 .cindex "lookup" "wildcard"
6649 .cindex "lookup" "* added to type"
6650 .cindex "default" "in single-key lookups"
6651 In this context, a &"default value"& is a value specified by the administrator
6652 that is to be used if a lookup fails.
6653
6654 &*Note:*& This section applies only to single-key lookups. For query-style
6655 lookups, the facilities of the query language must be used. An attempt to
6656 specify a default for a query-style lookup provokes an error.
6657
6658 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6659 and the initial lookup fails, the key &"*"& is looked up in the file to
6660 provide a default value. See also the section on partial matching below.
6661
6662 .cindex "*@ with single-key lookup"
6663 .cindex "lookup" "*@ added to type"
6664 .cindex "alias file" "per-domain default"
6665 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6666 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6667 character, a second lookup is done with everything before the last @ replaced
6668 by *. This makes it possible to provide per-domain defaults in alias files
6669 that include the domains in the keys. If the second lookup fails (or doesn't
6670 take place because there is no @ in the key), &"*"& is looked up.
6671 For example, a &(redirect)& router might contain:
6672 .code
6673 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6674 .endd
6675 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6676 looks up these keys, in this order:
6677 .code
6678 jane@eyre.example
6679 *@eyre.example
6680 *
6681 .endd
6682 The data is taken from whichever key it finds first. &*Note*&: In an
6683 &(lsearch)& file, this does not mean the first of these keys in the file. A
6684 complete scan is done for each key, and only if it is not found at all does
6685 Exim move on to try the next key.
6686
6687
6688
6689 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6690 .cindex "partial matching"
6691 .cindex "wildcard lookups"
6692 .cindex "lookup" "partial matching"
6693 .cindex "lookup" "wildcard"
6694 .cindex "asterisk" "in search type"
6695 The normal operation of a single-key lookup is to search the file for an exact
6696 match with the given key. However, in a number of situations where domains are
6697 being looked up, it is useful to be able to do partial matching. In this case,
6698 information in the file that has a key starting with &"*."& is matched by any
6699 domain that ends with the components that follow the full stop. For example, if
6700 a key in a DBM file is
6701 .code
6702 *.dates.fict.example
6703 .endd
6704 then when partial matching is enabled this is matched by (amongst others)
6705 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6706 by &'dates.fict.example'&, if that does not appear as a separate key in the
6707 file.
6708
6709 &*Note*&: Partial matching is not available for query-style lookups. It is
6710 also not available for any lookup items in address lists (see section
6711 &<<SECTaddresslist>>&).
6712
6713 Partial matching is implemented by doing a series of separate lookups using
6714 keys constructed by modifying the original subject key. This means that it can
6715 be used with any of the single-key lookup types, provided that
6716 partial matching keys
6717 beginning with a special prefix (default &"*."&) are included in the data file.
6718 Keys in the file that do not begin with the prefix are matched only by
6719 unmodified subject keys when partial matching is in use.
6720
6721 Partial matching is requested by adding the string &"partial-"& to the front of
6722 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6723 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6724 is added at the start of the subject key, and it is looked up again. If that
6725 fails, further lookups are tried with dot-separated components removed from the
6726 start of the subject key, one-by-one, and &"*."& added on the front of what
6727 remains.
6728
6729 A minimum number of two non-* components are required. This can be adjusted
6730 by including a number before the hyphen in the search type. For example,
6731 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6732 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6733 subject key is &'2250.dates.fict.example'& then the following keys are looked
6734 up when the minimum number of non-* components is two:
6735 .code
6736 2250.dates.fict.example
6737 *.2250.dates.fict.example
6738 *.dates.fict.example
6739 *.fict.example
6740 .endd
6741 As soon as one key in the sequence is successfully looked up, the lookup
6742 finishes.
6743
6744 .cindex "lookup" "partial matching &-- changing prefix"
6745 .cindex "prefix" "for partial matching"
6746 The use of &"*."& as the partial matching prefix is a default that can be
6747 changed. The motivation for this feature is to allow Exim to operate with file
6748 formats that are used by other MTAs. A different prefix can be supplied in
6749 parentheses instead of the hyphen after &"partial"&. For example:
6750 .code
6751 domains = partial(.)lsearch;/some/file
6752 .endd
6753 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6754 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6755 components is unchanged). The prefix may consist of any punctuation characters
6756 other than a closing parenthesis. It may be empty, for example:
6757 .code
6758 domains = partial1()cdb;/some/file
6759 .endd
6760 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6761 &`a.b.c`&, &`b.c`&, and &`c`&.
6762
6763 If &"partial0"& is specified, what happens at the end (when the lookup with
6764 just one non-wild component has failed, and the original key is shortened right
6765 down to the null string) depends on the prefix:
6766
6767 .ilist
6768 If the prefix has zero length, the whole lookup fails.
6769 .next
6770 If the prefix has length 1, a lookup for just the prefix is done. For
6771 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6772 .next
6773 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6774 remainder is looked up. With the default prefix, therefore, the final lookup is
6775 for &"*"& on its own.
6776 .next
6777 Otherwise, the whole prefix is looked up.
6778 .endlist
6779
6780
6781 If the search type ends in &"*"& or &"*@"& (see section
6782 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6783 this implies happens after all partial lookups have failed. If &"partial0"& is
6784 specified, adding &"*"& to the search type has no effect with the default
6785 prefix, because the &"*"& key is already included in the sequence of partial
6786 lookups. However, there might be a use for lookup types such as
6787 &"partial0(.)lsearch*"&.
6788
6789 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6790 in domain lists and the like. Partial matching works only in terms of
6791 dot-separated components; a key such as &`*fict.example`&
6792 in a database file is useless, because the asterisk in a partial matching
6793 subject key is always followed by a dot.
6794
6795
6796
6797
6798 .section "Lookup caching" "SECID64"
6799 .cindex "lookup" "caching"
6800 .cindex "caching" "lookup data"
6801 Exim caches all lookup results in order to avoid needless repetition of
6802 lookups. However, because (apart from the daemon) Exim operates as a collection
6803 of independent, short-lived processes, this caching applies only within a
6804 single Exim process. There is no inter-process lookup caching facility.
6805
6806 For single-key lookups, Exim keeps the relevant files open in case there is
6807 another lookup that needs them. In some types of configuration this can lead to
6808 many files being kept open for messages with many recipients. To avoid hitting
6809 the operating system limit on the number of simultaneously open files, Exim
6810 closes the least recently used file when it needs to open more files than its
6811 own internal limit, which can be changed via the &%lookup_open_max%& option.
6812
6813 The single-key lookup files are closed and the lookup caches are flushed at
6814 strategic points during delivery &-- for example, after all routing is
6815 complete.
6816
6817
6818
6819
6820 .section "Quoting lookup data" "SECID65"
6821 .cindex "lookup" "quoting"
6822 .cindex "quoting" "in lookups"
6823 When data from an incoming message is included in a query-style lookup, there
6824 is the possibility of special characters in the data messing up the syntax of
6825 the query. For example, a NIS+ query that contains
6826 .code
6827 [name=$local_part]
6828 .endd
6829 will be broken if the local part happens to contain a closing square bracket.
6830 For NIS+, data can be enclosed in double quotes like this:
6831 .code
6832 [name="$local_part"]
6833 .endd
6834 but this still leaves the problem of a double quote in the data. The rule for
6835 NIS+ is that double quotes must be doubled. Other lookup types have different
6836 rules, and to cope with the differing requirements, an expansion operator
6837 of the following form is provided:
6838 .code
6839 ${quote_<lookup-type>:<string>}
6840 .endd
6841 For example, the safest way to write the NIS+ query is
6842 .code
6843 [name="${quote_nisplus:$local_part}"]
6844 .endd
6845 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6846 operator can be used for all lookup types, but has no effect for single-key
6847 lookups, since no quoting is ever needed in their key strings.
6848
6849
6850
6851
6852 .section "More about dnsdb" "SECTdnsdb"
6853 .cindex "dnsdb lookup"
6854 .cindex "lookup" "dnsdb"
6855 .cindex "DNS" "as a lookup type"
6856 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6857 of a record type and a domain name, separated by an equals sign. For example,
6858 an expansion string could contain:
6859 .code
6860 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6861 .endd
6862 If the lookup succeeds, the result is placed in &$value$&, which in this case
6863 is used on its own as the result. If the lookup does not succeed, the
6864 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6865 &<<SECTforexpfai>>& for an explanation of what this means.
6866
6867 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6868 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6869 configured). If no type is given, TXT is assumed. When the type is PTR,
6870 the data can be an IP address, written as normal; inversion and the addition of
6871 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6872 .code
6873 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6874 .endd
6875 If the data for a PTR record is not a syntactically valid IP address, it is not
6876 altered and nothing is added.
6877
6878 .cindex "MX record" "in &(dnsdb)& lookup"
6879 .cindex "SRV record" "in &(dnsdb)& lookup"
6880 For an MX lookup, both the preference value and the host name are returned for
6881 each record, separated by a space. For an SRV lookup, the priority, weight,
6882 port, and host name are returned for each record, separated by spaces.
6883
6884 For any record type, if multiple records are found (or, for A6 lookups, if a
6885 single record leads to multiple addresses), the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895
6896 .cindex "TXT record" "in &(dnsdb)& lookup"
6897 .cindex "SPF record" "in &(dnsdb)& lookup"
6898 For TXT records with multiple items of data, only the first item is returned,
6899 unless a separator for them is specified using a comma after the separator
6900 character followed immediately by the TXT record item separator. To concatenate
6901 items without a separator, use a semicolon instead. For SPF records the
6902 default behaviour is to concatenate multiple items without using a separator.
6903 .code
6904 ${lookup dnsdb{>\n,: txt=a.b.example}}
6905 ${lookup dnsdb{>\n; txt=a.b.example}}
6906 ${lookup dnsdb{spf=example.org}}
6907 .endd
6908 It is permitted to specify a space as the separator character. Further
6909 white space is ignored.
6910
6911 .section "Pseudo dnsdb record types" "SECID66"
6912 .cindex "MX record" "in &(dnsdb)& lookup"
6913 By default, both the preference value and the host name are returned for
6914 each MX record, separated by a space. If you want only host names, you can use
6915 the pseudo-type MXH:
6916 .code
6917 ${lookup dnsdb{mxh=a.b.example}}
6918 .endd
6919 In this case, the preference values are omitted, and just the host names are
6920 returned.
6921
6922 .cindex "name server for enclosing domain"
6923 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6924 records on the given domain, but if none are found, it removes the first
6925 component of the domain name, and tries again. This process continues until NS
6926 records are found or there are no more components left (or there is a DNS
6927 error). In other words, it may return the name servers for a top-level domain,
6928 but it never returns the root name servers. If there are no NS records for the
6929 top-level domain, the lookup fails. Consider these examples:
6930 .code
6931 ${lookup dnsdb{zns=xxx.quercite.com}}
6932 ${lookup dnsdb{zns=xxx.edu}}
6933 .endd
6934 Assuming that in each case there are no NS records for the full domain name,
6935 the first returns the name servers for &%quercite.com%&, and the second returns
6936 the name servers for &%edu%&.
6937
6938 You should be careful about how you use this lookup because, unless the
6939 top-level domain does not exist, the lookup always returns some host names. The
6940 sort of use to which this might be put is for seeing if the name servers for a
6941 given domain are on a blacklist. You can probably assume that the name servers
6942 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6943 such a list.
6944
6945 .cindex "CSA" "in &(dnsdb)& lookup"
6946 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6947 records according to the CSA rules, which are described in section
6948 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6949 not sufficient because of the extra parent domain search behaviour of CSA. The
6950 result of a successful lookup such as:
6951 .code
6952 ${lookup dnsdb {csa=$sender_helo_name}}
6953 .endd
6954 has two space-separated fields: an authorization code and a target host name.
6955 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6956 authorization required but absent, or &"?"& for unknown.
6957
6958 .cindex "A+" "in &(dnsdb)& lookup"
6959 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6960 and then an A lookup.  All results are returned; defer processing
6961 (see below) is handled separately for each lookup.  Example:
6962 .code
6963 ${lookup dnsdb {>; a+=$sender_helo_name}}
6964 .endd
6965
6966
6967 .section "Multiple dnsdb lookups" "SECID67"
6968 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6969 However, you can specify a list of domains or IP addresses in a single
6970 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6971 the default separator, but with the ability to change this. For example:
6972 .code
6973 ${lookup dnsdb{one.domain.com:two.domain.com}}
6974 ${lookup dnsdb{a=one.host.com:two.host.com}}
6975 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6976 .endd
6977 In order to retain backwards compatibility, there is one special case: if
6978 the lookup type is PTR and no change of separator is specified, Exim looks
6979 to see if the rest of the string is precisely one IPv6 address. In this
6980 case, it does not treat it as a list.
6981
6982 The data from each lookup is concatenated, with newline separators by default,
6983 in the same way that multiple DNS records for a single item are handled. A
6984 different separator can be specified, as described above.
6985
6986 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6987 each followed by a comma,
6988 that may appear before the record type.
6989
6990 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6991 temporary DNS error for any of them, the behaviour is controlled by
6992 a defer-option modifier.
6993 The possible keywords are
6994 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6995 With &"strict"& behaviour, any temporary DNS error causes the
6996 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6997 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6998 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6999 error causes the whole lookup to defer only if none of the other lookups
7000 succeed. The default is &"lax"&, so the following lookups are equivalent:
7001 .code
7002 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7003 ${lookup dnsdb{a=one.host.com:two.host.com}}
7004 .endd
7005 Thus, in the default case, as long as at least one of the DNS lookups
7006 yields some data, the lookup succeeds.
7007
7008 .cindex "DNSSEC" "dns lookup"
7009 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7010 The possible keywords are
7011 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7012 With &"strict"& or &"lax"& DNSSEC information is requested
7013 with the lookup.
7014 With &"strict"& a response from the DNS resolver that
7015 is not labelled as authenticated data
7016 is treated as equivalent to a temporary DNS error.
7017 The default is &"never"&.
7018
7019 See also the &$lookup_dnssec_authenticated$& variable.
7020
7021
7022
7023
7024 .section "More about LDAP" "SECTldap"
7025 .cindex "LDAP" "lookup, more about"
7026 .cindex "lookup" "LDAP"
7027 .cindex "Solaris" "LDAP"
7028 The original LDAP implementation came from the University of Michigan; this has
7029 become &"Open LDAP"&, and there are now two different releases. Another
7030 implementation comes from Netscape, and Solaris 7 and subsequent releases
7031 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7032 the lookup function level, their error handling is different. For this reason
7033 it is necessary to set a compile-time variable when building Exim with LDAP, to
7034 indicate which LDAP library is in use. One of the following should appear in
7035 your &_Local/Makefile_&:
7036 .code
7037 LDAP_LIB_TYPE=UMICHIGAN
7038 LDAP_LIB_TYPE=OPENLDAP1
7039 LDAP_LIB_TYPE=OPENLDAP2
7040 LDAP_LIB_TYPE=NETSCAPE
7041 LDAP_LIB_TYPE=SOLARIS
7042 .endd
7043 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7044 same interface as the University of Michigan version.
7045
7046 There are three LDAP lookup types in Exim. These behave slightly differently in
7047 the way they handle the results of a query:
7048
7049 .ilist
7050 &(ldap)& requires the result to contain just one entry; if there are more, it
7051 gives an error.
7052 .next
7053 &(ldapdn)& also requires the result to contain just one entry, but it is the
7054 Distinguished Name that is returned rather than any attribute values.
7055 .next
7056 &(ldapm)& permits the result to contain more than one entry; the attributes
7057 from all of them are returned.
7058 .endlist
7059
7060
7061 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7062 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7063 the data returned by a successful lookup is described in the next section.
7064 First we explain how LDAP queries are coded.
7065
7066
7067 .section "Format of LDAP queries" "SECTforldaque"
7068 .cindex "LDAP" "query format"
7069 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7070 the configuration of a &(redirect)& router one might have this setting:
7071 .code
7072 data = ${lookup ldap \
7073   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7074   c=UK?mailbox?base?}}
7075 .endd
7076 .cindex "LDAP" "with TLS"
7077 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7078 secure (encrypted) LDAP connections. The second of these ensures that an
7079 encrypted TLS connection is used.
7080
7081 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7082 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7083 See the &%ldap_start_tls%& option.
7084
7085 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7086 controlled. Every part of the TLS configuration can be configured by settings in
7087 &_exim.conf_&. Depending on the version of the client libraries installed on
7088 your system, some of the initialization may have required setting options in
7089 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7090 certificates. This revealed a nuance where the current UID that exim was
7091 running as could affect which config files it read. With Exim 4.83, these
7092 methods become optional, only taking effect if not specifically set in
7093 &_exim.conf_&.
7094
7095
7096 .section "LDAP quoting" "SECID68"
7097 .cindex "LDAP" "quoting"
7098 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7099 and the second because the LDAP query is represented as a URL. Furthermore,
7100 within an LDAP query, two different kinds of quoting are required. For this
7101 reason, there are two different LDAP-specific quoting operators.
7102
7103 The &%quote_ldap%& operator is designed for use on strings that are part of
7104 filter specifications. Conceptually, it first does the following conversions on
7105 the string:
7106 .code
7107 *   =>   \2A
7108 (   =>   \28
7109 )   =>   \29
7110 \   =>   \5C
7111 .endd
7112 in accordance with RFC 2254. The resulting string is then quoted according
7113 to the rules for URLs, that is, all non-alphanumeric characters except
7114 .code
7115 ! $ ' - . _ ( ) * +
7116 .endd
7117 are converted to their hex values, preceded by a percent sign. For example:
7118 .code
7119 ${quote_ldap: a(bc)*, a<yz>; }
7120 .endd
7121 yields
7122 .code
7123 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7124 .endd
7125 Removing the URL quoting, this is (with a leading and a trailing space):
7126 .code
7127 a\28bc\29\2A, a<yz>;
7128 .endd
7129 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7130 base DN specifications in queries. Conceptually, it first converts the string
7131 by inserting a backslash in front of any of the following characters:
7132 .code
7133 , + " \ < > ;
7134 .endd
7135 It also inserts a backslash before any leading spaces or # characters, and
7136 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7137 is then quoted according to the rules for URLs. For example:
7138 .code
7139 ${quote_ldap_dn: a(bc)*, a<yz>; }
7140 .endd
7141 yields
7142 .code
7143 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7144 .endd
7145 Removing the URL quoting, this is (with a trailing space):
7146 .code
7147 \ a(bc)*\, a\<yz\>\;\
7148 .endd
7149 There are some further comments about quoting in the section on LDAP
7150 authentication below.
7151
7152
7153 .section "LDAP connections" "SECID69"
7154 .cindex "LDAP" "connections"
7155 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7156 is in use, via a Unix domain socket. The example given above does not specify
7157 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7158 by starting it with
7159 .code
7160 ldap://<hostname>:<port>/...
7161 .endd
7162 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7163 used. When no server is specified in a query, a list of default servers is
7164 taken from the &%ldap_default_servers%& configuration option. This supplies a
7165 colon-separated list of servers which are tried in turn until one successfully
7166 handles a query, or there is a serious error. Successful handling either
7167 returns the requested data, or indicates that it does not exist. Serious errors
7168 are syntactical, or multiple values when only a single value is expected.
7169 Errors which cause the next server to be tried are connection failures, bind
7170 failures, and timeouts.
7171
7172 For each server name in the list, a port number can be given. The standard way
7173 of specifying a host and port is to use a colon separator (RFC 1738). Because
7174 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7175 doubled. For example
7176 .code
7177 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7178 .endd
7179 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7180 to the LDAP library with no server name, and the library's default (normally
7181 the local host) is used.
7182
7183 If you are using the OpenLDAP library, you can connect to an LDAP server using
7184 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7185 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7186 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7187 not available.
7188
7189 For this type of connection, instead of a host name for the server, a pathname
7190 for the socket is required, and the port number is not relevant. The pathname
7191 can be specified either as an item in &%ldap_default_servers%&, or inline in
7192 the query. In the former case, you can have settings such as
7193 .code
7194 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7195 .endd
7196 When the pathname is given in the query, you have to escape the slashes as
7197 &`%2F`& to fit in with the LDAP URL syntax. For example:
7198 .code
7199 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7200 .endd
7201 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7202 a pathname, it uses the Unix domain socket code, even if the query actually
7203 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7204 socket connection. This behaviour means that you can use a setting of
7205 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7206 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7207 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7208 backup host.
7209
7210 If an explicit &`ldapi`& type is given in a query when a host name is
7211 specified, an error is diagnosed. However, if there are more items in
7212 &%ldap_default_servers%&, they are tried. In other words:
7213
7214 .ilist
7215 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7216 interface.
7217 .next
7218 Using &`ldapi`& with a host name causes an error.
7219 .endlist
7220
7221
7222 Using &`ldapi`& with no host or path in the query, and no setting of
7223 &%ldap_default_servers%&, does whatever the library does by default.
7224
7225
7226
7227 .section "LDAP authentication and control information" "SECID70"
7228 .cindex "LDAP" "authentication"
7229 The LDAP URL syntax provides no way of passing authentication and other control
7230 information to the server. To make this possible, the URL in an LDAP query may
7231 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7232 spaces. If a value contains spaces it must be enclosed in double quotes, and
7233 when double quotes are used, backslash is interpreted in the usual way inside
7234 them. The following names are recognized:
7235 .display
7236 &`DEREFERENCE`&  set the dereferencing parameter
7237 &`NETTIME    `&  set a timeout for a network operation
7238 &`USER       `&  set the DN, for authenticating the LDAP bind
7239 &`PASS       `&  set the password, likewise
7240 &`REFERRALS  `&  set the referrals parameter
7241 &`SERVERS    `&  set alternate server list for this query only
7242 &`SIZE       `&  set the limit for the number of entries returned
7243 &`TIME       `&  set the maximum waiting time for a query
7244 .endd
7245 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7246 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7247 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7248 library from trying to follow referrals issued by the LDAP server.
7249
7250 The name CONNECT is an obsolete name for NETTIME, retained for
7251 backwards compatibility. This timeout (specified as a number of seconds) is
7252 enforced from the client end for operations that can be carried out over a
7253 network. Specifically, it applies to network connections and calls to the
7254 &'ldap_result()'& function. If the value is greater than zero, it is used if
7255 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7256 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7257 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7258 Netscape SDK; for OpenLDAP no action is taken.
7259
7260 The TIME parameter (also a number of seconds) is passed to the server to
7261 set a server-side limit on the time taken to complete a search.
7262
7263 The SERVERS parameter allows you to specify an alternate list of ldap servers
7264 to use for an individual lookup.  The global ldap_servers option provides a
7265 default list of ldap servers, and a single lookup can specify a single ldap
7266 server to use.  But when you need to do a lookup with a list of servers that is
7267 different than the default list (maybe different order, maybe a completely
7268 different set of servers), the SERVERS parameter allows you to specify this
7269 alternate list (colon-separated).
7270
7271 Here is an example of an LDAP query in an Exim lookup that uses some of these
7272 values. This is a single line, folded to fit on the page:
7273 .code
7274 ${lookup ldap
7275   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7276   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7277   {$value}fail}
7278 .endd
7279 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7280 any of the auxiliary data. Exim configuration settings that include lookups
7281 which contain password information should be preceded by &"hide"& to prevent
7282 non-admin users from using the &%-bP%& option to see their values.
7283
7284 The auxiliary data items may be given in any order. The default is no
7285 connection timeout (the system timeout is used), no user or password, no limit
7286 on the number of entries returned, and no time limit on queries.
7287
7288 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7289 removes any URL quoting that it may contain before passing it LDAP. Apparently
7290 some libraries do this for themselves, but some do not. Removing the URL
7291 quoting has two advantages:
7292
7293 .ilist
7294 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7295 DNs as with DNs inside actual queries.
7296 .next
7297 It permits spaces inside USER= DNs.
7298 .endlist
7299
7300 For example, a setting such as
7301 .code
7302 USER=cn=${quote_ldap_dn:$1}
7303 .endd
7304 should work even if &$1$& contains spaces.
7305
7306 Expanded data for the PASS= value should be quoted using the &%quote%&
7307 expansion operator, rather than the LDAP quote operators. The only reason this
7308 field needs quoting is to ensure that it conforms to the Exim syntax, which
7309 does not allow unquoted spaces. For example:
7310 .code
7311 PASS=${quote:$3}
7312 .endd
7313 The LDAP authentication mechanism can be used to check passwords as part of
7314 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7315 &<<CHAPexpand>>&.
7316
7317
7318
7319 .section "Format of data returned by LDAP" "SECID71"
7320 .cindex "LDAP" "returned data formats"
7321 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7322 as a sequence of values, for example
7323 .code
7324 cn=manager, o=University of Cambridge, c=UK
7325 .endd
7326 The &(ldap)& lookup type generates an error if more than one entry matches the
7327 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7328 the result between the data from different entries. It is possible for multiple
7329 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7330 you know that whatever values are returned all came from a single entry in the
7331 directory.
7332
7333 In the common case where you specify a single attribute in your LDAP query, the
7334 result is not quoted, and does not contain the attribute name. If the attribute
7335 has multiple values, they are separated by commas.
7336
7337 If you specify multiple attributes, the result contains space-separated, quoted
7338 strings, each preceded by the attribute name and an equals sign. Within the
7339 quotes, the quote character, backslash, and newline are escaped with
7340 backslashes, and commas are used to separate multiple values for the attribute.
7341 .new
7342 Any commas in attribute values are doubled
7343 (permitting treatment of the values as a comma-separated list).
7344 .wen
7345 Apart from the escaping, the string within quotes takes the same form as the
7346 output when a single attribute is requested. Specifying no attributes is the
7347 same as specifying all of an entry's attributes.
7348
7349 .new
7350 Here are some examples of the output format. The first line of each pair is an
7351 LDAP query, and the second is the data that is returned. The attribute called
7352 &%attr1%& has two values, one of them with an embedded comma, whereas
7353 &%attr2%& has only one value:
7354 .code
7355 ldap:///o=base?attr1?sub?(uid=fred)
7356 value1.1,value1,,2
7357
7358 ldap:///o=base?attr2?sub?(uid=fred)
7359 value two
7360
7361 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7362 attr1="value1.1,value1,,2" attr2="value two"
7363
7364 ldap:///o=base??sub?(uid=fred)
7365 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7366 .endd
7367 .wen
7368 You can
7369 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7370 results of LDAP lookups.
7371 The &%extract%& operator in string expansions can be used to pick out
7372 individual fields from data that consists of &'key'&=&'value'& pairs.
7373 .new
7374 The &%listextract%& operator should be used to pick out individual values
7375 of attributes, even when only a single value is expected.
7376 The doubling of embedded commas allows you to use the returned data as a
7377 comma separated list (using the "<," syntax for changing the input list separator).
7378 .wen
7379
7380
7381
7382
7383 .section "More about NIS+" "SECTnisplus"
7384 .cindex "NIS+ lookup type"
7385 .cindex "lookup" "NIS+"
7386 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7387 and field name. If this is given, the result of a successful query is the
7388 contents of the named field; otherwise the result consists of a concatenation
7389 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7390 values containing spaces are quoted. For example, the query
7391 .code
7392 [name=mg1456],passwd.org_dir
7393 .endd
7394 might return the string
7395 .code
7396 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7397 home=/home/mg1456 shell=/bin/bash shadow=""
7398 .endd
7399 (split over two lines here to fit on the page), whereas
7400 .code
7401 [name=mg1456],passwd.org_dir:gcos
7402 .endd
7403 would just return
7404 .code
7405 Martin Guerre
7406 .endd
7407 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7408 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7409 operator is to double any quote characters within the text.
7410
7411
7412
7413 .section "SQL lookups" "SECTsql"
7414 .cindex "SQL lookup types"
7415 .cindex "MySQL" "lookup type"
7416 .cindex "PostgreSQL lookup type"
7417 .cindex "lookup" "MySQL"
7418 .cindex "lookup" "PostgreSQL"
7419 .cindex "Oracle" "lookup type"
7420 .cindex "lookup" "Oracle"
7421 .cindex "InterBase lookup type"
7422 .cindex "lookup" "InterBase"
7423 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7424 databases. Queries for these databases contain SQL statements, so an example
7425 might be
7426 .code
7427 ${lookup mysql{select mailbox from users where id='userx'}\
7428   {$value}fail}
7429 .endd
7430 If the result of the query contains more than one field, the data for each
7431 field in the row is returned, preceded by its name, so the result of
7432 .code
7433 ${lookup pgsql{select home,name from users where id='userx'}\
7434   {$value}}
7435 .endd
7436 might be
7437 .code
7438 home=/home/userx name="Mister X"
7439 .endd
7440 Empty values and values containing spaces are double quoted, with embedded
7441 quotes escaped by a backslash. If the result of the query contains just one
7442 field, the value is passed back verbatim, without a field name, for example:
7443 .code
7444 Mister X
7445 .endd
7446 If the result of the query yields more than one row, it is all concatenated,
7447 with a newline between the data for each row.
7448
7449
7450 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7451 .cindex "MySQL" "lookup type"
7452 .cindex "PostgreSQL lookup type"
7453 .cindex "lookup" "MySQL"
7454 .cindex "lookup" "PostgreSQL"
7455 .cindex "Oracle" "lookup type"
7456 .cindex "lookup" "Oracle"
7457 .cindex "InterBase lookup type"
7458 .cindex "lookup" "InterBase"
7459 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7460 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7461 option (as appropriate) must be set to a colon-separated list of server
7462 information.
7463 (For MySQL and PostgreSQL only, the global option need not be set if all
7464 queries contain their own server information &-- see section
7465 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7466 items: host name, database name, user name, and password. In the case of
7467 Oracle, the host name field is used for the &"service name"&, and the database
7468 name field is not used and should be empty. For example:
7469 .code
7470 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7471 .endd
7472 Because password data is sensitive, you should always precede the setting with
7473 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7474 option. Here is an example where two MySQL servers are listed:
7475 .code
7476 hide mysql_servers = localhost/users/root/secret:\
7477                      otherhost/users/root/othersecret
7478 .endd
7479 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7480 because this is a colon-separated list, the colon has to be doubled. For each
7481 query, these parameter groups are tried in order until a connection is made and
7482 a query is successfully processed. The result of a query may be that no data is
7483 found, but that is still a successful query. In other words, the list of
7484 servers provides a backup facility, not a list of different places to look.
7485
7486 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7487 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7488 respectively, and the characters single-quote, double-quote, and backslash
7489 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7490 addition, escapes the percent and underscore characters. This cannot be done
7491 for MySQL because these escapes are not recognized in contexts where these
7492 characters are not special.
7493
7494 .section "Specifying the server in the query" "SECTspeserque"
7495 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7496 it is possible to specify a list of servers with an individual query. This is
7497 done by starting the query with
7498 .display
7499 &`servers=`&&'server1:server2:server3:...'&&`;`&
7500 .endd
7501 Each item in the list may take one of two forms:
7502 .olist
7503 If it contains no slashes it is assumed to be just a host name. The appropriate
7504 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7505 of the same name, and the remaining parameters (database, user, password) are
7506 taken from there.
7507 .next
7508 If it contains any slashes, it is taken as a complete parameter set.
7509 .endlist
7510 The list of servers is used in exactly the same way as the global list.
7511 Once a connection to a server has happened and a query has been
7512 successfully executed, processing of the lookup ceases.
7513
7514 This feature is intended for use in master/slave situations where updates
7515 are occurring and you want to update the master rather than a slave. If the
7516 master is in the list as a backup for reading, you might have a global setting
7517 like this:
7518 .code
7519 mysql_servers = slave1/db/name/pw:\
7520                 slave2/db/name/pw:\
7521                 master/db/name/pw
7522 .endd
7523 In an updating lookup, you could then write:
7524 .code
7525 ${lookup mysql{servers=master; UPDATE ...} }
7526 .endd
7527 That query would then be sent only to the master server. If, on the other hand,
7528 the master is not to be used for reading, and so is not present in the global
7529 option, you can still update it by a query of this form:
7530 .code
7531 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7532 .endd
7533
7534
7535 .section "Special MySQL features" "SECID73"
7536 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7537 causes a connection to the server on the local host by means of a Unix domain
7538 socket. An alternate socket can be specified in parentheses. The full syntax of
7539 each item in &%mysql_servers%& is:
7540 .display
7541 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7542   <&'user'&>/<&'password'&>
7543 .endd
7544 Any of the three sub-parts of the first field can be omitted. For normal use on
7545 the local host it can be left blank or set to just &"localhost"&.
7546
7547 No database need be supplied &-- but if it is absent here, it must be given in
7548 the queries.
7549
7550 If a MySQL query is issued that does not request any data (an insert, update,
7551 or delete command), the result of the lookup is the number of rows affected.
7552
7553 &*Warning*&: This can be misleading. If an update does not actually change
7554 anything (for example, setting a field to the value it already has), the result
7555 is zero because no rows are affected.
7556
7557
7558 .section "Special PostgreSQL features" "SECID74"
7559 PostgreSQL lookups can also use Unix domain socket connections to the database.
7560 This is usually faster and costs less CPU time than a TCP/IP connection.
7561 However it can be used only if the mail server runs on the same machine as the
7562 database server. A configuration line for PostgreSQL via Unix domain sockets
7563 looks like this:
7564 .code
7565 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7566 .endd
7567 In other words, instead of supplying a host name, a path to the socket is
7568 given. The path name is enclosed in parentheses so that its slashes aren't
7569 visually confused with the delimiters for the other server parameters.
7570
7571 If a PostgreSQL query is issued that does not request any data (an insert,
7572 update, or delete command), the result of the lookup is the number of rows
7573 affected.
7574
7575 .section "More about SQLite" "SECTsqlite"
7576 .cindex "lookup" "SQLite"
7577 .cindex "sqlite lookup type"
7578 SQLite is different to the other SQL lookups because a file name is required in
7579 addition to the SQL query. An SQLite database is a single file, and there is no
7580 daemon as in the other SQL databases. The interface to Exim requires the name
7581 of the file, as an absolute path, to be given at the start of the query. It is
7582 separated from the query by white space. This means that the path name cannot
7583 contain white space. Here is a lookup expansion example:
7584 .code
7585 ${lookup sqlite {/some/thing/sqlitedb \
7586   select name from aliases where id='userx';}}
7587 .endd
7588 In a list, the syntax is similar. For example:
7589 .code
7590 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7591    select * from relays where ip='$sender_host_address';
7592 .endd
7593 The only character affected by the &%quote_sqlite%& operator is a single
7594 quote, which it doubles.
7595
7596 The SQLite library handles multiple simultaneous accesses to the database
7597 internally. Multiple readers are permitted, but only one process can
7598 update at once. Attempts to access the database while it is being updated
7599 are rejected after a timeout period, during which the SQLite library
7600 waits for the lock to be released. In Exim, the default timeout is set
7601 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7602 option.
7603 .ecindex IIDfidalo1
7604 .ecindex IIDfidalo2
7605
7606
7607 . ////////////////////////////////////////////////////////////////////////////
7608 . ////////////////////////////////////////////////////////////////////////////
7609
7610 .chapter "Domain, host, address, and local part lists" &&&
7611          "CHAPdomhosaddlists" &&&
7612          "Domain, host, and address lists"
7613 .scindex IIDdohoadli "lists of domains; hosts; etc."
7614 A number of Exim configuration options contain lists of domains, hosts,
7615 email addresses, or local parts. For example, the &%hold_domains%& option
7616 contains a list of domains whose delivery is currently suspended. These lists
7617 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7618 arguments to expansion conditions such as &%match_domain%&.
7619
7620 Each item in one of these lists is a pattern to be matched against a domain,
7621 host, email address, or local part, respectively. In the sections below, the
7622 different types of pattern for each case are described, but first we cover some
7623 general facilities that apply to all four kinds of list.
7624
7625
7626
7627 .section "Expansion of lists" "SECID75"
7628 .cindex "expansion" "of lists"
7629 Each list is expanded as a single string before it is used. The result of
7630 expansion must be a list, possibly containing empty items, which is split up
7631 into separate items for matching. By default, colon is the separator character,
7632 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7633 &<<SECTempitelis>>& for details of the list syntax; the second of these
7634 discusses the way to specify empty list items.
7635
7636
7637 If the string expansion is forced to fail, Exim behaves as if the item it is
7638 testing (domain, host, address, or local part) is not in the list. Other
7639 expansion failures cause temporary errors.
7640
7641 If an item in a list is a regular expression, backslashes, dollars and possibly
7642 other special characters in the expression must be protected against
7643 misinterpretation by the string expander. The easiest way to do this is to use
7644 the &`\N`& expansion feature to indicate that the contents of the regular
7645 expression should not be expanded. For example, in an ACL you might have:
7646 .code
7647 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7648                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7649 .endd
7650 The first item is a regular expression that is protected from expansion by
7651 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7652 senders based on the receiving domain.
7653
7654
7655
7656
7657 .section "Negated items in lists" "SECID76"
7658 .cindex "list" "negation"
7659 .cindex "negation" "in lists"
7660 Items in a list may be positive or negative. Negative items are indicated by a
7661 leading exclamation mark, which may be followed by optional white space. A list
7662 defines a set of items (domains, etc). When Exim processes one of these lists,
7663 it is trying to find out whether a domain, host, address, or local part
7664 (respectively) is in the set that is defined by the list. It works like this:
7665
7666 The list is scanned from left to right. If a positive item is matched, the
7667 subject that is being checked is in the set; if a negative item is matched, the
7668 subject is not in the set. If the end of the list is reached without the
7669 subject having matched any of the patterns, it is in the set if the last item
7670 was a negative one, but not if it was a positive one. For example, the list in
7671 .code
7672 domainlist relay_to_domains = !a.b.c : *.b.c
7673 .endd
7674 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7675 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7676 list is positive. However, if the setting were
7677 .code
7678 domainlist relay_to_domains = !a.b.c
7679 .endd
7680 then all domains other than &'a.b.c'& would match because the last item in the
7681 list is negative. In other words, a list that ends with a negative item behaves
7682 as if it had an extra item &`:*`& on the end.
7683
7684 Another way of thinking about positive and negative items in lists is to read
7685 the connector as &"or"& after a positive item and as &"and"& after a negative
7686 item.
7687
7688
7689
7690 .section "File names in lists" "SECTfilnamlis"
7691 .cindex "list" "file name in"
7692 If an item in a domain, host, address, or local part list is an absolute file
7693 name (beginning with a slash character), each line of the file is read and
7694 processed as if it were an independent item in the list, except that further
7695 file names are not allowed,
7696 and no expansion of the data from the file takes place.
7697 Empty lines in the file are ignored, and the file may also contain comment
7698 lines:
7699
7700 .ilist
7701 For domain and host lists, if a # character appears anywhere in a line of the
7702 file, it and all following characters are ignored.
7703 .next
7704 Because local parts may legitimately contain # characters, a comment in an
7705 address list or local part list file is recognized only if # is preceded by
7706 white space or the start of the line. For example:
7707 .code
7708 not#comment@x.y.z   # but this is a comment
7709 .endd
7710 .endlist
7711
7712 Putting a file name in a list has the same effect as inserting each line of the
7713 file as an item in the list (blank lines and comments excepted). However, there
7714 is one important difference: the file is read each time the list is processed,
7715 so if its contents vary over time, Exim's behaviour changes.
7716
7717 If a file name is preceded by an exclamation mark, the sense of any match
7718 within the file is inverted. For example, if
7719 .code
7720 hold_domains = !/etc/nohold-domains
7721 .endd
7722 and the file contains the lines
7723 .code
7724 !a.b.c
7725 *.b.c
7726 .endd
7727 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7728 any domain matching &`*.b.c`& is not.
7729
7730
7731
7732 .section "An lsearch file is not an out-of-line list" "SECID77"
7733 As will be described in the sections that follow, lookups can be used in lists
7734 to provide indexed methods of checking list membership. There has been some
7735 confusion about the way &(lsearch)& lookups work in lists. Because
7736 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7737 sometimes thought that it is allowed to contain wild cards and other kinds of
7738 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7739 always fixed strings, just as for any other single-key lookup type.
7740
7741 If you want to use a file to contain wild-card patterns that form part of a
7742 list, just give the file name on its own, without a search type, as described
7743 in the previous section. You could also use the &(wildlsearch)& or
7744 &(nwildlsearch)&, but there is no advantage in doing this.
7745
7746
7747
7748
7749 .section "Named lists" "SECTnamedlists"
7750 .cindex "named lists"
7751 .cindex "list" "named"
7752 A list of domains, hosts, email addresses, or local parts can be given a name
7753 which is then used to refer to the list elsewhere in the configuration. This is
7754 particularly convenient if the same list is required in several different
7755 places. It also allows lists to be given meaningful names, which can improve
7756 the readability of the configuration. For example, it is conventional to define
7757 a domain list called &'local_domains'& for all the domains that are handled
7758 locally on a host, using a configuration line such as
7759 .code
7760 domainlist local_domains = localhost:my.dom.example
7761 .endd
7762 Named lists are referenced by giving their name preceded by a plus sign, so,
7763 for example, a router that is intended to handle local domains would be
7764 configured with the line
7765 .code
7766 domains = +local_domains
7767 .endd
7768 The first router in a configuration is often one that handles all domains
7769 except the local ones, using a configuration with a negated item like this:
7770 .code
7771 dnslookup:
7772   driver = dnslookup
7773   domains = ! +local_domains
7774   transport = remote_smtp
7775   no_more
7776 .endd
7777 The four kinds of named list are created by configuration lines starting with
7778 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7779 respectively. Then there follows the name that you are defining, followed by an
7780 equals sign and the list itself. For example:
7781 .code
7782 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7783 addresslist bad_senders = cdb;/etc/badsenders
7784 .endd
7785 A named list may refer to other named lists:
7786 .code
7787 domainlist  dom1 = first.example : second.example
7788 domainlist  dom2 = +dom1 : third.example
7789 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7790 .endd
7791 &*Warning*&: If the last item in a referenced list is a negative one, the
7792 effect may not be what you intended, because the negation does not propagate
7793 out to the higher level. For example, consider:
7794 .code
7795 domainlist  dom1 = !a.b
7796 domainlist  dom2 = +dom1 : *.b
7797 .endd
7798 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7799 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7800 means it matches the second list as well. The effect is not the same as
7801 .code
7802 domainlist  dom2 = !a.b : *.b
7803 .endd
7804 where &'x.y'& does not match. It's best to avoid negation altogether in
7805 referenced lists if you can.
7806
7807 Named lists may have a performance advantage. When Exim is routing an
7808 address or checking an incoming message, it caches the result of tests on named
7809 lists. So, if you have a setting such as
7810 .code
7811 domains = +local_domains
7812 .endd
7813 on several of your routers
7814 or in several ACL statements,
7815 the actual test is done only for the first one. However, the caching works only
7816 if there are no expansions within the list itself or any sublists that it
7817 references. In other words, caching happens only for lists that are known to be
7818 the same each time they are referenced.
7819
7820 By default, there may be up to 16 named lists of each type. This limit can be
7821 extended by changing a compile-time variable. The use of domain and host lists
7822 is recommended for concepts such as local domains, relay domains, and relay
7823 hosts. The default configuration is set up like this.
7824
7825
7826
7827 .section "Named lists compared with macros" "SECID78"
7828 .cindex "list" "named compared with macro"
7829 .cindex "macro" "compared with named list"
7830 At first sight, named lists might seem to be no different from macros in the
7831 configuration file. However, macros are just textual substitutions. If you
7832 write
7833 .code
7834 ALIST = host1 : host2
7835 auth_advertise_hosts = !ALIST
7836 .endd
7837 it probably won't do what you want, because that is exactly the same as
7838 .code
7839 auth_advertise_hosts = !host1 : host2
7840 .endd
7841 Notice that the second host name is not negated. However, if you use a host
7842 list, and write
7843 .code
7844 hostlist alist = host1 : host2
7845 auth_advertise_hosts = ! +alist
7846 .endd
7847 the negation applies to the whole list, and so that is equivalent to
7848 .code
7849 auth_advertise_hosts = !host1 : !host2
7850 .endd
7851
7852
7853 .section "Named list caching" "SECID79"
7854 .cindex "list" "caching of named"
7855 .cindex "caching" "named lists"
7856 While processing a message, Exim caches the result of checking a named list if
7857 it is sure that the list is the same each time. In practice, this means that
7858 the cache operates only if the list contains no $ characters, which guarantees
7859 that it will not change when it is expanded. Sometimes, however, you may have
7860 an expanded list that you know will be the same each time within a given
7861 message. For example:
7862 .code
7863 domainlist special_domains = \
7864            ${lookup{$sender_host_address}cdb{/some/file}}
7865 .endd
7866 This provides a list of domains that depends only on the sending host's IP
7867 address. If this domain list is referenced a number of times (for example,
7868 in several ACL lines, or in several routers) the result of the check is not
7869 cached by default, because Exim does not know that it is going to be the
7870 same list each time.
7871
7872 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7873 cache the result anyway. For example:
7874 .code
7875 domainlist_cache special_domains = ${lookup{...
7876 .endd
7877 If you do this, you should be absolutely sure that caching is going to do
7878 the right thing in all cases. When in doubt, leave it out.
7879
7880
7881
7882 .section "Domain lists" "SECTdomainlist"
7883 .cindex "domain list" "patterns for"
7884 .cindex "list" "domain list"
7885 Domain lists contain patterns that are to be matched against a mail domain.
7886 The following types of item may appear in domain lists:
7887
7888 .ilist
7889 .cindex "primary host name"
7890 .cindex "host name" "matched in domain list"
7891 .oindex "&%primary_hostname%&"
7892 .cindex "domain list" "matching primary host name"
7893 .cindex "@ in a domain list"
7894 If a pattern consists of a single @ character, it matches the local host name,
7895 as set by the &%primary_hostname%& option (or defaulted). This makes it
7896 possible to use the same configuration file on several different hosts that
7897 differ only in their names.
7898 .next
7899 .cindex "@[] in a domain list"
7900 .cindex "domain list" "matching local IP interfaces"
7901 .cindex "domain literal"
7902 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7903 in square brackets (as in an email address that contains a domain literal), but
7904 only if that IP address is recognized as local for email routing purposes. The
7905 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7906 control which of a host's several IP addresses are treated as local.
7907 In today's Internet, the use of domain literals is controversial.
7908 .next
7909 .cindex "@mx_any"
7910 .cindex "@mx_primary"
7911 .cindex "@mx_secondary"
7912 .cindex "domain list" "matching MX pointers to local host"
7913 If a pattern consists of the string &`@mx_any`& it matches any domain that
7914 has an MX record pointing to the local host or to any host that is listed in
7915 .oindex "&%hosts_treat_as_local%&"
7916 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7917 are similar, except that the first matches only when a primary MX target is the
7918 local host, and the second only when no primary MX target is the local host,
7919 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7920 preference value &-- there may of course be more than one of them.
7921
7922 The MX lookup that takes place when matching a pattern of this type is
7923 performed with the resolver options for widening names turned off. Thus, for
7924 example, a single-component domain will &'not'& be expanded by adding the
7925 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7926 options of the &(dnslookup)& router for a discussion of domain widening.
7927
7928 Sometimes you may want to ignore certain IP addresses when using one of these
7929 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7930 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7931 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7932 on a router). For example:
7933 .code
7934 domains = @mx_any/ignore=127.0.0.1
7935 .endd
7936 This example matches any domain that has an MX record pointing to one of
7937 the local host's IP addresses other than 127.0.0.1.
7938
7939 The list of IP addresses is in fact processed by the same code that processes
7940 host lists, so it may contain CIDR-coded network specifications and it may also
7941 contain negative items.
7942
7943 Because the list of IP addresses is a sublist within a domain list, you have to
7944 be careful about delimiters if there is more than one address. Like any other
7945 list, the default delimiter can be changed. Thus, you might have:
7946 .code
7947 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7948           an.other.domain : ...
7949 .endd
7950 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7951 involved, it is easiest to change the delimiter for the main list as well:
7952 .code
7953 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7954           an.other.domain ? ...
7955 .endd
7956 .next
7957 .cindex "asterisk" "in domain list"
7958 .cindex "domain list" "asterisk in"
7959 .cindex "domain list" "matching &""ends with""&"
7960 If a pattern starts with an asterisk, the remaining characters of the pattern
7961 are compared with the terminating characters of the domain. The use of &"*"& in
7962 domain lists differs from its use in partial matching lookups. In a domain
7963 list, the character following the asterisk need not be a dot, whereas partial
7964 matching works only in terms of dot-separated components. For example, a domain
7965 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7966 &'cipher.key.ex'&.
7967
7968 .next
7969 .cindex "regular expressions" "in domain list"
7970 .cindex "domain list" "matching regular expression"
7971 If a pattern starts with a circumflex character, it is treated as a regular
7972 expression, and matched against the domain using a regular expression matching
7973 function. The circumflex is treated as part of the regular expression.
7974 Email domains are case-independent, so this regular expression match is by
7975 default case-independent, but you can make it case-dependent by starting it
7976 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7977 are given in chapter &<<CHAPregexp>>&.
7978
7979 &*Warning*&: Because domain lists are expanded before being processed, you
7980 must escape any backslash and dollar characters in the regular expression, or
7981 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7982 it is not to be expanded (unless you really do want to build a regular
7983 expression by expansion, of course).
7984 .next
7985 .cindex "lookup" "in domain list"
7986 .cindex "domain list" "matching by lookup"
7987 If a pattern starts with the name of a single-key lookup type followed by a
7988 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7989 must be a file name in a suitable format for the lookup type. For example, for
7990 &"cdb;"& it must be an absolute path:
7991 .code
7992 domains = cdb;/etc/mail/local_domains.cdb
7993 .endd
7994 The appropriate type of lookup is done on the file using the domain name as the
7995 key. In most cases, the data that is looked up is not used; Exim is interested
7996 only in whether or not the key is present in the file. However, when a lookup
7997 is used for the &%domains%& option on a router
7998 or a &%domains%& condition in an ACL statement, the data is preserved in the
7999 &$domain_data$& variable and can be referred to in other router options or
8000 other statements in the same ACL.
8001
8002 .next
8003 Any of the single-key lookup type names may be preceded by
8004 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8005 .code
8006 domains = partial-dbm;/partial/domains
8007 .endd
8008 This causes partial matching logic to be invoked; a description of how this
8009 works is given in section &<<SECTpartiallookup>>&.
8010
8011 .next
8012 .cindex "asterisk" "in lookup type"
8013 Any of the single-key lookup types may be followed by an asterisk. This causes
8014 a default lookup for a key consisting of a single asterisk to be done if the
8015 original lookup fails. This is not a useful feature when using a domain list to
8016 select particular domains (because any domain would match), but it might have
8017 value if the result of the lookup is being used via the &$domain_data$&
8018 expansion variable.
8019 .next
8020 If the pattern starts with the name of a query-style lookup type followed by a
8021 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8022 pattern must be an appropriate query for the lookup type, as described in
8023 chapter &<<CHAPfdlookup>>&. For example:
8024 .code
8025 hold_domains = mysql;select domain from holdlist \
8026   where domain = '${quote_mysql:$domain}';
8027 .endd
8028 In most cases, the data that is looked up is not used (so for an SQL query, for
8029 example, it doesn't matter what field you select). Exim is interested only in
8030 whether or not the query succeeds. However, when a lookup is used for the
8031 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8032 variable and can be referred to in other options.
8033 .next
8034 .cindex "domain list" "matching literal domain name"
8035 If none of the above cases apply, a caseless textual comparison is made
8036 between the pattern and the domain.
8037 .endlist
8038
8039 Here is an example that uses several different kinds of pattern:
8040 .code
8041 domainlist funny_domains = \
8042   @ : \
8043   lib.unseen.edu : \
8044   *.foundation.fict.example : \
8045   \N^[1-2]\d{3}\.fict\.example$\N : \
8046   partial-dbm;/opt/data/penguin/book : \
8047   nis;domains.byname : \
8048   nisplus;[name=$domain,status=local],domains.org_dir
8049 .endd
8050 There are obvious processing trade-offs among the various matching modes. Using
8051 an asterisk is faster than a regular expression, and listing a few names
8052 explicitly probably is too. The use of a file or database lookup is expensive,
8053 but may be the only option if hundreds of names are required. Because the
8054 patterns are tested in order, it makes sense to put the most commonly matched
8055 patterns earlier.
8056
8057
8058
8059 .section "Host lists" "SECThostlist"
8060 .cindex "host list" "patterns in"
8061 .cindex "list" "host list"
8062 Host lists are used to control what remote hosts are allowed to do. For
8063 example, some hosts may be allowed to use the local host as a relay, and some
8064 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8065 two different ways, by name or by IP address. In a host list, some types of
8066 pattern are matched to a host name, and some are matched to an IP address.
8067 You need to be particularly careful with this when single-key lookups are
8068 involved, to ensure that the right value is being used as the key.
8069
8070
8071 .section "Special host list patterns" "SECID80"
8072 .cindex "empty item in hosts list"
8073 .cindex "host list" "empty string in"
8074 If a host list item is the empty string, it matches only when no remote host is
8075 involved. This is the case when a message is being received from a local
8076 process using SMTP on the standard input, that is, when a TCP/IP connection is
8077 not used.
8078
8079 .cindex "asterisk" "in host list"
8080 The special pattern &"*"& in a host list matches any host or no host. Neither
8081 the IP address nor the name is actually inspected.
8082
8083
8084
8085 .section "Host list patterns that match by IP address" "SECThoslispatip"
8086 .cindex "host list" "matching IP addresses"
8087 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8088 the incoming address actually appears in the IPv6 host as
8089 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8090 list, it is converted into a traditional IPv4 address first. (Not all operating
8091 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8092 concerns.)
8093
8094 The following types of pattern in a host list check the remote host by
8095 inspecting its IP address:
8096
8097 .ilist
8098 If the pattern is a plain domain name (not a regular expression, not starting
8099 with *, not a lookup of any kind), Exim calls the operating system function
8100 to find the associated IP address(es). Exim uses the newer
8101 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8102 This typically causes a forward DNS lookup of the name. The result is compared
8103 with the IP address of the subject host.
8104
8105 If there is a temporary problem (such as a DNS timeout) with the host name
8106 lookup, a temporary error occurs. For example, if the list is being used in an
8107 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8108 temporary SMTP error code. If no IP address can be found for the host name,
8109 what happens is described in section &<<SECTbehipnot>>& below.
8110
8111 .next
8112 .cindex "@ in a host list"
8113 If the pattern is &"@"&, the primary host name is substituted and used as a
8114 domain name, as just described.
8115
8116 .next
8117 If the pattern is an IP address, it is matched against the IP address of the
8118 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8119 IPv6 addresses can be given in colon-separated format, but the colons have to
8120 be doubled so as not to be taken as item separators when the default list
8121 separator is used. IPv6 addresses are recognized even when Exim is compiled
8122 without IPv6 support. This means that if they appear in a host list on an
8123 IPv4-only host, Exim will not treat them as host names. They are just addresses
8124 that can never match a client host.
8125
8126 .next
8127 .cindex "@[] in a host list"
8128 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8129 the local host. For example, if the local host is an IPv4 host with one
8130 interface address 10.45.23.56, these two ACL statements have the same effect:
8131 .code
8132 accept hosts = 127.0.0.1 : 10.45.23.56
8133 accept hosts = @[]
8134 .endd
8135 .next
8136 .cindex "CIDR notation"
8137 If the pattern is an IP address followed by a slash and a mask length (for
8138 example 10.11.42.0/24), it is matched against the IP address of the subject
8139 host under the given mask. This allows, an entire network of hosts to be
8140 included (or excluded) by a single item. The mask uses CIDR notation; it
8141 specifies the number of address bits that must match, starting from the most
8142 significant end of the address.
8143
8144 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8145 of a range of addresses. It is the number of bits in the network portion of the
8146 address. The above example specifies a 24-bit netmask, so it matches all 256
8147 addresses in the 10.11.42.0 network. An item such as
8148 .code
8149 192.168.23.236/31
8150 .endd
8151 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8152 32 for an IPv4 address is the same as no mask at all; just a single address
8153 matches.
8154
8155 Here is another example which shows an IPv4 and an IPv6 network:
8156 .code
8157 recipient_unqualified_hosts = 192.168.0.0/16: \
8158                               3ffe::ffff::836f::::/48
8159 .endd
8160 The doubling of list separator characters applies only when these items
8161 appear inline in a host list. It is not required when indirecting via a file.
8162 For example:
8163 .code
8164 recipient_unqualified_hosts = /opt/exim/unqualnets
8165 .endd
8166 could make use of a file containing
8167 .code
8168 172.16.0.0/12
8169 3ffe:ffff:836f::/48
8170 .endd
8171 to have exactly the same effect as the previous example. When listing IPv6
8172 addresses inline, it is usually more convenient to use the facility for
8173 changing separator characters. This list contains the same two networks:
8174 .code
8175 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8176                                  3ffe:ffff:836f::/48
8177 .endd
8178 The separator is changed to semicolon by the leading &"<;"& at the start of the
8179 list.
8180 .endlist
8181
8182
8183
8184 .section "Host list patterns for single-key lookups by host address" &&&
8185          "SECThoslispatsikey"
8186 .cindex "host list" "lookup of IP address"
8187 When a host is to be identified by a single-key lookup of its complete IP
8188 address, the pattern takes this form:
8189 .display
8190 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8191 .endd
8192 For example:
8193 .code
8194 hosts_lookup = net-cdb;/hosts-by-ip.db
8195 .endd
8196 The text form of the IP address of the subject host is used as the lookup key.
8197 IPv6 addresses are converted to an unabbreviated form, using lower case
8198 letters, with dots as separators because colon is the key terminator in
8199 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8200 quoting the keys, but this is a facility that was added later.] The data
8201 returned by the lookup is not used.
8202
8203 .cindex "IP address" "masking"
8204 .cindex "host list" "masked IP address"
8205 Single-key lookups can also be performed using masked IP addresses, using
8206 patterns of this form:
8207 .display
8208 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8209 .endd
8210 For example:
8211 .code
8212 net24-dbm;/networks.db
8213 .endd
8214 The IP address of the subject host is masked using <&'number'&> as the mask
8215 length. A textual string is constructed from the masked value, followed by the
8216 mask, and this is used as the lookup key. For example, if the host's IP address
8217 is 192.168.34.6, the key that is looked up for the above example is
8218 &"192.168.34.0/24"&.
8219
8220 When an IPv6 address is converted to a string, dots are normally used instead
8221 of colons, so that keys in &(lsearch)& files need not contain colons (which
8222 terminate &(lsearch)& keys). This was implemented some time before the ability
8223 to quote keys was made available in &(lsearch)& files. However, the more
8224 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8225 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8226 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8227 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8228 addresses are always used.
8229
8230 Ideally, it would be nice to tidy up this anomalous situation by changing to
8231 colons in all cases, given that quoting is now available for &(lsearch)&.
8232 However, this would be an incompatible change that might break some existing
8233 configurations.
8234
8235 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8236 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8237 the former case the key strings include the mask value, whereas in the latter
8238 case the IP address is used on its own.
8239
8240
8241
8242 .section "Host list patterns that match by host name" "SECThoslispatnam"
8243 .cindex "host" "lookup failures"
8244 .cindex "unknown host name"
8245 .cindex "host list" "matching host name"
8246 There are several types of pattern that require Exim to know the name of the
8247 remote host. These are either wildcard patterns or lookups by name. (If a
8248 complete hostname is given without any wildcarding, it is used to find an IP
8249 address to match against, as described in section &<<SECThoslispatip>>&
8250 above.)
8251
8252 If the remote host name is not already known when Exim encounters one of these
8253 patterns, it has to be found from the IP address.
8254 Although many sites on the Internet are conscientious about maintaining reverse
8255 DNS data for their hosts, there are also many that do not do this.
8256 Consequently, a name cannot always be found, and this may lead to unwanted
8257 effects. Take care when configuring host lists with wildcarded name patterns.
8258 Consider what will happen if a name cannot be found.
8259
8260 Because of the problems of determining host names from IP addresses, matching
8261 against host names is not as common as matching against IP addresses.
8262
8263 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8264 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8265 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8266 are done can be changed by setting the &%host_lookup_order%& option. For
8267 security, once Exim has found one or more names, it looks up the IP addresses
8268 for these names and compares them with the IP address that it started with.
8269 Only those names whose IP addresses match are accepted. Any other names are
8270 discarded. If no names are left, Exim behaves as if the host name cannot be
8271 found. In the most common case there is only one name and one IP address.
8272
8273 There are some options that control what happens if a host name cannot be
8274 found. These are described in section &<<SECTbehipnot>>& below.
8275
8276 .cindex "host" "alias for"
8277 .cindex "alias for host"
8278 As a result of aliasing, hosts may have more than one name. When processing any
8279 of the following types of pattern, all the host's names are checked:
8280
8281 .ilist
8282 .cindex "asterisk" "in host list"
8283 If a pattern starts with &"*"& the remainder of the item must match the end of
8284 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8285 &'.b.c'&. This special simple form is provided because this is a very common
8286 requirement. Other kinds of wildcarding require the use of a regular
8287 expression.
8288 .next
8289 .cindex "regular expressions" "in host list"
8290 .cindex "host list" "regular expression in"
8291 If the item starts with &"^"& it is taken to be a regular expression which is
8292 matched against the host name. Host names are case-independent, so this regular
8293 expression match is by default case-independent, but you can make it
8294 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8295 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8296 example,
8297 .code
8298 ^(a|b)\.c\.d$
8299 .endd
8300 is a regular expression that matches either of the two hosts &'a.c.d'& or
8301 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8302 that backslash and dollar characters are not misinterpreted as part of the
8303 string expansion. The simplest way to do this is to use &`\N`& to mark that
8304 part of the string as non-expandable. For example:
8305 .code
8306 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8307 .endd
8308 &*Warning*&: If you want to match a complete host name, you must include the
8309 &`$`& terminating metacharacter in the regular expression, as in the above
8310 example. Without it, a match at the start of the host name is all that is
8311 required.
8312 .endlist
8313
8314
8315
8316
8317 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8318 .cindex "host" "lookup failures, permanent"
8319 While processing a host list, Exim may need to look up an IP address from a
8320 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8321 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8322 behaviour when it fails to find the information it is seeking is the same.
8323
8324 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8325 apply to temporary DNS errors, whose handling is described in the next section.
8326
8327 .cindex "&`+include_unknown`&"
8328 .cindex "&`+ignore_unknown`&"
8329 Exim parses a host list from left to right. If it encounters a permanent
8330 lookup failure in any item in the host list before it has found a match,
8331 Exim treats it as a failure and the default behavior is as if the host
8332 does not match the list. This may not always be what you want to happen.
8333 To change Exim's behaviour, the special items &`+include_unknown`& or
8334 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8335 not recognized in an indirected file).
8336
8337 .ilist
8338 If any item that follows &`+include_unknown`& requires information that
8339 cannot found, Exim behaves as if the host does match the list. For example,
8340 .code
8341 host_reject_connection = +include_unknown:*.enemy.ex
8342 .endd
8343 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8344 any hosts whose name it cannot find.
8345
8346 .next
8347 If any item that follows &`+ignore_unknown`& requires information that cannot
8348 be found, Exim ignores that item and proceeds to the rest of the list. For
8349 example:
8350 .code
8351 accept hosts = +ignore_unknown : friend.example : \
8352                192.168.4.5
8353 .endd
8354 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8355 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8356 name can be found for 192.168.4.5, it is rejected.
8357 .endlist
8358
8359 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8360 list. The effect of each one lasts until the next, or until the end of the
8361 list.
8362
8363 .section "Mixing wildcarded host names and addresses in host lists" &&&
8364          "SECTmixwilhos"
8365 .cindex "host list" "mixing names and addresses in"
8366
8367 This section explains the host/ip processing logic with the same concepts
8368 as the previous section, but specifically addresses what happens when a
8369 wildcarded hostname is one of the items in the hostlist.
8370
8371 .ilist
8372 If you have name lookups or wildcarded host names and
8373 IP addresses in the same host list, you should normally put the IP
8374 addresses first. For example, in an ACL you could have:
8375 .code
8376 accept hosts = 10.9.8.7 : *.friend.example
8377 .endd
8378 The reason you normally would order it this way lies in the
8379 left-to-right way that Exim processes lists.  It can test IP addresses
8380 without doing any DNS lookups, but when it reaches an item that requires
8381 a host name, it fails if it cannot find a host name to compare with the
8382 pattern. If the above list is given in the opposite order, the
8383 &%accept%& statement fails for a host whose name cannot be found, even
8384 if its IP address is 10.9.8.7.
8385
8386 .next
8387 If you really do want to do the name check first, and still recognize the IP
8388 address, you can rewrite the ACL like this:
8389 .code
8390 accept hosts = *.friend.example
8391 accept hosts = 10.9.8.7
8392 .endd
8393 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8394 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8395 &`+ignore_unknown`&, which was discussed in depth in the first example in
8396 this section.
8397 .endlist
8398
8399
8400 .section "Temporary DNS errors when looking up host information" &&&
8401          "SECTtemdnserr"
8402 .cindex "host" "lookup failures, temporary"
8403 .cindex "&`+include_defer`&"
8404 .cindex "&`+ignore_defer`&"
8405 A temporary DNS lookup failure normally causes a defer action (except when
8406 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8407 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8408 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8409 section. These options should be used with care, probably only in non-critical
8410 host lists such as whitelists.
8411
8412
8413
8414 .section "Host list patterns for single-key lookups by host name" &&&
8415          "SECThoslispatnamsk"
8416 .cindex "unknown host name"
8417 .cindex "host list" "matching host name"
8418 If a pattern is of the form
8419 .display
8420 <&'single-key-search-type'&>;<&'search-data'&>
8421 .endd
8422 for example
8423 .code
8424 dbm;/host/accept/list
8425 .endd
8426 a single-key lookup is performed, using the host name as its key. If the
8427 lookup succeeds, the host matches the item. The actual data that is looked up
8428 is not used.
8429
8430 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8431 keys in the file, not IP addresses. If you want to do lookups based on IP
8432 addresses, you must precede the search type with &"net-"& (see section
8433 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8434 two items in the same list, one doing an address lookup and one doing a name
8435 lookup, both using the same file.
8436
8437
8438
8439 .section "Host list patterns for query-style lookups" "SECID81"
8440 If a pattern is of the form
8441 .display
8442 <&'query-style-search-type'&>;<&'query'&>
8443 .endd
8444 the query is obeyed, and if it succeeds, the host matches the item. The actual
8445 data that is looked up is not used. The variables &$sender_host_address$& and
8446 &$sender_host_name$& can be used in the query. For example:
8447 .code
8448 hosts_lookup = pgsql;\
8449   select ip from hostlist where ip='$sender_host_address'
8450 .endd
8451 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8452 can use the &%sg%& expansion item to change this if you need to. If you want to
8453 use masked IP addresses in database queries, you can use the &%mask%& expansion
8454 operator.
8455
8456 If the query contains a reference to &$sender_host_name$&, Exim automatically
8457 looks up the host name if it has not already done so. (See section
8458 &<<SECThoslispatnam>>& for comments on finding host names.)
8459
8460 Historical note: prior to release 4.30, Exim would always attempt to find a
8461 host name before running the query, unless the search type was preceded by
8462 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8463 still recognized for query-style lookups, but its presence or absence has no
8464 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8465 See section &<<SECThoslispatsikey>>&.)
8466
8467
8468
8469
8470
8471 .section "Address lists" "SECTaddresslist"
8472 .cindex "list" "address list"
8473 .cindex "address list" "empty item"
8474 .cindex "address list" "patterns"
8475 Address lists contain patterns that are matched against mail addresses. There
8476 is one special case to be considered: the sender address of a bounce message is
8477 always empty. You can test for this by providing an empty item in an address
8478 list. For example, you can set up a router to process bounce messages by
8479 using this option setting:
8480 .code
8481 senders = :
8482 .endd
8483 The presence of the colon creates an empty item. If you do not provide any
8484 data, the list is empty and matches nothing. The empty sender can also be
8485 detected by a regular expression that matches an empty string,
8486 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8487
8488 Non-empty items in an address list can be straightforward email addresses. For
8489 example:
8490 .code
8491 senders = jbc@askone.example : hs@anacreon.example
8492 .endd
8493 A certain amount of wildcarding is permitted. If a pattern contains an @
8494 character, but is not a regular expression and does not begin with a
8495 semicolon-terminated lookup type (described below), the local part of the
8496 subject address is compared with the local part of the pattern, which may start
8497 with an asterisk. If the local parts match, the domain is checked in exactly
8498 the same way as for a pattern in a domain list. For example, the domain can be
8499 wildcarded, refer to a named list, or be a lookup:
8500 .code
8501 deny senders = *@*.spamming.site:\
8502                *@+hostile_domains:\
8503                bozo@partial-lsearch;/list/of/dodgy/sites:\
8504                *@dbm;/bad/domains.db
8505 .endd
8506 .cindex "local part" "starting with !"
8507 .cindex "address list" "local part starting with !"
8508 If a local part that begins with an exclamation mark is required, it has to be
8509 specified using a regular expression, because otherwise the exclamation mark is
8510 treated as a sign of negation, as is standard in lists.
8511
8512 If a non-empty pattern that is not a regular expression or a lookup does not
8513 contain an @ character, it is matched against the domain part of the subject
8514 address. The only two formats that are recognized this way are a literal
8515 domain, or a domain pattern that starts with *. In both these cases, the effect
8516 is the same as if &`*@`& preceded the pattern. For example:
8517 .code
8518 deny senders = enemy.domain : *.enemy.domain
8519 .endd
8520
8521 The following kinds of more complicated address list pattern can match any
8522 address, including the empty address that is characteristic of bounce message
8523 senders:
8524
8525 .ilist
8526 .cindex "regular expressions" "in address list"
8527 .cindex "address list" "regular expression in"
8528 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8529 done against the complete address, with the pattern as the regular expression.
8530 You must take care that backslash and dollar characters are not misinterpreted
8531 as part of the string expansion. The simplest way to do this is to use &`\N`&
8532 to mark that part of the string as non-expandable. For example:
8533 .code
8534 deny senders = \N^.*this.*@example\.com$\N : \
8535                \N^\d{8}.+@spamhaus.example$\N : ...
8536 .endd
8537 The &`\N`& sequences are removed by the expansion, so these items do indeed
8538 start with &"^"& by the time they are being interpreted as address patterns.
8539
8540 .next
8541 .cindex "address list" "lookup for complete address"
8542 Complete addresses can be looked up by using a pattern that starts with a
8543 lookup type terminated by a semicolon, followed by the data for the lookup. For
8544 example:
8545 .code
8546 deny senders = cdb;/etc/blocked.senders : \
8547   mysql;select address from blocked where \
8548   address='${quote_mysql:$sender_address}'
8549 .endd
8550 Both query-style and single-key lookup types can be used. For a single-key
8551 lookup type, Exim uses the complete address as the key. However, empty keys are
8552 not supported for single-key lookups, so a match against the empty address
8553 always fails. This restriction does not apply to query-style lookups.
8554
8555 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8556 cannot be used, and is ignored if specified, with an entry being written to the
8557 panic log.
8558 .cindex "*@ with single-key lookup"
8559 However, you can configure lookup defaults, as described in section
8560 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8561 default. For example, with this lookup:
8562 .code
8563 accept senders = lsearch*@;/some/file
8564 .endd
8565 the file could contains lines like this:
8566 .code
8567 user1@domain1.example
8568 *@domain2.example
8569 .endd
8570 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8571 that are tried is:
8572 .code
8573 nimrod@jaeger.example
8574 *@jaeger.example
8575 *
8576 .endd
8577 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8578 would mean that every address matches, thus rendering the test useless.
8579
8580 &*Warning 2*&: Do not confuse these two kinds of item:
8581 .code
8582 deny recipients = dbm*@;/some/file
8583 deny recipients = *@dbm;/some/file
8584 .endd
8585 The first does a whole address lookup, with defaulting, as just described,
8586 because it starts with a lookup type. The second matches the local part and
8587 domain independently, as described in a bullet point below.
8588 .endlist
8589
8590
8591 The following kinds of address list pattern can match only non-empty addresses.
8592 If the subject address is empty, a match against any of these pattern types
8593 always fails.
8594
8595
8596 .ilist
8597 .cindex "@@ with single-key lookup"
8598 .cindex "address list" "@@ lookup type"
8599 .cindex "address list" "split local part and domain"
8600 If a pattern starts with &"@@"& followed by a single-key lookup item
8601 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8602 split into a local part and a domain. The domain is looked up in the file. If
8603 it is not found, there is no match. If it is found, the data that is looked up
8604 from the file is treated as a colon-separated list of local part patterns, each
8605 of which is matched against the subject local part in turn.
8606
8607 .cindex "asterisk" "in address list"
8608 The lookup may be a partial one, and/or one involving a search for a default
8609 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8610 patterns that are looked up can be regular expressions or begin with &"*"&, or
8611 even be further lookups. They may also be independently negated. For example,
8612 with
8613 .code
8614 deny senders = @@dbm;/etc/reject-by-domain
8615 .endd
8616 the data from which the DBM file is built could contain lines like
8617 .code
8618 baddomain.com:  !postmaster : *
8619 .endd
8620 to reject all senders except &%postmaster%& from that domain.
8621
8622 .cindex "local part" "starting with !"
8623 If a local part that actually begins with an exclamation mark is required, it
8624 has to be specified using a regular expression. In &(lsearch)& files, an entry
8625 may be split over several lines by indenting the second and subsequent lines,
8626 but the separating colon must still be included at line breaks. White space
8627 surrounding the colons is ignored. For example:
8628 .code
8629 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8630   spammer3 : spammer4
8631 .endd
8632 As in all colon-separated lists in Exim, a colon can be included in an item by
8633 doubling.
8634
8635 If the last item in the list starts with a right angle-bracket, the remainder
8636 of the item is taken as a new key to look up in order to obtain a continuation
8637 list of local parts. The new key can be any sequence of characters. Thus one
8638 might have entries like
8639 .code
8640 aol.com: spammer1 : spammer 2 : >*
8641 xyz.com: spammer3 : >*
8642 *:       ^\d{8}$
8643 .endd
8644 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8645 local parts for all domains, in addition to the specific local parts listed for
8646 each domain. Of course, using this feature costs another lookup each time a
8647 chain is followed, but the effort needed to maintain the data is reduced.
8648
8649 .cindex "loop" "in lookups"
8650 It is possible to construct loops using this facility, and in order to catch
8651 them, the chains may be no more than fifty items long.
8652
8653 .next
8654 The @@<&'lookup'&> style of item can also be used with a query-style
8655 lookup, but in this case, the chaining facility is not available. The lookup
8656 can only return a single list of local parts.
8657 .endlist
8658
8659 &*Warning*&: There is an important difference between the address list items
8660 in these two examples:
8661 .code
8662 senders = +my_list
8663 senders = *@+my_list
8664 .endd
8665 In the first one, &`my_list`& is a named address list, whereas in the second
8666 example it is a named domain list.
8667
8668
8669
8670
8671 .section "Case of letters in address lists" "SECTcasletadd"
8672 .cindex "case of local parts"
8673 .cindex "address list" "case forcing"
8674 .cindex "case forcing in address lists"
8675 Domains in email addresses are always handled caselessly, but for local parts
8676 case may be significant on some systems (see &%caseful_local_part%& for how
8677 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8678 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8679 blocking lists should be done in a case-independent manner. Since most address
8680 lists in Exim are used for this kind of control, Exim attempts to do this by
8681 default.
8682
8683 The domain portion of an address is always lowercased before matching it to an
8684 address list. The local part is lowercased by default, and any string
8685 comparisons that take place are done caselessly. This means that the data in
8686 the address list itself, in files included as plain file names, and in any file
8687 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8688 keys in files that are looked up by a search type other than &(lsearch)& (which
8689 works caselessly) must be in lower case, because these lookups are not
8690 case-independent.
8691
8692 .cindex "&`+caseful`&"
8693 To allow for the possibility of caseful address list matching, if an item in
8694 an address list is the string &"+caseful"&, the original case of the local
8695 part is restored for any comparisons that follow, and string comparisons are no
8696 longer case-independent. This does not affect the domain, which remains in
8697 lower case. However, although independent matches on the domain alone are still
8698 performed caselessly, regular expressions that match against an entire address
8699 become case-sensitive after &"+caseful"& has been seen.
8700
8701
8702
8703 .section "Local part lists" "SECTlocparlis"
8704 .cindex "list" "local part list"
8705 .cindex "local part" "list"
8706 Case-sensitivity in local part lists is handled in the same way as for address
8707 lists, as just described. The &"+caseful"& item can be used if required. In a
8708 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8709 set false, the subject is lowercased and the matching is initially
8710 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8711 matching in the local part list, but not elsewhere in the router. If
8712 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8713 option is case-sensitive from the start.
8714
8715 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8716 comments are handled in the same way as address lists &-- they are recognized
8717 only if the # is preceded by white space or the start of the line.
8718 Otherwise, local part lists are matched in the same way as domain lists, except
8719 that the special items that refer to the local host (&`@`&, &`@[]`&,
8720 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8721 Refer to section &<<SECTdomainlist>>& for details of the other available item
8722 types.
8723 .ecindex IIDdohoadli
8724
8725
8726
8727
8728 . ////////////////////////////////////////////////////////////////////////////
8729 . ////////////////////////////////////////////////////////////////////////////
8730
8731 .chapter "String expansions" "CHAPexpand"
8732 .scindex IIDstrexp "expansion" "of strings"
8733 Many strings in Exim's run time configuration are expanded before use. Some of
8734 them are expanded every time they are used; others are expanded only once.
8735
8736 When a string is being expanded it is copied verbatim from left to right except
8737 when a dollar or backslash character is encountered. A dollar specifies the
8738 start of a portion of the string that is interpreted and replaced as described
8739 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8740 escape character, as described in the following section.
8741
8742 Whether a string is expanded depends upon the context.  Usually this is solely
8743 dependent upon the option for which a value is sought; in this documentation,
8744 options for which string expansion is performed are marked with &dagger; after
8745 the data type.  ACL rules always expand strings.  A couple of expansion
8746 conditions do not expand some of the brace-delimited branches, for security
8747 reasons.
8748
8749
8750
8751 .section "Literal text in expanded strings" "SECTlittext"
8752 .cindex "expansion" "including literal text"
8753 An uninterpreted dollar can be included in an expanded string by putting a
8754 backslash in front of it. A backslash can be used to prevent any special
8755 character being treated specially in an expansion, including backslash itself.
8756 If the string appears in quotes in the configuration file, two backslashes are
8757 required because the quotes themselves cause interpretation of backslashes when
8758 the string is read in (see section &<<SECTstrings>>&).
8759
8760 .cindex "expansion" "non-expandable substrings"
8761 A portion of the string can specified as non-expandable by placing it between
8762 two occurrences of &`\N`&. This is particularly useful for protecting regular
8763 expressions, which often contain backslashes and dollar signs. For example:
8764 .code
8765 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8766 .endd
8767 On encountering the first &`\N`&, the expander copies subsequent characters
8768 without interpretation until it reaches the next &`\N`& or the end of the
8769 string.
8770
8771
8772
8773 .section "Character escape sequences in expanded strings" "SECID82"
8774 .cindex "expansion" "escape sequences"
8775 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8776 expanded string is recognized as an escape sequence for the character newline,
8777 carriage return, or tab, respectively. A backslash followed by up to three
8778 octal digits is recognized as an octal encoding for a single character, and a
8779 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8780 encoding.
8781
8782 These escape sequences are also recognized in quoted strings when they are read
8783 in. Their interpretation in expansions as well is useful for unquoted strings,
8784 and for other cases such as looked-up strings that are then expanded.
8785
8786
8787 .section "Testing string expansions" "SECID83"
8788 .cindex "expansion" "testing"
8789 .cindex "testing" "string expansion"
8790 .oindex "&%-be%&"
8791 Many expansions can be tested by calling Exim with the &%-be%& option. This
8792 takes the command arguments, or lines from the standard input if there are no
8793 arguments, runs them through the string expansion code, and writes the results
8794 to the standard output. Variables based on configuration values are set up, but
8795 since no message is being processed, variables such as &$local_part$& have no
8796 value. Nevertheless the &%-be%& option can be useful for checking out file and
8797 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8798 and &%nhash%&.
8799
8800 Exim gives up its root privilege when it is called with the &%-be%& option, and
8801 instead runs under the uid and gid it was called with, to prevent users from
8802 using &%-be%& for reading files to which they do not have access.
8803
8804 .oindex "&%-bem%&"
8805 If you want to test expansions that include variables whose values are taken
8806 from a message, there are two other options that can be used. The &%-bem%&
8807 option is like &%-be%& except that it is followed by a file name. The file is
8808 read as a message before doing the test expansions. For example:
8809 .code
8810 exim -bem /tmp/test.message '$h_subject:'
8811 .endd
8812 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8813 Exim message identifier. For example:
8814 .code
8815 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8816 .endd
8817 This loads the message from Exim's spool before doing the test expansions, and
8818 is therefore restricted to admin users.
8819
8820
8821 .section "Forced expansion failure" "SECTforexpfai"
8822 .cindex "expansion" "forced failure"
8823 A number of expansions that are described in the following section have
8824 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8825 (which are sometimes called &"curly brackets"&). Which of the two strings is
8826 used depends on some condition that is evaluated as part of the expansion. If,
8827 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8828 the entire string expansion fails in a way that can be detected by the code
8829 that requested the expansion. This is called &"forced expansion failure"&, and
8830 its consequences depend on the circumstances. In some cases it is no different
8831 from any other expansion failure, but in others a different action may be
8832 taken. Such variations are mentioned in the documentation of the option that is
8833 being expanded.
8834
8835
8836
8837
8838 .section "Expansion items" "SECTexpansionitems"
8839 The following items are recognized in expanded strings. White space may be used
8840 between sub-items that are keywords or substrings enclosed in braces inside an
8841 outer set of braces, to improve readability. &*Warning*&: Within braces,
8842 white space is significant.
8843
8844 .vlist
8845 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8846 .cindex "expansion" "variables"
8847 Substitute the contents of the named variable, for example:
8848 .code
8849 $local_part
8850 ${domain}
8851 .endd
8852 The second form can be used to separate the name from subsequent alphanumeric
8853 characters. This form (using braces) is available only for variables; it does
8854 &'not'& apply to message headers. The names of the variables are given in
8855 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8856 given, the expansion fails.
8857
8858 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8859 .cindex "expansion" "operators"
8860 The string is first itself expanded, and then the operation specified by
8861 <&'op'&> is applied to it. For example:
8862 .code
8863 ${lc:$local_part}
8864 .endd
8865 The string starts with the first character after the colon, which may be
8866 leading white space. A list of operators is given in section &<<SECTexpop>>&
8867 below. The operator notation is used for simple expansion items that have just
8868 one argument, because it reduces the number of braces and therefore makes the
8869 string easier to understand.
8870
8871 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8872 This item inserts &"basic"& header lines. It is described with the &%header%&
8873 expansion item below.
8874
8875
8876 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8877 .cindex "expansion" "calling an acl"
8878 .cindex "&%acl%&" "call from expansion"
8879 The name and zero to nine argument strings are first expanded separately.  The expanded
8880 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8881 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8882 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8883 and may use the variables; if another acl expansion is used the values
8884 are restored after it returns.  If the ACL sets
8885 a value using a "message =" modifier and returns accept or deny, the value becomes
8886 the result of the expansion.
8887 If no message is set and the ACL returns accept or deny
8888 the expansion result is an empty string.
8889 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8890
8891
8892 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8893        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8894 .cindex "expansion" "extracting cerificate fields"
8895 .cindex "&%certextract%&" "certificate fields"
8896 .cindex "certificate" "extracting fields"
8897 The <&'certificate'&> must be a variable of type certificate.
8898 The field name is expanded and used to retrive the relevant field from
8899 the certificate.  Supported fields are:
8900 .display
8901 &`version        `&
8902 &`serial_number  `&
8903 &`subject        `& RFC4514 DN
8904 &`issuer         `& RFC4514 DN
8905 &`notbefore      `& time
8906 &`notafter       `& time
8907 &`sig_algorithm  `&
8908 &`signature      `&
8909 &`subj_altname   `& tagged list
8910 &`ocsp_uri       `& list
8911 &`crl_uri        `& list
8912 .endd
8913 If the field is found,
8914 <&'string2'&> is expanded, and replaces the whole item;
8915 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8916 variable &$value$& contains the value that has been extracted. Afterwards, it
8917 is restored to any previous value it might have had.
8918
8919 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8920 key is not found. If {<&'string2'&>} is also omitted, the value that was
8921 extracted is used.
8922
8923 Some field names take optional modifiers, appended and separated by commas.
8924
8925 The field selectors marked as "RFC4514" above
8926 output a Distinguished Name string which is
8927 not quite
8928 parseable by Exim as a comma-separated tagged list
8929 (the exceptions being elements containin commas).
8930 RDN elements of a single type may be selected by
8931 a modifier of the type label; if so the expansion
8932 result is a list (newline-separated by default).
8933 The separator may be changed by another modifer of
8934 a right angle-bracket followed immediately by the new separator.
8935 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8936
8937 The field selectors marked as "time" above
8938 may output a number of seconds since epoch
8939 if the modifier "int" is used.
8940
8941 The field selectors marked as "list" above return a list,
8942 newline-separated by default,
8943 (embedded separator characters in elements are doubled).
8944 The separator may be changed by a modifier of
8945 a right angle-bracket followed immediately by the new separator.
8946
8947 The field selectors marked as "tagged" above
8948 prefix each list element with a type string and an equals sign.
8949 Elements of only one type may be selected by a modifier
8950 which is one of "dns", "uri" or "mail";
8951 if so the elenment tags are omitted.
8952
8953 If not otherwise noted field values are presented in human-readable form.
8954
8955 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8956        {*&<&'arg'&>&*}...}*&"
8957 .cindex &%dlfunc%&
8958 This expansion dynamically loads and then calls a locally-written C function.
8959 This functionality is available only if Exim is compiled with
8960 .code
8961 EXPAND_DLFUNC=yes
8962 .endd
8963 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8964 object so that it doesn't reload the same object file in the same Exim process
8965 (but of course Exim does start new processes frequently).
8966
8967 There may be from zero to eight arguments to the function. When compiling
8968 a local function that is to be called in this way, &_local_scan.h_& should be
8969 included. The Exim variables and functions that are defined by that API
8970 are also available for dynamically loaded functions. The function itself
8971 must have the following type:
8972 .code
8973 int dlfunction(uschar **yield, int argc, uschar *argv[])
8974 .endd
8975 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8976 function should return one of the following values:
8977
8978 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8979 into the expanded string that is being built.
8980
8981 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8982 from &'yield'&, if it is set.
8983
8984 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8985 taken from &'yield'& if it is set.
8986
8987 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8988
8989 When compiling a function that is to be used in this way with gcc,
8990 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8991 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8992
8993 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8994        {*&<&'string3'&>&*}}*&"
8995 .cindex "expansion" "extracting substrings by key"
8996 .cindex "&%extract%&" "substrings by key"
8997 The key and <&'string1'&> are first expanded separately. Leading and trailing
8998 white space is removed from the key (but not from any of the strings). The key
8999 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9000 form:
9001 .display
9002 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9003 .endd
9004 .vindex "&$value$&"
9005 where the equals signs and spaces (but not both) are optional. If any of the
9006 values contain white space, they must be enclosed in double quotes, and any
9007 values that are enclosed in double quotes are subject to escape processing as
9008 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9009 for the value that corresponds to the key. The search is case-insensitive. If
9010 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9011 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9012 variable &$value$& contains the value that has been extracted. Afterwards, it
9013 is restored to any previous value it might have had.
9014
9015 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9016 key is not found. If {<&'string2'&>} is also omitted, the value that was
9017 extracted is used. Thus, for example, these two expansions are identical, and
9018 yield &"2001"&:
9019 .code
9020 ${extract{gid}{uid=1984 gid=2001}}
9021 ${extract{gid}{uid=1984 gid=2001}{$value}}
9022 .endd
9023 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9024 appear, for example:
9025 .code
9026 ${extract{Z}{A=... B=...}{$value} fail }
9027 .endd
9028 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9029 {<&'string2'&>} must be present for &"fail"& to be recognized.
9030
9031
9032 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9033         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9034 .cindex "expansion" "extracting substrings by number"
9035 .cindex "&%extract%&" "substrings by number"
9036 The <&'number'&> argument must consist entirely of decimal digits,
9037 apart from leading and trailing white space, which is ignored.
9038 This is what distinguishes this form of &%extract%& from the previous kind. It
9039 behaves in the same way, except that, instead of extracting a named field, it
9040 extracts from <&'string1'&> the field whose number is given as the first
9041 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9042 <&'string3'&> as before.
9043
9044 The fields in the string are separated by any one of the characters in the
9045 separator string. These may include space or tab characters.
9046 The first field is numbered one. If the number is negative, the fields are
9047 counted from the end of the string, with the rightmost one numbered -1. If the
9048 number given is zero, the entire string is returned. If the modulus of the
9049 number is greater than the number of fields in the string, the result is the
9050 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9051 provided. For example:
9052 .code
9053 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9054 .endd
9055 yields &"42"&, and
9056 .code
9057 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9058 .endd
9059 yields &"99"&. Two successive separators mean that the field between them is
9060 empty (for example, the fifth field above).
9061
9062
9063 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9064 .cindex "list" "selecting by condition"
9065 .cindex "expansion" "selecting from list by condition"
9066 .vindex "&$item$&"
9067 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9068 default, but the separator can be changed in the usual way. For each item
9069 in this list, its value is place in &$item$&, and then the condition is
9070 evaluated. If the condition is true, &$item$& is added to the output as an
9071 item in a new list; if the condition is false, the item is discarded. The
9072 separator used for the output list is the same as the one used for the
9073 input, but a separator setting is not included in the output. For example:
9074 .code
9075 ${filter{a:b:c}{!eq{$item}{b}}
9076 .endd
9077 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9078 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9079
9080
9081 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9082 .cindex "hash function" "textual"
9083 .cindex "expansion" "textual hash"
9084 This is a textual hashing function, and was the first to be implemented in
9085 early versions of Exim. In current releases, there are other hashing functions
9086 (numeric, MD5, and SHA-1), which are described below.
9087
9088 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9089 <&'n'&>. If you are using fixed values for these numbers, that is, if
9090 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9091 use the simpler operator notation that avoids some of the braces:
9092 .code
9093 ${hash_<n>_<m>:<string>}
9094 .endd
9095 The second number is optional (in both notations). If <&'n'&> is greater than
9096 or equal to the length of the string, the expansion item returns the string.
9097 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9098 function to the string. The new string consists of characters taken from the
9099 first <&'m'&> characters of the string
9100 .code
9101 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9102 .endd
9103 If <&'m'&> is not present the value 26 is used, so that only lower case
9104 letters appear. For example:
9105 .display
9106 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9107 &`$hash{5}{monty}}           `&   yields  &`monty`&
9108 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9109 .endd
9110
9111 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9112         &*$h_*&<&'header&~name'&>&*:*&" &&&
9113        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9114         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9115        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9116         &*$rh_*&<&'header&~name'&>&*:*&"
9117 .cindex "expansion" "header insertion"
9118 .vindex "&$header_$&"
9119 .vindex "&$bheader_$&"
9120 .vindex "&$rheader_$&"
9121 .cindex "header lines" "in expansion strings"
9122 .cindex "header lines" "character sets"
9123 .cindex "header lines" "decoding"
9124 Substitute the contents of the named message header line, for example
9125 .code
9126 $header_reply-to:
9127 .endd
9128 The newline that terminates a header line is not included in the expansion, but
9129 internal newlines (caused by splitting the header line over several physical
9130 lines) may be present.
9131
9132 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9133 the data in the header line is interpreted.
9134
9135 .ilist
9136 .cindex "white space" "in header lines"
9137 &%rheader%& gives the original &"raw"& content of the header line, with no
9138 processing at all, and without the removal of leading and trailing white space.
9139
9140 .next
9141 .cindex "base64 encoding" "in header lines"
9142 &%bheader%& removes leading and trailing white space, and then decodes base64
9143 or quoted-printable MIME &"words"& within the header text, but does no
9144 character set translation. If decoding of what looks superficially like a MIME
9145 &"word"& fails, the raw string is returned. If decoding
9146 .cindex "binary zero" "in header line"
9147 produces a binary zero character, it is replaced by a question mark &-- this is
9148 what Exim does for binary zeros that are actually received in header lines.
9149
9150 .next
9151 &%header%& tries to translate the string as decoded by &%bheader%& to a
9152 standard character set. This is an attempt to produce the same string as would
9153 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9154 returned. Translation is attempted only on operating systems that support the
9155 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9156 a system Makefile or in &_Local/Makefile_&.
9157 .endlist ilist
9158
9159 In a filter file, the target character set for &%header%& can be specified by a
9160 command of the following form:
9161 .code
9162 headers charset "UTF-8"
9163 .endd
9164 This command affects all references to &$h_$& (or &$header_$&) expansions in
9165 subsequently obeyed filter commands. In the absence of this command, the target
9166 character set in a filter is taken from the setting of the &%headers_charset%&
9167 option in the runtime configuration. The value of this option defaults to the
9168 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9169 ISO-8859-1.
9170
9171 Header names follow the syntax of RFC 2822, which states that they may contain
9172 any printing characters except space and colon. Consequently, curly brackets
9173 &'do not'& terminate header names, and should not be used to enclose them as
9174 if they were variables. Attempting to do so causes a syntax error.
9175
9176 Only header lines that are common to all copies of a message are visible to
9177 this mechanism. These are the original header lines that are received with the
9178 message, and any that are added by an ACL statement or by a system
9179 filter. Header lines that are added to a particular copy of a message by a
9180 router or transport are not accessible.
9181
9182 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9183 before the DATA ACL, because the header structure is not set up until the
9184 message is received. Header lines that are added in a RCPT ACL (for example)
9185 are saved until the message's incoming header lines are available, at which
9186 point they are added. When a DATA ACL is running, however, header lines added
9187 by earlier ACLs are visible.
9188
9189 Upper case and lower case letters are synonymous in header names. If the
9190 following character is white space, the terminating colon may be omitted, but
9191 this is not recommended, because you may then forget it when it is needed. When
9192 white space terminates the header name, it is included in the expanded string.
9193 If the message does not contain the given header, the expansion item is
9194 replaced by an empty string. (See the &%def%& condition in section
9195 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9196
9197 If there is more than one header with the same name, they are all concatenated
9198 to form the substitution string, up to a maximum length of 64K. Unless
9199 &%rheader%& is being used, leading and trailing white space is removed from
9200 each header before concatenation, and a completely empty header is ignored. A
9201 newline character is then inserted between non-empty headers, but there is no
9202 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9203 those headers that contain lists of addresses, a comma is also inserted at the
9204 junctions between headers. This does not happen for the &%rheader%& expansion.
9205
9206
9207 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9208 .cindex "expansion" "hmac hashing"
9209 .cindex &%hmac%&
9210 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9211 shared secret and some text into a message authentication code, as specified in
9212 RFC 2104. This differs from &`${md5:secret_text...}`& or
9213 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9214 cryptographic hash, allowing for authentication that is not possible with MD5
9215 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9216 present. For example:
9217 .code
9218 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9219 .endd
9220 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9221 produces:
9222 .code
9223 dd97e3ba5d1a61b5006108f8c8252953
9224 .endd
9225 As an example of how this might be used, you might put in the main part of
9226 an Exim configuration:
9227 .code
9228 SPAMSCAN_SECRET=cohgheeLei2thahw
9229 .endd
9230 In a router or a transport you could then have:
9231 .code
9232 headers_add = \
9233   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9234   ${hmac{md5}{SPAMSCAN_SECRET}\
9235   {${primary_hostname},${message_exim_id},$h_message-id:}}
9236 .endd
9237 Then given a message, you can check where it was scanned by looking at the
9238 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9239 this header line is authentic by recomputing the authentication code from the
9240 host name, message ID and the &'Message-id:'& header line. This can be done
9241 using Exim's &%-be%& option, or by other means, for example by using the
9242 &'hmac_md5_hex()'& function in Perl.
9243
9244
9245 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9246 .cindex "expansion" "conditional"
9247 .cindex "&%if%&, expansion item"
9248 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9249 item; otherwise <&'string2'&> is used. The available conditions are described
9250 in section &<<SECTexpcond>>& below. For example:
9251 .code
9252 ${if eq {$local_part}{postmaster} {yes}{no} }
9253 .endd
9254 The second string need not be present; if it is not and the condition is not
9255 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9256 be present instead of the second string (without any curly brackets). In this
9257 case, the expansion is forced to fail if the condition is not true (see section
9258 &<<SECTforexpfai>>&).
9259
9260 If both strings are omitted, the result is the string &`true`& if the condition
9261 is true, and the empty string if the condition is false. This makes it less
9262 cumbersome to write custom ACL and router conditions. For example, instead of
9263 .code
9264 condition = ${if >{$acl_m4}{3}{true}{false}}
9265 .endd
9266 you can use
9267 .code
9268 condition = ${if >{$acl_m4}{3}}
9269 .endd
9270
9271 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9272 .cindex "expansion" "string truncation"
9273 .cindex "&%length%& expansion item"
9274 The &%length%& item is used to extract the initial portion of a string. Both
9275 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9276 you are using a fixed value for the number, that is, if <&'string1'&> does not
9277 change when expanded, you can use the simpler operator notation that avoids
9278 some of the braces:
9279 .code
9280 ${length_<n>:<string>}
9281 .endd
9282 The result of this item is either the first <&'n'&> characters or the whole
9283 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9284 &%strlen%&, which gives the length of a string.
9285
9286
9287 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9288         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9289 .cindex "expansion" "extracting list elements by number"
9290 .cindex "&%listextract%&" "extract list elements by number"
9291 .cindex "list" "extracting elements by number"
9292 The <&'number'&> argument must consist entirely of decimal digits,
9293 apart from an optional leading minus,
9294 and leading and trailing white space (which is ignored).
9295
9296 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9297 default, but the separator can be changed in the usual way.
9298
9299 The first field of the list is numbered one.
9300 If the number is negative, the fields are
9301 counted from the end of the list, with the rightmost one numbered -1.
9302 The numbered element of the list is extracted and placed in &$value$&,
9303 then <&'string2'&> is expanded as the result.
9304
9305 If the modulus of the
9306 number is zero or greater than the number of fields in the string,
9307 the result is the expansion of <&'string3'&>.
9308
9309 For example:
9310 .code
9311 ${listextract{2}{x:42:99}}
9312 .endd
9313 yields &"42"&, and
9314 .code
9315 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9316 .endd
9317 yields &"result: 99"&.
9318
9319 If {<&'string3'&>} is omitted, an empty string is used for string3.
9320 If {<&'string2'&>} is also omitted, the value that was
9321 extracted is used.
9322 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9323
9324
9325 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9326         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9327 This is the first of one of two different types of lookup item, which are both
9328 described in the next item.
9329
9330 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9331         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9332 .cindex "expansion" "lookup in"
9333 .cindex "file" "lookups"
9334 .cindex "lookup" "in expanded string"
9335 The two forms of lookup item specify data lookups in files and databases, as
9336 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9337 lookups, and the second is used for query-style lookups. The <&'key'&>,
9338 <&'file'&>, and <&'query'&> strings are expanded before use.
9339
9340 If there is any white space in a lookup item which is part of a filter command,
9341 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9342 other place where white space is significant, the lookup item must be enclosed
9343 in double quotes. The use of data lookups in users' filter files may be locked
9344 out by the system administrator.
9345
9346 .vindex "&$value$&"
9347 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9348 During its expansion, the variable &$value$& contains the data returned by the
9349 lookup. Afterwards it reverts to the value it had previously (at the outer
9350 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9351 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9352 string on failure. If <&'string2'&> is provided, it can itself be a nested
9353 lookup, thus providing a mechanism for looking up a default value when the
9354 original lookup fails.
9355
9356 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9357 data for the outer lookup while the parameters of the second lookup are
9358 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9359 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9360 appear, and in this case, if the lookup fails, the entire expansion is forced
9361 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9362 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9363 successful lookup, and nothing in the case of failure.
9364
9365 For single-key lookups, the string &"partial"& is permitted to precede the
9366 search type in order to do partial matching, and * or *@ may follow a search
9367 type to request default lookups if the key does not match (see sections
9368 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9369
9370 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9371 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9372 and non-wild parts of the key during the expansion of the replacement text.
9373 They return to their previous values at the end of the lookup item.
9374
9375 This example looks up the postmaster alias in the conventional alias file:
9376 .code
9377 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9378 .endd
9379 This example uses NIS+ to look up the full name of the user corresponding to
9380 the local part of an address, forcing the expansion to fail if it is not found:
9381 .code
9382 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9383   {$value}fail}
9384 .endd
9385
9386
9387 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9388 .cindex "expansion" "list creation"
9389 .vindex "&$item$&"
9390 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9391 default, but the separator can be changed in the usual way. For each item
9392 in this list, its value is place in &$item$&, and then <&'string2'&> is
9393 expanded and added to the output as an item in a new list. The separator used
9394 for the output list is the same as the one used for the input, but a separator
9395 setting is not included in the output. For example:
9396 .code
9397 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9398 .endd
9399 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9400 value of &$item$& is restored to what it was before. See also the &*filter*&
9401 and &*reduce*& expansion items.
9402
9403 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9404 .cindex "expansion" "numeric hash"
9405 .cindex "hash function" "numeric"
9406 The three strings are expanded; the first two must yield numbers. Call them
9407 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9408 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9409 can use the simpler operator notation that avoids some of the braces:
9410 .code
9411 ${nhash_<n>_<m>:<string>}
9412 .endd
9413 The second number is optional (in both notations). If there is only one number,
9414 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9415 processed by a div/mod hash function that returns two numbers, separated by a
9416 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9417 example,
9418 .code
9419 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9420 .endd
9421 returns the string &"6/33"&.
9422
9423
9424
9425 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9426 .cindex "Perl" "use in expanded string"
9427 .cindex "expansion" "calling Perl from"
9428 This item is available only if Exim has been built to include an embedded Perl
9429 interpreter. The subroutine name and the arguments are first separately
9430 expanded, and then the Perl subroutine is called with those arguments. No
9431 additional arguments need be given; the maximum number permitted, including the
9432 name of the subroutine, is nine.
9433
9434 The return value of the subroutine is inserted into the expanded string, unless
9435 the return value is &%undef%&. In that case, the expansion fails in the same
9436 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9437 Whatever you return is evaluated in a scalar context. For example, if you
9438 return the name of a Perl vector, the return value is the size of the vector,
9439 not its contents.
9440
9441 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9442 with the error message that was passed to &%die%&. More details of the embedded
9443 Perl facility are given in chapter &<<CHAPperl>>&.
9444
9445 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9446 out the use of this expansion item in filter files.
9447
9448
9449 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9450 .cindex "&%prvs%& expansion item"
9451 The first argument is a complete email address and the second is secret
9452 keystring. The third argument, specifying a key number, is optional. If absent,
9453 it defaults to 0. The result of the expansion is a prvs-signed email address,
9454 to be typically used with the &%return_path%& option on an &(smtp)& transport
9455 as part of a bounce address tag validation (BATV) scheme. For more discussion
9456 and an example, see section &<<SECTverifyPRVS>>&.
9457
9458 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9459         {*&<&'string'&>&*}}*&"
9460 .cindex "&%prvscheck%& expansion item"
9461 This expansion item is the complement of the &%prvs%& item. It is used for
9462 checking prvs-signed addresses. If the expansion of the first argument does not
9463 yield a syntactically valid prvs-signed address, the whole item expands to the
9464 empty string. When the first argument does expand to a syntactically valid
9465 prvs-signed address, the second argument is expanded, with the prvs-decoded
9466 version of the address and the key number extracted from the address in the
9467 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9468
9469 These two variables can be used in the expansion of the second argument to
9470 retrieve the secret. The validity of the prvs-signed address is then checked
9471 against the secret. The result is stored in the variable &$prvscheck_result$&,
9472 which is empty for failure or &"1"& for success.
9473
9474 The third argument is optional; if it is missing, it defaults to an empty
9475 string. This argument is now expanded. If the result is an empty string, the
9476 result of the expansion is the decoded version of the address. This is the case
9477 whether or not the signature was valid. Otherwise, the result of the expansion
9478 is the expansion of the third argument.
9479
9480 All three variables can be used in the expansion of the third argument.
9481 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9482 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9483
9484 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9485 .cindex "expansion" "inserting an entire file"
9486 .cindex "file" "inserting into expansion"
9487 .cindex "&%readfile%& expansion item"
9488 The file name and end-of-line string are first expanded separately. The file is
9489 then read, and its contents replace the entire item. All newline characters in
9490 the file are replaced by the end-of-line string if it is present. Otherwise,
9491 newlines are left in the string.
9492 String expansion is not applied to the contents of the file. If you want this,
9493 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9494 the string expansion fails.
9495
9496 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9497 locks out the use of this expansion item in filter files.
9498
9499
9500
9501 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9502         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9503 .cindex "expansion" "inserting from a socket"
9504 .cindex "socket, use of in expansion"
9505 .cindex "&%readsocket%& expansion item"
9506 This item inserts data from a Unix domain or Internet socket into the expanded
9507 string. The minimal way of using it uses just two arguments, as in these
9508 examples:
9509 .code
9510 ${readsocket{/socket/name}{request string}}
9511 ${readsocket{inet:some.host:1234}{request string}}
9512 .endd
9513 For a Unix domain socket, the first substring must be the path to the socket.
9514 For an Internet socket, the first substring must contain &`inet:`& followed by
9515 a host name or IP address, followed by a colon and a port, which can be a
9516 number or the name of a TCP port in &_/etc/services_&. An IP address may
9517 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9518 example:
9519 .code
9520 ${readsocket{inet:[::1]:1234}{request string}}
9521 .endd
9522 Only a single host name may be given, but if looking it up yields more than
9523 one IP address, they are each tried in turn until a connection is made. For
9524 both kinds of socket, Exim makes a connection, writes the request string
9525 (unless it is an empty string) and reads from the socket until an end-of-file
9526 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9527 extend what can be done. Firstly, you can vary the timeout. For example:
9528 .code
9529 ${readsocket{/socket/name}{request string}{3s}}
9530 .endd
9531 A fourth argument allows you to change any newlines that are in the data
9532 that is read, in the same way as for &%readfile%& (see above). This example
9533 turns them into spaces:
9534 .code
9535 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9536 .endd
9537 As with all expansions, the substrings are expanded before the processing
9538 happens. Errors in these sub-expansions cause the expansion to fail. In
9539 addition, the following errors can occur:
9540
9541 .ilist
9542 Failure to create a socket file descriptor;
9543 .next
9544 Failure to connect the socket;
9545 .next
9546 Failure to write the request string;
9547 .next
9548 Timeout on reading from the socket.
9549 .endlist
9550
9551 By default, any of these errors causes the expansion to fail. However, if
9552 you supply a fifth substring, it is expanded and used when any of the above
9553 errors occurs. For example:
9554 .code
9555 ${readsocket{/socket/name}{request string}{3s}{\n}\
9556   {socket failure}}
9557 .endd
9558 You can test for the existence of a Unix domain socket by wrapping this
9559 expansion in &`${if exists`&, but there is a race condition between that test
9560 and the actual opening of the socket, so it is safer to use the fifth argument
9561 if you want to be absolutely sure of avoiding an expansion error for a
9562 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9563
9564 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9565 locks out the use of this expansion item in filter files.
9566
9567
9568 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9569 .cindex "expansion" "reducing a list to a scalar"
9570 .cindex "list" "reducing to a scalar"
9571 .vindex "&$value$&"
9572 .vindex "&$item$&"
9573 This operation reduces a list to a single, scalar string. After expansion,
9574 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9575 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9576 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9577 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9578 them. The result of that expansion is assigned to &$value$& before the next
9579 iteration. When the end of the list is reached, the final value of &$value$& is
9580 added to the expansion output. The &*reduce*& expansion item can be used in a
9581 number of ways. For example, to add up a list of numbers:
9582 .code
9583 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9584 .endd
9585 The result of that expansion would be &`6`&. The maximum of a list of numbers
9586 can be found:
9587 .code
9588 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9589 .endd
9590 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9591 restored to what they were before. See also the &*filter*& and &*map*&
9592 expansion items.
9593
9594 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9595 This item inserts &"raw"& header lines. It is described with the &%header%&
9596 expansion item above.
9597
9598 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9599         {*&<&'string2'&>&*}}*&"
9600 .cindex "expansion" "running a command"
9601 .cindex "&%run%& expansion item"
9602 The command and its arguments are first expanded as one string. The string is
9603 split apart into individual arguments by spaces, and then the command is run
9604 in a separate process, but under the same uid and gid.  As in other command
9605 executions from Exim, a shell is not used by default. If the command requires
9606 a shell, you must explicitly code it.
9607
9608 Since the arguments are split by spaces, when there is a variable expansion
9609 which has an empty result, it will cause the situation that the argument will
9610 simply be omitted when the program is actually executed by Exim. If the
9611 script/program requires a specific number of arguments and the expanded
9612 variable could possibly result in this empty expansion, the variable must be
9613 quoted. This is more difficult if the expanded variable itself could result
9614 in a string containing quotes, because it would interfere with the quotes
9615 around the command arguments. A possible guard against this is to wrap the
9616 variable in the &%sg%& operator to change any quote marks to some other
9617 character.
9618
9619 The standard input for the command exists, but is empty. The standard output
9620 and standard error are set to the same file descriptor.
9621 .cindex "return code" "from &%run%& expansion"
9622 .vindex "&$value$&"
9623 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9624 and replaces the entire item; during this expansion, the standard output/error
9625 from the command is in the variable &$value$&. If the command fails,
9626 <&'string2'&>, if present, is expanded and used. Once again, during the
9627 expansion, the standard output/error from the command is in the variable
9628 &$value$&.
9629
9630 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9631 can be the word &"fail"& (not in braces) to force expansion failure if the
9632 command does not succeed. If both strings are omitted, the result is contents
9633 of the standard output/error on success, and nothing on failure.
9634
9635 .vindex "&$run_in_acl$&"
9636 The standard output/error of the command is put in the variable &$value$&.
9637 In this ACL example, the output of a command is logged for the admin to
9638 troubleshoot:
9639 .code
9640 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9641       log_message  = Output of id: $value
9642 .endd
9643 If the command requires shell idioms, such as the > redirect operator, the
9644 shell must be invoked directly, such as with:
9645 .code
9646 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9647 .endd
9648
9649 .vindex "&$runrc$&"
9650 The return code from the command is put in the variable &$runrc$&, and this
9651 remains set afterwards, so in a filter file you can do things like this:
9652 .code
9653 if "${run{x y z}{}}$runrc" is 1 then ...
9654   elif $runrc is 2 then ...
9655   ...
9656 endif
9657 .endd
9658 If execution of the command fails (for example, the command does not exist),
9659 the return code is 127 &-- the same code that shells use for non-existent
9660 commands.
9661
9662 &*Warning*&: In a router or transport, you cannot assume the order in which
9663 option values are expanded, except for those preconditions whose order of
9664 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9665 by the expansion of one option, and use it in another.
9666
9667 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9668 out the use of this expansion item in filter files.
9669
9670
9671 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9672 .cindex "expansion" "string substitution"
9673 .cindex "&%sg%& expansion item"
9674 This item works like Perl's substitution operator (s) with the global (/g)
9675 option; hence its name. However, unlike the Perl equivalent, Exim does not
9676 modify the subject string; instead it returns the modified string for insertion
9677 into the overall expansion. The item takes three arguments: the subject string,
9678 a regular expression, and a substitution string. For example:
9679 .code
9680 ${sg{abcdefabcdef}{abc}{xyz}}
9681 .endd
9682 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9683 if any $ or \ characters are required in the regular expression or in the
9684 substitution string, they have to be escaped. For example:
9685 .code
9686 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9687 .endd
9688 yields &"defabc"&, and
9689 .code
9690 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9691 .endd
9692 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9693 the regular expression from string expansion.
9694
9695
9696
9697 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9698 .cindex "&%substr%& expansion item"
9699 .cindex "substring extraction"
9700 .cindex "expansion" "substring extraction"
9701 The three strings are expanded; the first two must yield numbers. Call them
9702 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9703 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9704 can use the simpler operator notation that avoids some of the braces:
9705 .code
9706 ${substr_<n>_<m>:<string>}
9707 .endd
9708 The second number is optional (in both notations).
9709 If it is absent in the simpler format, the preceding underscore must also be
9710 omitted.
9711
9712 The &%substr%& item can be used to extract more general substrings than
9713 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9714 length required. For example
9715 .code
9716 ${substr{3}{2}{$local_part}}
9717 .endd
9718 If the starting offset is greater than the string length the result is the
9719 null string; if the length plus starting offset is greater than the string
9720 length, the result is the right-hand part of the string, starting from the
9721 given offset. The first character in the string has offset zero.
9722
9723 The &%substr%& expansion item can take negative offset values to count
9724 from the right-hand end of its operand. The last character is offset -1, the
9725 second-last is offset -2, and so on. Thus, for example,
9726 .code
9727 ${substr{-5}{2}{1234567}}
9728 .endd
9729 yields &"34"&. If the absolute value of a negative offset is greater than the
9730 length of the string, the substring starts at the beginning of the string, and
9731 the length is reduced by the amount of overshoot. Thus, for example,
9732 .code
9733 ${substr{-5}{2}{12}}
9734 .endd
9735 yields an empty string, but
9736 .code
9737 ${substr{-3}{2}{12}}
9738 .endd
9739 yields &"1"&.
9740
9741 When the second number is omitted from &%substr%&, the remainder of the string
9742 is taken if the offset is positive. If it is negative, all characters in the
9743 string preceding the offset point are taken. For example, an offset of -1 and
9744 no length, as in these semantically identical examples:
9745 .code
9746 ${substr_-1:abcde}
9747 ${substr{-1}{abcde}}
9748 .endd
9749 yields all but the last character of the string, that is, &"abcd"&.
9750
9751
9752
9753 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9754         {*&<&'replacements'&>&*}}*&"
9755 .cindex "expansion" "character translation"
9756 .cindex "&%tr%& expansion item"
9757 This item does single-character translation on its subject string. The second
9758 argument is a list of characters to be translated in the subject string. Each
9759 matching character is replaced by the corresponding character from the
9760 replacement list. For example
9761 .code
9762 ${tr{abcdea}{ac}{13}}
9763 .endd
9764 yields &`1b3de1`&. If there are duplicates in the second character string, the
9765 last occurrence is used. If the third string is shorter than the second, its
9766 last character is replicated. However, if it is empty, no translation takes
9767 place.
9768 .endlist
9769
9770
9771
9772 .section "Expansion operators" "SECTexpop"
9773 .cindex "expansion" "operators"
9774 For expansion items that perform transformations on a single argument string,
9775 the &"operator"& notation is used because it is simpler and uses fewer braces.
9776 The substring is first expanded before the operation is applied to it. The
9777 following operations can be performed:
9778
9779 .vlist
9780 .vitem &*${address:*&<&'string'&>&*}*&
9781 .cindex "expansion" "RFC 2822 address handling"
9782 .cindex "&%address%& expansion item"
9783 The string is interpreted as an RFC 2822 address, as it might appear in a
9784 header line, and the effective address is extracted from it. If the string does
9785 not parse successfully, the result is empty.
9786
9787
9788 .vitem &*${addresses:*&<&'string'&>&*}*&
9789 .cindex "expansion" "RFC 2822 address handling"
9790 .cindex "&%addresses%& expansion item"
9791 The string (after expansion) is interpreted as a list of addresses in RFC
9792 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9793 operative address (&'local-part@domain'&) is extracted from each item, and the
9794 result of the expansion is a colon-separated list, with appropriate
9795 doubling of colons should any happen to be present in the email addresses.
9796 Syntactically invalid RFC2822 address items are omitted from the output.
9797
9798 It is possible to specify a character other than colon for the output
9799 separator by starting the string with > followed by the new separator
9800 character. For example:
9801 .code
9802 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9803 .endd
9804 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9805 expansion item, which extracts the working address from a single RFC2822
9806 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9807 processing lists.
9808
9809 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9810 a strict interpretation of header line formatting.  Exim parses the bare,
9811 unquoted portion of an email address and if it finds a comma, treats it as an
9812 email address seperator. For the example header line:
9813 .code
9814 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9815 .endd
9816 The first example below demonstrates that Q-encoded email addresses are parsed
9817 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9818 It does not see the comma because it's still encoded as "=2C".  The second
9819 example below is passed the contents of &`$header_from:`&, meaning it gets
9820 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9821 The third example shows that the presence of a comma is skipped when it is
9822 quoted.
9823 .code
9824 # exim -be '${addresses:From: \
9825 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9826 user@example.com
9827 # exim -be '${addresses:From: Last, First <user@example.com>}'
9828 Last:user@example.com
9829 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9830 user@example.com
9831 .endd
9832
9833 .vitem &*${base62:*&<&'digits'&>&*}*&
9834 .cindex "&%base62%& expansion item"
9835 .cindex "expansion" "conversion to base 62"
9836 The string must consist entirely of decimal digits. The number is converted to
9837 base 62 and output as a string of six characters, including leading zeros. In
9838 the few operating environments where Exim uses base 36 instead of base 62 for
9839 its message identifiers (because those systems do not have case-sensitive file
9840 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9841 be absolutely clear: this is &'not'& base64 encoding.
9842
9843 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9844 .cindex "&%base62d%& expansion item"
9845 .cindex "expansion" "conversion to base 62"
9846 The string must consist entirely of base-62 digits, or, in operating
9847 environments where Exim uses base 36 instead of base 62 for its message
9848 identifiers, base-36 digits. The number is converted to decimal and output as a
9849 string.
9850
9851
9852 .vitem &*${domain:*&<&'string'&>&*}*&
9853 .cindex "domain" "extraction"
9854 .cindex "expansion" "domain extraction"
9855 The string is interpreted as an RFC 2822 address and the domain is extracted
9856 from it. If the string does not parse successfully, the result is empty.
9857
9858
9859 .vitem &*${escape:*&<&'string'&>&*}*&
9860 .cindex "expansion" "escaping non-printing characters"
9861 .cindex "&%escape%& expansion item"
9862 If the string contains any non-printing characters, they are converted to
9863 escape sequences starting with a backslash. Whether characters with the most
9864 significant bit set (so-called &"8-bit characters"&) count as printing or not
9865 is controlled by the &%print_topbitchars%& option.
9866
9867
9868 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9869 .cindex "expansion" "expression evaluation"
9870 .cindex "expansion" "arithmetic expression"
9871 .cindex "&%eval%& expansion item"
9872 These items supports simple arithmetic and bitwise logical operations in
9873 expansion strings. The string (after expansion) must be a conventional
9874 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9875 logical operators, and parentheses. All operations are carried out using
9876 integer arithmetic. The operator priorities are as follows (the same as in the
9877 C programming language):
9878 .table2 70pt 300pt
9879 .irow &'highest:'& "not (~), negate (-)"
9880 .irow ""   "multiply (*), divide (/), remainder (%)"
9881 .irow ""   "plus (+), minus (-)"
9882 .irow ""   "shift-left (<<), shift-right (>>)"
9883 .irow ""   "and (&&)"
9884 .irow ""   "xor (^)"
9885 .irow &'lowest:'&  "or (|)"
9886 .endtable
9887 Binary operators with the same priority are evaluated from left to right. White
9888 space is permitted before or after operators.
9889
9890 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9891 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9892 decimal, even if they start with a leading zero; hexadecimal numbers are not
9893 permitted. This can be useful when processing numbers extracted from dates or
9894 times, which often do have leading zeros.
9895
9896 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9897 or 1024*1024*1024,
9898 respectively. Negative numbers are supported. The result of the computation is
9899 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9900
9901 .display
9902 &`${eval:1+1}            `&  yields 2
9903 &`${eval:1+2*3}          `&  yields 7
9904 &`${eval:(1+2)*3}        `&  yields 9
9905 &`${eval:2+42%5}         `&  yields 4
9906 &`${eval:0xc&amp;5}          `&  yields 4
9907 &`${eval:0xc|5}          `&  yields 13
9908 &`${eval:0xc^5}          `&  yields 9
9909 &`${eval:0xc>>1}         `&  yields 6
9910 &`${eval:0xc<<1}         `&  yields 24
9911 &`${eval:~255&amp;0x1234}    `&  yields 4608
9912 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9913 .endd
9914
9915 As a more realistic example, in an ACL you might have
9916 .code
9917 deny   message = Too many bad recipients
9918        condition =                    \
9919          ${if and {                   \
9920            {>{$rcpt_count}{10}}       \
9921            {                          \
9922            <                          \
9923              {$recipients_count}      \
9924              {${eval:$rcpt_count/2}}  \
9925            }                          \
9926          }{yes}{no}}
9927 .endd
9928 The condition is true if there have been more than 10 RCPT commands and
9929 fewer than half of them have resulted in a valid recipient.
9930
9931
9932 .vitem &*${expand:*&<&'string'&>&*}*&
9933 .cindex "expansion" "re-expansion of substring"
9934 The &%expand%& operator causes a string to be expanded for a second time. For
9935 example,
9936 .code
9937 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9938 .endd
9939 first looks up a string in a file while expanding the operand for &%expand%&,
9940 and then re-expands what it has found.
9941
9942
9943 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9944 .cindex "Unicode"
9945 .cindex "UTF-8" "conversion from"
9946 .cindex "expansion" "UTF-8 conversion"
9947 .cindex "&%from_utf8%& expansion item"
9948 The world is slowly moving towards Unicode, although there are no standards for
9949 email yet. However, other applications (including some databases) are starting
9950 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9951 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9952 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9953 the result is an undefined sequence of bytes.
9954
9955 Unicode code points with values less than 256 are compatible with ASCII and
9956 ISO-8859-1 (also known as Latin-1).
9957 For example, character 169 is the copyright symbol in both cases, though the
9958 way it is encoded is different. In UTF-8, more than one byte is needed for
9959 characters with code values greater than 127, whereas ISO-8859-1 is a
9960 single-byte encoding (but thereby limited to 256 characters). This makes
9961 translation from UTF-8 to ISO-8859-1 straightforward.
9962
9963
9964 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9965 .cindex "hash function" "textual"
9966 .cindex "expansion" "textual hash"
9967 The &%hash%& operator is a simpler interface to the hashing function that can
9968 be used when the two parameters are fixed numbers (as opposed to strings that
9969 change when expanded). The effect is the same as
9970 .code
9971 ${hash{<n>}{<m>}{<string>}}
9972 .endd
9973 See the description of the general &%hash%& item above for details. The
9974 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9975
9976
9977
9978 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9979 .cindex "base64 encoding" "conversion from hex"
9980 .cindex "expansion" "hex to base64"
9981 .cindex "&%hex2b64%& expansion item"
9982 This operator converts a hex string into one that is base64 encoded. This can
9983 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9984
9985
9986
9987 .vitem &*${hexquote:*&<&'string'&>&*}*&
9988 .cindex "quoting" "hex-encoded unprintable characters"
9989 .cindex "&%hexquote%& expansion item"
9990 This operator converts non-printable characters in a string into a hex
9991 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9992 as is, and other byte values are converted to &`\xNN`&, for example a
9993 byte value 127 is converted to &`\x7f`&.
9994
9995
9996 .vitem &*${lc:*&<&'string'&>&*}*&
9997 .cindex "case forcing in strings"
9998 .cindex "string" "case forcing"
9999 .cindex "lower casing"
10000 .cindex "expansion" "case forcing"
10001 .cindex "&%lc%& expansion item"
10002 This forces the letters in the string into lower-case, for example:
10003 .code
10004 ${lc:$local_part}
10005 .endd
10006
10007 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10008 .cindex "expansion" "string truncation"
10009 .cindex "&%length%& expansion item"
10010 The &%length%& operator is a simpler interface to the &%length%& function that
10011 can be used when the parameter is a fixed number (as opposed to a string that
10012 changes when expanded). The effect is the same as
10013 .code
10014 ${length{<number>}{<string>}}
10015 .endd
10016 See the description of the general &%length%& item above for details. Note that
10017 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10018 when &%length%& is used as an operator.
10019
10020
10021 .vitem &*${listcount:*&<&'string'&>&*}*&
10022 .cindex "expansion" "list item count"
10023 .cindex "list" "item count"
10024 .cindex "list" "count of items"
10025 .cindex "&%listcount%& expansion item"
10026 The string is interpreted as a list and the number of items is returned.
10027
10028
10029 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10030 .cindex "expansion" "named list"
10031 .cindex "&%listnamed%& expansion item"
10032 The name is interpreted as a named list and the content of the list is returned,
10033 expanding any referenced lists, re-quoting as needed for colon-separation.
10034 If the optional type is given it must be one of "a", "d", "h" or "l"
10035 and selects address-, domain-, host- or localpart- lists to search among respectively.
10036 Otherwise all types are searched in an undefined order and the first
10037 matching list is returned.
10038
10039
10040 .vitem &*${local_part:*&<&'string'&>&*}*&
10041 .cindex "expansion" "local part extraction"
10042 .cindex "&%local_part%& expansion item"
10043 The string is interpreted as an RFC 2822 address and the local part is
10044 extracted from it. If the string does not parse successfully, the result is
10045 empty.
10046
10047
10048 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10049 .cindex "masked IP address"
10050 .cindex "IP address" "masking"
10051 .cindex "CIDR notation"
10052 .cindex "expansion" "IP address masking"
10053 .cindex "&%mask%& expansion item"
10054 If the form of the string to be operated on is not an IP address followed by a
10055 slash and an integer (that is, a network address in CIDR notation), the
10056 expansion fails. Otherwise, this operator converts the IP address to binary,
10057 masks off the least significant bits according to the bit count, and converts
10058 the result back to text, with mask appended. For example,
10059 .code
10060 ${mask:10.111.131.206/28}
10061 .endd
10062 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10063 be mostly used for looking up masked addresses in files, the result for an IPv6
10064 address uses dots to separate components instead of colons, because colon
10065 terminates a key string in lsearch files. So, for example,
10066 .code
10067 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10068 .endd
10069 returns the string
10070 .code
10071 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10072 .endd
10073 Letters in IPv6 addresses are always output in lower case.
10074
10075
10076 .vitem &*${md5:*&<&'string'&>&*}*&
10077 .cindex "MD5 hash"
10078 .cindex "expansion" "MD5 hash"
10079 .cindex "certificate fingerprint"
10080 .cindex "&%md5%& expansion item"
10081 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10082 as a 32-digit hexadecimal number, in which any letters are in lower case.
10083
10084
10085 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10086 .cindex "expansion" "numeric hash"
10087 .cindex "hash function" "numeric"
10088 The &%nhash%& operator is a simpler interface to the numeric hashing function
10089 that can be used when the two parameters are fixed numbers (as opposed to
10090 strings that change when expanded). The effect is the same as
10091 .code
10092 ${nhash{<n>}{<m>}{<string>}}
10093 .endd
10094 See the description of the general &%nhash%& item above for details.
10095
10096
10097 .vitem &*${quote:*&<&'string'&>&*}*&
10098 .cindex "quoting" "in string expansions"
10099 .cindex "expansion" "quoting"
10100 .cindex "&%quote%& expansion item"
10101 The &%quote%& operator puts its argument into double quotes if it
10102 is an empty string or
10103 contains anything other than letters, digits, underscores, dots, and hyphens.
10104 Any occurrences of double quotes and backslashes are escaped with a backslash.
10105 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10106 respectively For example,
10107 .code
10108 ${quote:ab"*"cd}
10109 .endd
10110 becomes
10111 .code
10112 "ab\"*\"cd"
10113 .endd
10114 The place where this is useful is when the argument is a substitution from a
10115 variable or a message header.
10116
10117 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10118 .cindex "&%quote_local_part%& expansion item"
10119 This operator is like &%quote%&, except that it quotes the string only if
10120 required to do so by the rules of RFC 2822 for quoting local parts. For
10121 example, a plus sign would not cause quoting (but it would for &%quote%&).
10122 If you are creating a new email address from the contents of &$local_part$&
10123 (or any other unknown data), you should always use this operator.
10124
10125
10126 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10127 .cindex "quoting" "lookup-specific"
10128 This operator applies lookup-specific quoting rules to the string. Each
10129 query-style lookup type has its own quoting rules which are described with
10130 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10131 .code
10132 ${quote_ldap:two * two}
10133 .endd
10134 returns
10135 .code
10136 two%20%5C2A%20two
10137 .endd
10138 For single-key lookup types, no quoting is ever necessary and this operator
10139 yields an unchanged string.
10140
10141
10142 .vitem &*${randint:*&<&'n'&>&*}*&
10143 .cindex "random number"
10144 This operator returns a somewhat random number which is less than the
10145 supplied number and is at least 0.  The quality of this randomness depends
10146 on how Exim was built; the values are not suitable for keying material.
10147 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10148 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10149 for versions of GnuTLS with that function.
10150 Otherwise, the implementation may be arc4random(), random() seeded by
10151 srandomdev() or srandom(), or a custom implementation even weaker than
10152 random().
10153
10154
10155 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10156 .cindex "expansion" "IP address"
10157 This operator reverses an IP address; for IPv4 addresses, the result is in
10158 dotted-quad decimal form, while for IPv6 addreses the result is in
10159 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10160 for DNS.  For example,
10161 .code
10162 ${reverse_ip:192.0.2.4}
10163 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10164 .endd
10165 returns
10166 .code
10167 4.2.0.192
10168 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
10169 .endd
10170
10171
10172 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10173 .cindex "expansion" "RFC 2047"
10174 .cindex "RFC 2047" "expansion operator"
10175 .cindex "&%rfc2047%& expansion item"
10176 This operator encodes text according to the rules of RFC 2047. This is an
10177 encoding that is used in header lines to encode non-ASCII characters. It is
10178 assumed that the input string is in the encoding specified by the
10179 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10180 contains only characters in the range 33&--126, and no instances of the
10181 characters
10182 .code
10183 ? = ( ) < > @ , ; : \ " . [ ] _
10184 .endd
10185 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10186 string, using as many &"encoded words"& as necessary to encode all the
10187 characters.
10188
10189
10190 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10191 .cindex "expansion" "RFC 2047"
10192 .cindex "RFC 2047" "decoding"
10193 .cindex "&%rfc2047d%& expansion item"
10194 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10195 bytes are replaced by question marks. Characters are converted into the
10196 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10197 not recognized unless &%check_rfc2047_length%& is set false.
10198
10199 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10200 access a header line, RFC 2047 decoding is done automatically. You do not need
10201 to use this operator as well.
10202
10203
10204
10205 .vitem &*${rxquote:*&<&'string'&>&*}*&
10206 .cindex "quoting" "in regular expressions"
10207 .cindex "regular expressions" "quoting"
10208 .cindex "&%rxquote%& expansion item"
10209 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10210 characters in its argument. This is useful when substituting the values of
10211 variables or headers inside regular expressions.
10212
10213
10214 .vitem &*${sha1:*&<&'string'&>&*}*&
10215 .cindex "SHA-1 hash"
10216 .cindex "expansion" "SHA-1 hashing"
10217 .cindex "certificate fingerprint"
10218 .cindex "&%sha2%& expansion item"
10219 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10220 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10221
10222
10223 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10224 .cindex "SHA-256 hash"
10225 .cindex "certificate fingerprint"
10226 .cindex "expansion" "SHA-256 hashing"
10227 .cindex "&%sha256%& expansion item"
10228 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10229 certificate,
10230 and returns
10231 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10232 Only arguments which are a single variable of certificate type are supported.
10233
10234
10235 .vitem &*${stat:*&<&'string'&>&*}*&
10236 .cindex "expansion" "statting a file"
10237 .cindex "file" "extracting characteristics"
10238 .cindex "&%stat%& expansion item"
10239 The string, after expansion, must be a file path. A call to the &[stat()]&
10240 function is made for this path. If &[stat()]& fails, an error occurs and the
10241 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10242 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10243 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10244 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10245 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10246 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10247 can extract individual fields using the &%extract%& expansion item.
10248
10249 The use of the &%stat%& expansion in users' filter files can be locked out by
10250 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10251 systems for files larger than 2GB.
10252
10253 .vitem &*${str2b64:*&<&'string'&>&*}*&
10254 .cindex "expansion" "base64 encoding"
10255 .cindex "base64 encoding" "in string expansion"
10256 .cindex "&%str2b64%& expansion item"
10257 This operator converts a string into one that is base64 encoded.
10258
10259
10260
10261 .vitem &*${strlen:*&<&'string'&>&*}*&
10262 .cindex "expansion" "string length"
10263 .cindex "string" "length in expansion"
10264 .cindex "&%strlen%& expansion item"
10265 The item is replace by the length of the expanded string, expressed as a
10266 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10267
10268
10269 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10270 .cindex "&%substr%& expansion item"
10271 .cindex "substring extraction"
10272 .cindex "expansion" "substring expansion"
10273 The &%substr%& operator is a simpler interface to the &%substr%& function that
10274 can be used when the two parameters are fixed numbers (as opposed to strings
10275 that change when expanded). The effect is the same as
10276 .code
10277 ${substr{<start>}{<length>}{<string>}}
10278 .endd
10279 See the description of the general &%substr%& item above for details. The
10280 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10281
10282 .vitem &*${time_eval:*&<&'string'&>&*}*&
10283 .cindex "&%time_eval%& expansion item"
10284 .cindex "time interval" "decoding"
10285 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10286 seconds.
10287
10288 .vitem &*${time_interval:*&<&'string'&>&*}*&
10289 .cindex "&%time_interval%& expansion item"
10290 .cindex "time interval" "formatting"
10291 The argument (after sub-expansion) must be a sequence of decimal digits that
10292 represents an interval of time as a number of seconds. It is converted into a
10293 number of larger units and output in Exim's normal time format, for example,
10294 &`1w3d4h2m6s`&.
10295
10296 .vitem &*${uc:*&<&'string'&>&*}*&
10297 .cindex "case forcing in strings"
10298 .cindex "string" "case forcing"
10299 .cindex "upper casing"
10300 .cindex "expansion" "case forcing"
10301 .cindex "&%uc%& expansion item"
10302 This forces the letters in the string into upper-case.
10303
10304 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10305 .cindex "correction of invalid utf-8 sequences in strings"
10306 .cindex "utf-8" "utf-8 sequences"
10307 .cindex "incorrect utf-8"
10308 .cindex "expansion" "utf-8 forcing"
10309 .cindex "&%utf8clean%& expansion item"
10310 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10311 .endlist
10312
10313
10314
10315
10316
10317
10318 .section "Expansion conditions" "SECTexpcond"
10319 .scindex IIDexpcond "expansion" "conditions"
10320 The following conditions are available for testing by the &%${if%& construct
10321 while expanding strings:
10322
10323 .vlist
10324 .vitem &*!*&<&'condition'&>
10325 .cindex "expansion" "negating a condition"
10326 .cindex "negation" "in expansion condition"
10327 Preceding any condition with an exclamation mark negates the result of the
10328 condition.
10329
10330 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10331 .cindex "numeric comparison"
10332 .cindex "expansion" "numeric comparison"
10333 There are a number of symbolic operators for doing numeric comparisons. They
10334 are:
10335 .display
10336 &`=   `&   equal
10337 &`==  `&   equal
10338 &`>   `&   greater
10339 &`>=  `&   greater or equal
10340 &`<   `&   less
10341 &`<=  `&   less or equal
10342 .endd
10343 For example:
10344 .code
10345 ${if >{$message_size}{10M} ...
10346 .endd
10347 Note that the general negation operator provides for inequality testing. The
10348 two strings must take the form of optionally signed decimal integers,
10349 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10350 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10351 As a special case, the numerical value of an empty string is taken as
10352 zero.
10353
10354 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10355 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10356 10M, not if 10M is larger than &$message_size$&.
10357
10358
10359 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10360         {*&<&'arg2'&>&*}...}*&
10361 .cindex "expansion" "calling an acl"
10362 .cindex "&%acl%&" "expansion condition"
10363 The name and zero to nine argument strings are first expanded separately.  The expanded
10364 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10365 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10366 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10367 and may use the variables; if another acl expansion is used the values
10368 are restored after it returns.  If the ACL sets
10369 a value using a "message =" modifier the variable $value becomes
10370 the result of the expansion, otherwise it is empty.
10371 If the ACL returns accept the condition is true; if deny, false.
10372 If the ACL returns defer the result is a forced-fail.
10373
10374 .vitem &*bool&~{*&<&'string'&>&*}*&
10375 .cindex "expansion" "boolean parsing"
10376 .cindex "&%bool%& expansion condition"
10377 This condition turns a string holding a true or false representation into
10378 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10379 (case-insensitively); also integer numbers map to true if non-zero,
10380 false if zero.
10381 An empty string is treated as false.
10382 Leading and trailing whitespace is ignored;
10383 thus a string consisting only of whitespace is false.
10384 All other string values will result in expansion failure.
10385
10386 When combined with ACL variables, this expansion condition will let you
10387 make decisions in one place and act on those decisions in another place.
10388 For example:
10389 .code
10390 ${if bool{$acl_m_privileged_sender} ...
10391 .endd
10392
10393
10394 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10395 .cindex "expansion" "boolean parsing"
10396 .cindex "&%bool_lax%& expansion condition"
10397 Like &%bool%&, this condition turns a string into a boolean state.  But
10398 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10399 loose definition that the Router &%condition%& option uses.  The empty string
10400 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10401 true.  Leading and trailing whitespace is ignored.
10402
10403 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10404
10405 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10406 .cindex "expansion" "encrypted comparison"
10407 .cindex "encrypted strings, comparing"
10408 .cindex "&%crypteq%& expansion condition"
10409 This condition is included in the Exim binary if it is built to support any
10410 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10411 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10412 included in the binary.
10413
10414 The &%crypteq%& condition has two arguments. The first is encrypted and
10415 compared against the second, which is already encrypted. The second string may
10416 be in the LDAP form for storing encrypted strings, which starts with the
10417 encryption type in curly brackets, followed by the data. If the second string
10418 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10419 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10420 Typically this will be a field from a password file. An example of an encrypted
10421 string in LDAP form is:
10422 .code
10423 {md5}CY9rzUYh03PK3k6DJie09g==
10424 .endd
10425 If such a string appears directly in an expansion, the curly brackets have to
10426 be quoted, because they are part of the expansion syntax. For example:
10427 .code
10428 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10429 .endd
10430 The following encryption types (whose names are matched case-independently) are
10431 supported:
10432
10433 .ilist
10434 .cindex "MD5 hash"
10435 .cindex "base64 encoding" "in encrypted password"
10436 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10437 printable characters to compare with the remainder of the second string. If the
10438 length of the comparison string is 24, Exim assumes that it is base64 encoded
10439 (as in the above example). If the length is 32, Exim assumes that it is a
10440 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10441 comparison fails.
10442
10443 .next
10444 .cindex "SHA-1 hash"
10445 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10446 printable characters to compare with the remainder of the second string. If the
10447 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10448 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10449 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10450
10451 .next
10452 .cindex "&[crypt()]&"
10453 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10454 only the first eight characters of the password. However, in modern operating
10455 systems this is no longer true, and in many cases the entire password is used,
10456 whatever its length.
10457
10458 .next
10459 .cindex "&[crypt16()]&"
10460 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10461 use up to 16 characters of the password in some operating systems. Again, in
10462 modern operating systems, more characters may be used.
10463 .endlist
10464 Exim has its own version of &[crypt16()]&, which is just a double call to
10465 &[crypt()]&. For operating systems that have their own version, setting
10466 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10467 operating system version instead of its own. This option is set by default in
10468 the OS-dependent &_Makefile_& for those operating systems that are known to
10469 support &[crypt16()]&.
10470
10471 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10472 it was not using the same algorithm as some operating systems' versions. It
10473 turns out that as well as &[crypt16()]& there is a function called
10474 &[bigcrypt()]& in some operating systems. This may or may not use the same
10475 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10476
10477 However, since there is now a move away from the traditional &[crypt()]&
10478 functions towards using SHA1 and other algorithms, tidying up this area of
10479 Exim is seen as very low priority.
10480
10481 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10482 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10483 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10484 default is &`{crypt}`&. Whatever the default, you can always use either
10485 function by specifying it explicitly in curly brackets.
10486
10487 .vitem &*def:*&<&'variable&~name'&>
10488 .cindex "expansion" "checking for empty variable"
10489 .cindex "&%def%& expansion condition"
10490 The &%def%& condition must be followed by the name of one of the expansion
10491 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10492 variable does not contain the empty string. For example:
10493 .code
10494 ${if def:sender_ident {from $sender_ident}}
10495 .endd
10496 Note that the variable name is given without a leading &%$%& character. If the
10497 variable does not exist, the expansion fails.
10498
10499 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10500         &~&*def:h_*&<&'header&~name'&>&*:*&"
10501 .cindex "expansion" "checking header line existence"
10502 This condition is true if a message is being processed and the named header
10503 exists in the message. For example,
10504 .code
10505 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10506 .endd
10507 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10508 the header name must be terminated by a colon if white space does not follow.
10509
10510 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10511        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10512 .cindex "string" "comparison"
10513 .cindex "expansion" "string comparison"
10514 .cindex "&%eq%& expansion condition"
10515 .cindex "&%eqi%& expansion condition"
10516 The two substrings are first expanded. The condition is true if the two
10517 resulting strings are identical. For &%eq%& the comparison includes the case of
10518 letters, whereas for &%eqi%& the comparison is case-independent.
10519
10520 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10521 .cindex "expansion" "file existence test"
10522 .cindex "file" "existence test"
10523 .cindex "&%exists%&, expansion condition"
10524 The substring is first expanded and then interpreted as an absolute path. The
10525 condition is true if the named file (or directory) exists. The existence test
10526 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10527 users' filter files may be locked out by the system administrator.
10528
10529 .vitem &*first_delivery*&
10530 .cindex "delivery" "first"
10531 .cindex "first delivery"
10532 .cindex "expansion" "first delivery test"
10533 .cindex "&%first_delivery%& expansion condition"
10534 This condition, which has no data, is true during a message's first delivery
10535 attempt. It is false during any subsequent delivery attempts.
10536
10537
10538 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10539        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10540 .cindex "list" "iterative conditions"
10541 .cindex "expansion" "&*forall*& condition"
10542 .cindex "expansion" "&*forany*& condition"
10543 .vindex "&$item$&"
10544 These conditions iterate over a list. The first argument is expanded to form
10545 the list. By default, the list separator is a colon, but it can be changed by
10546 the normal method. The second argument is interpreted as a condition that is to
10547 be applied to each item in the list in turn. During the interpretation of the
10548 condition, the current list item is placed in a variable called &$item$&.
10549 .ilist
10550 For &*forany*&, interpretation stops if the condition is true for any item, and
10551 the result of the whole condition is true. If the condition is false for all
10552 items in the list, the overall condition is false.
10553 .next
10554 For &*forall*&, interpretation stops if the condition is false for any item,
10555 and the result of the whole condition is false. If the condition is true for
10556 all items in the list, the overall condition is true.
10557 .endlist
10558 Note that negation of &*forany*& means that the condition must be false for all
10559 items for the overall condition to succeed, and negation of &*forall*& means
10560 that the condition must be false for at least one item. In this example, the
10561 list separator is changed to a comma:
10562 .code
10563 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10564 .endd
10565 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10566 being processed, to enable these expansion items to be nested.
10567
10568 To scan a named list, expand it with the &*listnamed*& operator.
10569
10570
10571 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10572        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10573 .cindex "string" "comparison"
10574 .cindex "expansion" "string comparison"
10575 .cindex "&%ge%& expansion condition"
10576 .cindex "&%gei%& expansion condition"
10577 The two substrings are first expanded. The condition is true if the first
10578 string is lexically greater than or equal to the second string. For &%ge%& the
10579 comparison includes the case of letters, whereas for &%gei%& the comparison is
10580 case-independent.
10581
10582 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10583        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10584 .cindex "string" "comparison"
10585 .cindex "expansion" "string comparison"
10586 .cindex "&%gt%& expansion condition"
10587 .cindex "&%gti%& expansion condition"
10588 The two substrings are first expanded. The condition is true if the first
10589 string is lexically greater than the second string. For &%gt%& the comparison
10590 includes the case of letters, whereas for &%gti%& the comparison is
10591 case-independent.
10592
10593 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10594        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10595 .cindex "string" "comparison"
10596 .cindex "list" "iterative conditions"
10597 Both strings are expanded; the second string is treated as a list of simple
10598 strings; if the first string is a member of the second, then the condition
10599 is true.
10600
10601 These are simpler to use versions of the more powerful &*forany*& condition.
10602 Examples, and the &*forany*& equivalents:
10603 .code
10604 ${if inlist{needle}{foo:needle:bar}}
10605   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10606 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10607   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10608 .endd
10609
10610 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10611        &*isip4&~{*&<&'string'&>&*}*& &&&
10612        &*isip6&~{*&<&'string'&>&*}*&
10613 .cindex "IP address" "testing string format"
10614 .cindex "string" "testing for IP address"
10615 .cindex "&%isip%& expansion condition"
10616 .cindex "&%isip4%& expansion condition"
10617 .cindex "&%isip6%& expansion condition"
10618 The substring is first expanded, and then tested to see if it has the form of
10619 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10620 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10621
10622 For an IPv4 address, the test is for four dot-separated components, each of
10623 which consists of from one to three digits. For an IPv6 address, up to eight
10624 colon-separated components are permitted, each containing from one to four
10625 hexadecimal digits. There may be fewer than eight components if an empty
10626 component (adjacent colons) is present. Only one empty component is permitted.
10627
10628 &*Note*&: The checks are just on the form of the address; actual numerical
10629 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10630 check. The main use of these tests is to distinguish between IP addresses and
10631 host names, or between IPv4 and IPv6 addresses. For example, you could use
10632 .code
10633 ${if isip4{$sender_host_address}...
10634 .endd
10635 to test which IP version an incoming SMTP connection is using.
10636
10637 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10638 .cindex "LDAP" "use for authentication"
10639 .cindex "expansion" "LDAP authentication test"
10640 .cindex "&%ldapauth%& expansion condition"
10641 This condition supports user authentication using LDAP. See section
10642 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10643 queries. For this use, the query must contain a user name and password. The
10644 query itself is not used, and can be empty. The condition is true if the
10645 password is not empty, and the user name and password are accepted by the LDAP
10646 server. An empty password is rejected without calling LDAP because LDAP binds
10647 with an empty password are considered anonymous regardless of the username, and
10648 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10649 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10650 this can be used.
10651
10652
10653 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10654        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10655 .cindex "string" "comparison"
10656 .cindex "expansion" "string comparison"
10657 .cindex "&%le%& expansion condition"
10658 .cindex "&%lei%& expansion condition"
10659 The two substrings are first expanded. The condition is true if the first
10660 string is lexically less than or equal to the second string. For &%le%& the
10661 comparison includes the case of letters, whereas for &%lei%& the comparison is
10662 case-independent.
10663
10664 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10665        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10666 .cindex "string" "comparison"
10667 .cindex "expansion" "string comparison"
10668 .cindex "&%lt%& expansion condition"
10669 .cindex "&%lti%& expansion condition"
10670 The two substrings are first expanded. The condition is true if the first
10671 string is lexically less than the second string. For &%lt%& the comparison
10672 includes the case of letters, whereas for &%lti%& the comparison is
10673 case-independent.
10674
10675
10676 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10677 .cindex "expansion" "regular expression comparison"
10678 .cindex "regular expressions" "match in expanded string"
10679 .cindex "&%match%& expansion condition"
10680 The two substrings are first expanded. The second is then treated as a regular
10681 expression and applied to the first. Because of the pre-expansion, if the
10682 regular expression contains dollar, or backslash characters, they must be
10683 escaped. Care must also be taken if the regular expression contains braces
10684 (curly brackets). A closing brace must be escaped so that it is not taken as a
10685 premature termination of <&'string2'&>. The easiest approach is to use the
10686 &`\N`& feature to disable expansion of the regular expression.
10687 For example,
10688 .code
10689 ${if match {$local_part}{\N^\d{3}\N} ...
10690 .endd
10691 If the whole expansion string is in double quotes, further escaping of
10692 backslashes is also required.
10693
10694 The condition is true if the regular expression match succeeds.
10695 The regular expression is not required to begin with a circumflex
10696 metacharacter, but if there is no circumflex, the expression is not anchored,
10697 and it may match anywhere in the subject, not just at the start. If you want
10698 the pattern to match at the end of the subject, you must include the &`$`&
10699 metacharacter at an appropriate point.
10700
10701 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10702 At the start of an &%if%& expansion the values of the numeric variable
10703 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10704 succeeds causes them to be reset to the substrings of that condition and they
10705 will have these values during the expansion of the success string. At the end
10706 of the &%if%& expansion, the previous values are restored. After testing a
10707 combination of conditions using &%or%&, the subsequent values of the numeric
10708 variables are those of the condition that succeeded.
10709
10710 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10711 .cindex "&%match_address%& expansion condition"
10712 See &*match_local_part*&.
10713
10714 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10715 .cindex "&%match_domain%& expansion condition"
10716 See &*match_local_part*&.
10717
10718 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10719 .cindex "&%match_ip%& expansion condition"
10720 This condition matches an IP address to a list of IP address patterns. It must
10721 be followed by two argument strings. The first (after expansion) must be an IP
10722 address or an empty string. The second (not expanded) is a restricted host
10723 list that can match only an IP address, not a host name. For example:
10724 .code
10725 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10726 .endd
10727 The specific types of host list item that are permitted in the list are:
10728
10729 .ilist
10730 An IP address, optionally with a CIDR mask.
10731 .next
10732 A single asterisk, which matches any IP address.
10733 .next
10734 An empty item, which matches only if the IP address is empty. This could be
10735 useful for testing for a locally submitted message or one from specific hosts
10736 in a single test such as
10737 . ==== As this is a nested list, any displays it contains must be indented
10738 . ==== as otherwise they are too far to the left. This comment applies to
10739 . ==== the use of xmlto plus fop. There's no problem when formatting with
10740 . ==== sdop, with or without the extra indent.
10741 .code
10742   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10743 .endd
10744 where the first item in the list is the empty string.
10745 .next
10746 The item @[] matches any of the local host's interface addresses.
10747 .next
10748 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10749 even if &`net-`& is not specified. There is never any attempt to turn the IP
10750 address into a host name. The most common type of linear search for
10751 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10752 masks. For example:
10753 .code
10754   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10755 .endd
10756 It is of course possible to use other kinds of lookup, and in such a case, you
10757 do need to specify the &`net-`& prefix if you want to specify a specific
10758 address mask, for example:
10759 .code
10760   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10761 .endd
10762 However, unless you are combining a &%match_ip%& condition with others, it is
10763 just as easy to use the fact that a lookup is itself a condition, and write:
10764 .code
10765   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10766 .endd
10767 .endlist ilist
10768
10769 Note that <&'string2'&> is not itself subject to string expansion, unless
10770 Exim was built with the EXPAND_LISTMATCH_RHS option.
10771
10772 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10773
10774 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10775 .cindex "domain list" "in expansion condition"
10776 .cindex "address list" "in expansion condition"
10777 .cindex "local part" "list, in expansion condition"
10778 .cindex "&%match_local_part%& expansion condition"
10779 This condition, together with &%match_address%& and &%match_domain%&, make it
10780 possible to test domain, address, and local part lists within expansions. Each
10781 condition requires two arguments: an item and a list to match. A trivial
10782 example is:
10783 .code
10784 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10785 .endd
10786 In each case, the second argument may contain any of the allowable items for a
10787 list of the appropriate type. Also, because the second argument (after
10788 expansion) is a standard form of list, it is possible to refer to a named list.
10789 Thus, you can use conditions like this:
10790 .code
10791 ${if match_domain{$domain}{+local_domains}{...
10792 .endd
10793 .cindex "&`+caseful`&"
10794 For address lists, the matching starts off caselessly, but the &`+caseful`&
10795 item can be used, as in all address lists, to cause subsequent items to
10796 have their local parts matched casefully. Domains are always matched
10797 caselessly.
10798
10799 Note that <&'string2'&> is not itself subject to string expansion, unless
10800 Exim was built with the EXPAND_LISTMATCH_RHS option.
10801
10802 &*Note*&: Host lists are &'not'& supported in this way. This is because
10803 hosts have two identities: a name and an IP address, and it is not clear
10804 how to specify cleanly how such a test would work. However, IP addresses can be
10805 matched using &%match_ip%&.
10806
10807 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10808 .cindex "PAM authentication"
10809 .cindex "AUTH" "with PAM"
10810 .cindex "Solaris" "PAM support"
10811 .cindex "expansion" "PAM authentication test"
10812 .cindex "&%pam%& expansion condition"
10813 &'Pluggable Authentication Modules'&
10814 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10815 available in the latest releases of Solaris and in some GNU/Linux
10816 distributions. The Exim support, which is intended for use in conjunction with
10817 the SMTP AUTH command, is available only if Exim is compiled with
10818 .code
10819 SUPPORT_PAM=yes
10820 .endd
10821 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10822 in some releases of GNU/Linux &%-ldl%& is also needed.
10823
10824 The argument string is first expanded, and the result must be a
10825 colon-separated list of strings. Leading and trailing white space is ignored.
10826 The PAM module is initialized with the service name &"exim"& and the user name
10827 taken from the first item in the colon-separated data string (<&'string1'&>).
10828 The remaining items in the data string are passed over in response to requests
10829 from the authentication function. In the simple case there will only be one
10830 request, for a password, so the data consists of just two strings.
10831
10832 There can be problems if any of the strings are permitted to contain colon
10833 characters. In the usual way, these have to be doubled to avoid being taken as
10834 separators. If the data is being inserted from a variable, the &%sg%& expansion
10835 item can be used to double any existing colons. For example, the configuration
10836 of a LOGIN authenticator might contain this setting:
10837 .code
10838 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10839 .endd
10840 For a PLAIN authenticator you could use:
10841 .code
10842 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10843 .endd
10844 In some operating systems, PAM authentication can be done only from a process
10845 running as root. Since Exim is running as the Exim user when receiving
10846 messages, this means that PAM cannot be used directly in those systems.
10847 A patched version of the &'pam_unix'& module that comes with the
10848 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10849 The patched module allows one special uid/gid combination, in addition to root,
10850 to authenticate. If you build the patched module to allow the Exim user and
10851 group, PAM can then be used from an Exim authenticator.
10852
10853
10854 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10855 .cindex "&'pwcheck'& daemon"
10856 .cindex "Cyrus"
10857 .cindex "expansion" "&'pwcheck'& authentication test"
10858 .cindex "&%pwcheck%& expansion condition"
10859 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10860 This is one way of making it possible for passwords to be checked by a process
10861 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10862 deprecated. Its replacement is &'saslauthd'& (see below).
10863
10864 The pwcheck support is not included in Exim by default. You need to specify
10865 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10866 building Exim. For example:
10867 .code
10868 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10869 .endd
10870 You do not need to install the full Cyrus software suite in order to use
10871 the pwcheck daemon. You can compile and install just the daemon alone
10872 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10873 access to the &_/var/pwcheck_& directory.
10874
10875 The &%pwcheck%& condition takes one argument, which must be the user name and
10876 password, separated by a colon. For example, in a LOGIN authenticator
10877 configuration, you might have this:
10878 .code
10879 server_condition = ${if pwcheck{$auth1:$auth2}}
10880 .endd
10881 Again, for a PLAIN authenticator configuration, this would be:
10882 .code
10883 server_condition = ${if pwcheck{$auth2:$auth3}}
10884 .endd
10885 .vitem &*queue_running*&
10886 .cindex "queue runner" "detecting when delivering from"
10887 .cindex "expansion" "queue runner test"
10888 .cindex "&%queue_running%& expansion condition"
10889 This condition, which has no data, is true during delivery attempts that are
10890 initiated by queue runner processes, and false otherwise.
10891
10892
10893 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10894 .cindex "Radius"
10895 .cindex "expansion" "Radius authentication"
10896 .cindex "&%radius%& expansion condition"
10897 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10898 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10899 the Radius client configuration file in order to build Exim with Radius
10900 support.
10901
10902 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10903 library, using the original API. If you are using release 0.4.0 or later of
10904 this library, you need to set
10905 .code
10906 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10907 .endd
10908 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10909 &%libradius%& library that comes with FreeBSD. To do this, set
10910 .code
10911 RADIUS_LIB_TYPE=RADLIB
10912 .endd
10913 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10914 You may also have to supply a suitable setting in EXTRALIBS so that the
10915 Radius library can be found when Exim is linked.
10916
10917 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10918 Radius client library, which calls the Radius server. The condition is true if
10919 the authentication is successful. For example:
10920 .code
10921 server_condition = ${if radius{<arguments>}}
10922 .endd
10923
10924
10925 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10926         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10927 .cindex "&'saslauthd'& daemon"
10928 .cindex "Cyrus"
10929 .cindex "expansion" "&'saslauthd'& authentication test"
10930 .cindex "&%saslauthd%& expansion condition"
10931 This condition supports user authentication using the Cyrus &'saslauthd'&
10932 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10933 Using this daemon is one way of making it possible for passwords to be checked
10934 by a process that is not running as root.
10935
10936 The saslauthd support is not included in Exim by default. You need to specify
10937 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10938 building Exim. For example:
10939 .code
10940 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10941 .endd
10942 You do not need to install the full Cyrus software suite in order to use
10943 the saslauthd daemon. You can compile and install just the daemon alone
10944 from the Cyrus SASL library.
10945
10946 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10947 two are mandatory. For example:
10948 .code
10949 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10950 .endd
10951 The service and the realm are optional (which is why the arguments are enclosed
10952 in their own set of braces). For details of the meaning of the service and
10953 realm, and how to run the daemon, consult the Cyrus documentation.
10954 .endlist vlist
10955
10956
10957
10958 .section "Combining expansion conditions" "SECID84"
10959 .cindex "expansion" "combining conditions"
10960 Several conditions can be tested at once by combining them using the &%and%&
10961 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10962 conditions on their own, and precede their lists of sub-conditions. Each
10963 sub-condition must be enclosed in braces within the overall braces that contain
10964 the list. No repetition of &%if%& is used.
10965
10966
10967 .vlist
10968 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10969 .cindex "&""or""& expansion condition"
10970 .cindex "expansion" "&""or""& of conditions"
10971 The sub-conditions are evaluated from left to right. The condition is true if
10972 any one of the sub-conditions is true.
10973 For example,
10974 .code
10975 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10976 .endd
10977 When a true sub-condition is found, the following ones are parsed but not
10978 evaluated. If there are several &"match"& sub-conditions the values of the
10979 numeric variables afterwards are taken from the first one that succeeds.
10980
10981 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10982 .cindex "&""and""& expansion condition"
10983 .cindex "expansion" "&""and""& of conditions"
10984 The sub-conditions are evaluated from left to right. The condition is true if
10985 all of the sub-conditions are true. If there are several &"match"&
10986 sub-conditions, the values of the numeric variables afterwards are taken from
10987 the last one. When a false sub-condition is found, the following ones are
10988 parsed but not evaluated.
10989 .endlist
10990 .ecindex IIDexpcond
10991
10992
10993
10994
10995 .section "Expansion variables" "SECTexpvar"
10996 .cindex "expansion" "variables, list of"
10997 This section contains an alphabetical list of all the expansion variables. Some
10998 of them are available only when Exim is compiled with specific options such as
10999 support for TLS or the content scanning extension.
11000
11001 .vlist
11002 .vitem "&$0$&, &$1$&, etc"
11003 .cindex "numerical variables (&$1$& &$2$& etc)"
11004 When a &%match%& expansion condition succeeds, these variables contain the
11005 captured substrings identified by the regular expression during subsequent
11006 processing of the success string of the containing &%if%& expansion item.
11007 However, they do not retain their values afterwards; in fact, their previous
11008 values are restored at the end of processing an &%if%& item. The numerical
11009 variables may also be set externally by some other matching process which
11010 precedes the expansion of the string. For example, the commands available in
11011 Exim filter files include an &%if%& command with its own regular expression
11012 matching condition.
11013
11014 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11015 Within an acl condition, expansion condition or expansion item
11016 any arguments are copied to these variables,
11017 any unused variables being made empty.
11018
11019 .vitem "&$acl_c...$&"
11020 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11021 can be given any name that starts with &$acl_c$& and is at least six characters
11022 long, but the sixth character must be either a digit or an underscore. For
11023 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11024 variables persist throughout the lifetime of an SMTP connection. They can be
11025 used to pass information between ACLs and between different invocations of the
11026 same ACL. When a message is received, the values of these variables are saved
11027 with the message, and can be accessed by filters, routers, and transports
11028 during subsequent delivery.
11029
11030 .vitem "&$acl_m...$&"
11031 These variables are like the &$acl_c...$& variables, except that their values
11032 are reset after a message has been received. Thus, if several messages are
11033 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11034 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11035 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11036 message is received, the values of these variables are saved with the message,
11037 and can be accessed by filters, routers, and transports during subsequent
11038 delivery.
11039
11040 .vitem &$acl_narg$&
11041 Within an acl condition, expansion condition or expansion item
11042 this variable has the number of arguments.
11043
11044 .vitem &$acl_verify_message$&
11045 .vindex "&$acl_verify_message$&"
11046 After an address verification has failed, this variable contains the failure
11047 message. It retains its value for use in subsequent modifiers. The message can
11048 be preserved by coding like this:
11049 .code
11050 warn !verify = sender
11051      set acl_m0 = $acl_verify_message
11052 .endd
11053 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11054 &%log_message%& modifiers, to include information about the verification
11055 failure.
11056
11057 .vitem &$address_data$&
11058 .vindex "&$address_data$&"
11059 This variable is set by means of the &%address_data%& option in routers. The
11060 value then remains with the address while it is processed by subsequent routers
11061 and eventually a transport. If the transport is handling multiple addresses,
11062 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11063 for more details. &*Note*&: The contents of &$address_data$& are visible in
11064 user filter files.
11065
11066 If &$address_data$& is set when the routers are called from an ACL to verify
11067 a recipient address, the final value is still in the variable for subsequent
11068 conditions and modifiers of the ACL statement. If routing the address caused it
11069 to be redirected to just one address, the child address is also routed as part
11070 of the verification, and in this case the final value of &$address_data$& is
11071 from the child's routing.
11072
11073 If &$address_data$& is set when the routers are called from an ACL to verify a
11074 sender address, the final value is also preserved, but this time in
11075 &$sender_address_data$&, to distinguish it from data from a recipient
11076 address.
11077
11078 In both cases (recipient and sender verification), the value does not persist
11079 after the end of the current ACL statement. If you want to preserve
11080 these values for longer, you can save them in ACL variables.
11081
11082 .vitem &$address_file$&
11083 .vindex "&$address_file$&"
11084 When, as a result of aliasing, forwarding, or filtering, a message is directed
11085 to a specific file, this variable holds the name of the file when the transport
11086 is running. At other times, the variable is empty. For example, using the
11087 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11088 .code
11089 /home/r2d2/savemail
11090 .endd
11091 then when the &(address_file)& transport is running, &$address_file$&
11092 contains the text string &`/home/r2d2/savemail`&.
11093 .cindex "Sieve filter" "value of &$address_file$&"
11094 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11095 then up to the transport configuration to generate an appropriate absolute path
11096 to the relevant file.
11097
11098 .vitem &$address_pipe$&
11099 .vindex "&$address_pipe$&"
11100 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11101 this variable holds the pipe command when the transport is running.
11102
11103 .vitem "&$auth1$& &-- &$auth3$&"
11104 .vindex "&$auth1$&, &$auth2$&, etc"
11105 These variables are used in SMTP authenticators (see chapters
11106 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11107
11108 .vitem &$authenticated_id$&
11109 .cindex "authentication" "id"
11110 .vindex "&$authenticated_id$&"
11111 When a server successfully authenticates a client it may be configured to
11112 preserve some of the authentication information in the variable
11113 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11114 user/password authenticator configuration might preserve the user name for use
11115 in the routers. Note that this is not the same information that is saved in
11116 &$sender_host_authenticated$&.
11117 When a message is submitted locally (that is, not over a TCP connection)
11118 the value of &$authenticated_id$& is normally the login name of the calling
11119 process. However, a trusted user can override this by means of the &%-oMai%&
11120 command line option.
11121
11122 .vitem &$authenticated_fail_id$&
11123 .cindex "authentication" "fail" "id"
11124 .vindex "&$authenticated_fail_id$&"
11125 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11126 will contain the failed authentication id. If more than one authentication
11127 id is attempted, it will contain only the last one. The variable is
11128 available for processing in the ACL's, generally the quit or notquit ACL.
11129 A message to a local recipient could still be accepted without requiring
11130 authentication, which means this variable could also be visible in all of
11131 the ACL's as well.
11132
11133
11134 .vitem &$authenticated_sender$&
11135 .cindex "sender" "authenticated"
11136 .cindex "authentication" "sender"
11137 .cindex "AUTH" "on MAIL command"
11138 .vindex "&$authenticated_sender$&"
11139 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11140 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11141 described in section &<<SECTauthparamail>>&. Unless the data is the string
11142 &"<>"&, it is set as the authenticated sender of the message, and the value is
11143 available during delivery in the &$authenticated_sender$& variable. If the
11144 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11145
11146 .vindex "&$qualify_domain$&"
11147 When a message is submitted locally (that is, not over a TCP connection), the
11148 value of &$authenticated_sender$& is an address constructed from the login
11149 name of the calling process and &$qualify_domain$&, except that a trusted user
11150 can override this by means of the &%-oMas%& command line option.
11151
11152
11153 .vitem &$authentication_failed$&
11154 .cindex "authentication" "failure"
11155 .vindex "&$authentication_failed$&"
11156 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11157 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11158 possible to distinguish between &"did not try to authenticate"&
11159 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11160 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11161 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11162 negative response to an AUTH command, including (for example) an attempt to use
11163 an undefined mechanism.
11164
11165 .vitem &$av_failed$&
11166 .cindex "content scanning" "AV scanner failure"
11167 This variable is available when Exim is compiled with the content-scanning
11168 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11169 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11170 the ACL malware condition.
11171
11172 .vitem &$body_linecount$&
11173 .cindex "message body" "line count"
11174 .cindex "body of message" "line count"
11175 .vindex "&$body_linecount$&"
11176 When a message is being received or delivered, this variable contains the
11177 number of lines in the message's body. See also &$message_linecount$&.
11178
11179 .vitem &$body_zerocount$&
11180 .cindex "message body" "binary zero count"
11181 .cindex "body of message" "binary zero count"
11182 .cindex "binary zero" "in message body"
11183 .vindex "&$body_zerocount$&"
11184 When a message is being received or delivered, this variable contains the
11185 number of binary zero bytes (ASCII NULs) in the message's body.
11186
11187 .vitem &$bounce_recipient$&
11188 .vindex "&$bounce_recipient$&"
11189 This is set to the recipient address of a bounce message while Exim is creating
11190 it. It is useful if a customized bounce message text file is in use (see
11191 chapter &<<CHAPemsgcust>>&).
11192
11193 .vitem &$bounce_return_size_limit$&
11194 .vindex "&$bounce_return_size_limit$&"
11195 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11196 up to a multiple of 1000. It is useful when a customized error message text
11197 file is in use (see chapter &<<CHAPemsgcust>>&).
11198
11199 .vitem &$caller_gid$&
11200 .cindex "gid (group id)" "caller"
11201 .vindex "&$caller_gid$&"
11202 The real group id under which the process that called Exim was running. This is
11203 not the same as the group id of the originator of a message (see
11204 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11205 incarnation normally contains the Exim gid.
11206
11207 .vitem &$caller_uid$&
11208 .cindex "uid (user id)" "caller"
11209 .vindex "&$caller_uid$&"
11210 The real user id under which the process that called Exim was running. This is
11211 not the same as the user id of the originator of a message (see
11212 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11213 incarnation normally contains the Exim uid.
11214
11215 .vitem &$compile_date$&
11216 .vindex "&$compile_date$&"
11217 The date on which the Exim binary was compiled.
11218
11219 .vitem &$compile_number$&
11220 .vindex "&$compile_number$&"
11221 The building process for Exim keeps a count of the number
11222 of times it has been compiled. This serves to distinguish different
11223 compilations of the same version of the program.
11224
11225 .vitem &$demime_errorlevel$&
11226 .vindex "&$demime_errorlevel$&"
11227 This variable is available when Exim is compiled with
11228 the content-scanning extension and the obsolete &%demime%& condition. For
11229 details, see section &<<SECTdemimecond>>&.
11230
11231 .vitem &$demime_reason$&
11232 .vindex "&$demime_reason$&"
11233 This variable is available when Exim is compiled with the
11234 content-scanning extension and the obsolete &%demime%& condition. For details,
11235 see section &<<SECTdemimecond>>&.
11236
11237 .vitem &$dnslist_domain$& &&&
11238        &$dnslist_matched$& &&&
11239        &$dnslist_text$& &&&
11240        &$dnslist_value$&
11241 .vindex "&$dnslist_domain$&"
11242 .vindex "&$dnslist_matched$&"
11243 .vindex "&$dnslist_text$&"
11244 .vindex "&$dnslist_value$&"
11245 .cindex "black list (DNS)"
11246 When a DNS (black) list lookup succeeds, these variables are set to contain
11247 the following data from the lookup: the list's domain name, the key that was
11248 looked up, the contents of any associated TXT record, and the value from the
11249 main A record. See section &<<SECID204>>& for more details.
11250
11251 .vitem &$domain$&
11252 .vindex "&$domain$&"
11253 When an address is being routed, or delivered on its own, this variable
11254 contains the domain. Uppercase letters in the domain are converted into lower
11255 case for &$domain$&.
11256
11257 Global address rewriting happens when a message is received, so the value of
11258 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11259 is set during user filtering, but not during system filtering, because a
11260 message may have many recipients and the system filter is called just once.
11261
11262 When more than one address is being delivered at once (for example, several
11263 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11264 have the same domain. Transports can be restricted to handling only one domain
11265 at a time if the value of &$domain$& is required at transport time &-- this is
11266 the default for local transports. For further details of the environment in
11267 which local transports are run, see chapter &<<CHAPenvironment>>&.
11268
11269 .oindex "&%delay_warning_condition%&"
11270 At the end of a delivery, if all deferred addresses have the same domain, it is
11271 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11272
11273 The &$domain$& variable is also used in some other circumstances:
11274
11275 .ilist
11276 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11277 the recipient address. The domain of the &'sender'& address is in
11278 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11279 normally set during the running of the MAIL ACL. However, if the sender address
11280 is verified with a callout during the MAIL ACL, the sender domain is placed in
11281 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11282 the &(smtp)& transport.
11283
11284 .next
11285 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11286 &$domain$& contains the domain portion of the address that is being rewritten;
11287 it can be used in the expansion of the replacement address, for example, to
11288 rewrite domains by file lookup.
11289
11290 .next
11291 With one important exception, whenever a domain list is being scanned,
11292 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11293 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11294 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11295 that, in a RCPT ACL, the sender domain list can be dependent on the
11296 recipient domain (which is what is in &$domain$& at this time).
11297
11298 .next
11299 .cindex "ETRN" "value of &$domain$&"
11300 .oindex "&%smtp_etrn_command%&"
11301 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11302 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11303 .endlist
11304
11305
11306 .vitem &$domain_data$&
11307 .vindex "&$domain_data$&"
11308 When the &%domains%& option on a router matches a domain by
11309 means of a lookup, the data read by the lookup is available during the running
11310 of the router as &$domain_data$&. In addition, if the driver routes the
11311 address to a transport, the value is available in that transport. If the
11312 transport is handling multiple addresses, the value from the first address is
11313 used.
11314
11315 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11316 domain by means of a lookup. The data read by the lookup is available during
11317 the rest of the ACL statement. In all other situations, this variable expands
11318 to nothing.
11319
11320 .vitem &$exim_gid$&
11321 .vindex "&$exim_gid$&"
11322 This variable contains the numerical value of the Exim group id.
11323
11324 .vitem &$exim_path$&
11325 .vindex "&$exim_path$&"
11326 This variable contains the path to the Exim binary.
11327
11328 .vitem &$exim_uid$&
11329 .vindex "&$exim_uid$&"
11330 This variable contains the numerical value of the Exim user id.
11331
11332 .vitem &$found_extension$&
11333 .vindex "&$found_extension$&"
11334 This variable is available when Exim is compiled with the
11335 content-scanning extension and the obsolete &%demime%& condition. For details,
11336 see section &<<SECTdemimecond>>&.
11337
11338 .vitem &$header_$&<&'name'&>
11339 This is not strictly an expansion variable. It is expansion syntax for
11340 inserting the message header line with the given name. Note that the name must
11341 be terminated by colon or white space, because it may contain a wide variety of
11342 characters. Note also that braces must &'not'& be used.
11343
11344 .vitem &$headers_added$&
11345 .vindex "&$headers_added$&"
11346 Within an ACL this variable contains the headers added so far by
11347 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11348 The headers are a newline-separated list.
11349
11350 .vitem &$home$&
11351 .vindex "&$home$&"
11352 When the &%check_local_user%& option is set for a router, the user's home
11353 directory is placed in &$home$& when the check succeeds. In particular, this
11354 means it is set during the running of users' filter files. A router may also
11355 explicitly set a home directory for use by a transport; this can be overridden
11356 by a setting on the transport itself.
11357
11358 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11359 of the environment variable HOME.
11360
11361 .vitem &$host$&
11362 .vindex "&$host$&"
11363 If a router assigns an address to a transport (any transport), and passes a
11364 list of hosts with the address, the value of &$host$& when the transport starts
11365 to run is the name of the first host on the list. Note that this applies both
11366 to local and remote transports.
11367
11368 .cindex "transport" "filter"
11369 .cindex "filter" "transport filter"
11370 For the &(smtp)& transport, if there is more than one host, the value of
11371 &$host$& changes as the transport works its way through the list. In
11372 particular, when the &(smtp)& transport is expanding its options for encryption
11373 using TLS, or for specifying a transport filter (see chapter
11374 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11375 is connected.
11376
11377 When used in the client part of an authenticator configuration (see chapter
11378 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11379 client is connected.
11380
11381
11382 .vitem &$host_address$&
11383 .vindex "&$host_address$&"
11384 This variable is set to the remote host's IP address whenever &$host$& is set
11385 for a remote connection. It is also set to the IP address that is being checked
11386 when the &%ignore_target_hosts%& option is being processed.
11387
11388 .vitem &$host_data$&
11389 .vindex "&$host_data$&"
11390 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11391 result of the lookup is made available in the &$host_data$& variable. This
11392 allows you, for example, to do things like this:
11393 .code
11394 deny  hosts = net-lsearch;/some/file
11395 message = $host_data
11396 .endd
11397 .vitem &$host_lookup_deferred$&
11398 .cindex "host name" "lookup, failure of"
11399 .vindex "&$host_lookup_deferred$&"
11400 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11401 message comes from a remote host and there is an attempt to look up the host's
11402 name from its IP address, and the attempt is not successful, one of these
11403 variables is set to &"1"&.
11404
11405 .ilist
11406 If the lookup receives a definite negative response (for example, a DNS lookup
11407 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11408
11409 .next
11410 If there is any kind of problem during the lookup, such that Exim cannot
11411 tell whether or not the host name is defined (for example, a timeout for a DNS
11412 lookup), &$host_lookup_deferred$& is set to &"1"&.
11413 .endlist ilist
11414
11415 Looking up a host's name from its IP address consists of more than just a
11416 single reverse lookup. Exim checks that a forward lookup of at least one of the
11417 names it receives from a reverse lookup yields the original IP address. If this
11418 is not the case, Exim does not accept the looked up name(s), and
11419 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11420 IP address (for example, the existence of a PTR record in the DNS) is not
11421 sufficient on its own for the success of a host name lookup. If the reverse
11422 lookup succeeds, but there is a lookup problem such as a timeout when checking
11423 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11424 &"1"&. See also &$sender_host_name$&.
11425
11426 .vitem &$host_lookup_failed$&
11427 .vindex "&$host_lookup_failed$&"
11428 See &$host_lookup_deferred$&.
11429
11430 .vitem &$host_port$&
11431 .vindex "&$host_port$&"
11432 This variable is set to the remote host's TCP port whenever &$host$& is set
11433 for an outbound connection.
11434
11435
11436 .vitem &$inode$&
11437 .vindex "&$inode$&"
11438 The only time this variable is set is while expanding the &%directory_file%&
11439 option in the &(appendfile)& transport. The variable contains the inode number
11440 of the temporary file which is about to be renamed. It can be used to construct
11441 a unique name for the file.
11442
11443 .vitem &$interface_address$&
11444 .vindex "&$interface_address$&"
11445 This is an obsolete name for &$received_ip_address$&.
11446
11447 .vitem &$interface_port$&
11448 .vindex "&$interface_port$&"
11449 This is an obsolete name for &$received_port$&.
11450
11451 .vitem &$item$&
11452 .vindex "&$item$&"
11453 This variable is used during the expansion of &*forall*& and &*forany*&
11454 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11455 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11456 empty.
11457
11458 .vitem &$ldap_dn$&
11459 .vindex "&$ldap_dn$&"
11460 This variable, which is available only when Exim is compiled with LDAP support,
11461 contains the DN from the last entry in the most recently successful LDAP
11462 lookup.
11463
11464 .vitem &$load_average$&
11465 .vindex "&$load_average$&"
11466 This variable contains the system load average, multiplied by 1000 so that it
11467 is an integer. For example, if the load average is 0.21, the value of the
11468 variable is 210. The value is recomputed every time the variable is referenced.
11469
11470 .vitem &$local_part$&
11471 .vindex "&$local_part$&"
11472 When an address is being routed, or delivered on its own, this
11473 variable contains the local part. When a number of addresses are being
11474 delivered together (for example, multiple RCPT commands in an SMTP
11475 session), &$local_part$& is not set.
11476
11477 Global address rewriting happens when a message is received, so the value of
11478 &$local_part$& during routing and delivery is the value after rewriting.
11479 &$local_part$& is set during user filtering, but not during system filtering,
11480 because a message may have many recipients and the system filter is called just
11481 once.
11482
11483 .vindex "&$local_part_prefix$&"
11484 .vindex "&$local_part_suffix$&"
11485 If a local part prefix or suffix has been recognized, it is not included in the
11486 value of &$local_part$& during routing and subsequent delivery. The values of
11487 any prefix or suffix are in &$local_part_prefix$& and
11488 &$local_part_suffix$&, respectively.
11489
11490 When a message is being delivered to a file, pipe, or autoreply transport as a
11491 result of aliasing or forwarding, &$local_part$& is set to the local part of
11492 the parent address, not to the file name or command (see &$address_file$& and
11493 &$address_pipe$&).
11494
11495 When an ACL is running for a RCPT command, &$local_part$& contains the
11496 local part of the recipient address.
11497
11498 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11499 &$local_part$& contains the local part of the address that is being rewritten;
11500 it can be used in the expansion of the replacement address, for example.
11501
11502 In all cases, all quoting is removed from the local part. For example, for both
11503 the addresses
11504 .code
11505 "abc:xyz"@test.example
11506 abc\:xyz@test.example
11507 .endd
11508 the value of &$local_part$& is
11509 .code
11510 abc:xyz
11511 .endd
11512 If you use &$local_part$& to create another address, you should always wrap it
11513 inside a quoting operator. For example, in a &(redirect)& router you could
11514 have:
11515 .code
11516 data = ${quote_local_part:$local_part}@new.domain.example
11517 .endd
11518 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11519 to process local parts in a case-dependent manner in a router, you can set the
11520 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11521
11522 .vitem &$local_part_data$&
11523 .vindex "&$local_part_data$&"
11524 When the &%local_parts%& option on a router matches a local part by means of a
11525 lookup, the data read by the lookup is available during the running of the
11526 router as &$local_part_data$&. In addition, if the driver routes the address
11527 to a transport, the value is available in that transport. If the transport is
11528 handling multiple addresses, the value from the first address is used.
11529
11530 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11531 matches a local part by means of a lookup. The data read by the lookup is
11532 available during the rest of the ACL statement. In all other situations, this
11533 variable expands to nothing.
11534
11535 .vitem &$local_part_prefix$&
11536 .vindex "&$local_part_prefix$&"
11537 When an address is being routed or delivered, and a
11538 specific prefix for the local part was recognized, it is available in this
11539 variable, having been removed from &$local_part$&.
11540
11541 .vitem &$local_part_suffix$&
11542 .vindex "&$local_part_suffix$&"
11543 When an address is being routed or delivered, and a
11544 specific suffix for the local part was recognized, it is available in this
11545 variable, having been removed from &$local_part$&.
11546
11547 .vitem &$local_scan_data$&
11548 .vindex "&$local_scan_data$&"
11549 This variable contains the text returned by the &[local_scan()]& function when
11550 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11551
11552 .vitem &$local_user_gid$&
11553 .vindex "&$local_user_gid$&"
11554 See &$local_user_uid$&.
11555
11556 .vitem &$local_user_uid$&
11557 .vindex "&$local_user_uid$&"
11558 This variable and &$local_user_gid$& are set to the uid and gid after the
11559 &%check_local_user%& router precondition succeeds. This means that their values
11560 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11561 and &%condition%&), for the &%address_data%& expansion, and for any
11562 router-specific expansions. At all other times, the values in these variables
11563 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11564
11565 .vitem &$localhost_number$&
11566 .vindex "&$localhost_number$&"
11567 This contains the expanded value of the
11568 &%localhost_number%& option. The expansion happens after the main options have
11569 been read.
11570
11571 .vitem &$log_inodes$&
11572 .vindex "&$log_inodes$&"
11573 The number of free inodes in the disk partition where Exim's
11574 log files are being written. The value is recalculated whenever the variable is
11575 referenced. If the relevant file system does not have the concept of inodes,
11576 the value of is -1. See also the &%check_log_inodes%& option.
11577
11578 .vitem &$log_space$&
11579 .vindex "&$log_space$&"
11580 The amount of free space (as a number of kilobytes) in the disk
11581 partition where Exim's log files are being written. The value is recalculated
11582 whenever the variable is referenced. If the operating system does not have the
11583 ability to find the amount of free space (only true for experimental systems),
11584 the space value is -1. See also the &%check_log_space%& option.
11585
11586
11587 .vitem &$lookup_dnssec_authenticated$&
11588 .vindex "&$lookup_dnssec_authenticated$&"
11589 This variable is set after a DNS lookup done by
11590 a dnsdb lookup expansion, dnslookup router or smtp transport.
11591 It will be empty if &(DNSSEC)& was not requested,
11592 &"no"& if the result was not labelled as authenticated data
11593 and &"yes"& if it was.
11594
11595 .vitem &$mailstore_basename$&
11596 .vindex "&$mailstore_basename$&"
11597 This variable is set only when doing deliveries in &"mailstore"& format in the
11598 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11599 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11600 contains the basename of the files that are being written, that is, the name
11601 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11602 variable is empty.
11603
11604 .vitem &$malware_name$&
11605 .vindex "&$malware_name$&"
11606 This variable is available when Exim is compiled with the
11607 content-scanning extension. It is set to the name of the virus that was found
11608 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11609
11610 .vitem &$max_received_linelength$&
11611 .vindex "&$max_received_linelength$&"
11612 .cindex "maximum" "line length"
11613 .cindex "line length" "maximum"
11614 This variable contains the number of bytes in the longest line that was
11615 received as part of the message, not counting the line termination
11616 character(s).
11617
11618 .vitem &$message_age$&
11619 .cindex "message" "age of"
11620 .vindex "&$message_age$&"
11621 This variable is set at the start of a delivery attempt to contain the number
11622 of seconds since the message was received. It does not change during a single
11623 delivery attempt.
11624
11625 .vitem &$message_body$&
11626 .cindex "body of message" "expansion variable"
11627 .cindex "message body" "in expansion"
11628 .cindex "binary zero" "in message body"
11629 .vindex "&$message_body$&"
11630 .oindex "&%message_body_visible%&"
11631 This variable contains the initial portion of a message's body while it is
11632 being delivered, and is intended mainly for use in filter files. The maximum
11633 number of characters of the body that are put into the variable is set by the
11634 &%message_body_visible%& configuration option; the default is 500.
11635
11636 .oindex "&%message_body_newlines%&"
11637 By default, newlines are converted into spaces in &$message_body$&, to make it
11638 easier to search for phrases that might be split over a line break. However,
11639 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11640 zeros are always converted into spaces.
11641
11642 .vitem &$message_body_end$&
11643 .cindex "body of message" "expansion variable"
11644 .cindex "message body" "in expansion"
11645 .vindex "&$message_body_end$&"
11646 This variable contains the final portion of a message's
11647 body while it is being delivered. The format and maximum size are as for
11648 &$message_body$&.
11649
11650 .vitem &$message_body_size$&
11651 .cindex "body of message" "size"
11652 .cindex "message body" "size"
11653 .vindex "&$message_body_size$&"
11654 When a message is being delivered, this variable contains the size of the body
11655 in bytes. The count starts from the character after the blank line that
11656 separates the body from the header. Newlines are included in the count. See
11657 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11658
11659 .vitem &$message_exim_id$&
11660 .vindex "&$message_exim_id$&"
11661 When a message is being received or delivered, this variable contains the
11662 unique message id that is generated and used by Exim to identify the message.
11663 An id is not created for a message until after its header has been successfully
11664 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11665 line; it is the local id that Exim assigns to the message, for example:
11666 &`1BXTIK-0001yO-VA`&.
11667
11668 .vitem &$message_headers$&
11669 .vindex &$message_headers$&
11670 This variable contains a concatenation of all the header lines when a message
11671 is being processed, except for lines added by routers or transports. The header
11672 lines are separated by newline characters. Their contents are decoded in the
11673 same way as a header line that is inserted by &%bheader%&.
11674
11675 .vitem &$message_headers_raw$&
11676 .vindex &$message_headers_raw$&
11677 This variable is like &$message_headers$& except that no processing of the
11678 contents of header lines is done.
11679
11680 .vitem &$message_id$&
11681 This is an old name for &$message_exim_id$&. It is now deprecated.
11682
11683 .vitem &$message_linecount$&
11684 .vindex "&$message_linecount$&"
11685 This variable contains the total number of lines in the header and body of the
11686 message. Compare &$body_linecount$&, which is the count for the body only.
11687 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11688 number of lines received. Before delivery happens (that is, before filters,
11689 routers, and transports run) the count is increased to include the
11690 &'Received:'& header line that Exim standardly adds, and also any other header
11691 lines that are added by ACLs. The blank line that separates the message header
11692 from the body is not counted.
11693
11694 As with the special case of &$message_size$&, during the expansion of the
11695 appendfile transport's maildir_tag option in maildir format, the value of
11696 &$message_linecount$& is the precise size of the number of newlines in the
11697 file that has been written (minus one for the blank line between the
11698 header and the body).
11699
11700 Here is an example of the use of this variable in a DATA ACL:
11701 .code
11702 deny message   = Too many lines in message header
11703      condition = \
11704       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11705 .endd
11706 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11707 message has not yet been received.
11708
11709 .vitem &$message_size$&
11710 .cindex "size" "of message"
11711 .cindex "message" "size"
11712 .vindex "&$message_size$&"
11713 When a message is being processed, this variable contains its size in bytes. In
11714 most cases, the size includes those headers that were received with the
11715 message, but not those (such as &'Envelope-to:'&) that are added to individual
11716 deliveries as they are written. However, there is one special case: during the
11717 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11718 doing a delivery in maildir format, the value of &$message_size$& is the
11719 precise size of the file that has been written. See also
11720 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11721
11722 .cindex "RCPT" "value of &$message_size$&"
11723 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11724 contains the size supplied on the MAIL command, or -1 if no size was given. The
11725 value may not, of course, be truthful.
11726
11727 .vitem &$mime_$&&'xxx'&
11728 A number of variables whose names start with &$mime$& are
11729 available when Exim is compiled with the content-scanning extension. For
11730 details, see section &<<SECTscanmimepart>>&.
11731
11732 .vitem "&$n0$& &-- &$n9$&"
11733 These variables are counters that can be incremented by means
11734 of the &%add%& command in filter files.
11735
11736 .vitem &$original_domain$&
11737 .vindex "&$domain$&"
11738 .vindex "&$original_domain$&"
11739 When a top-level address is being processed for delivery, this contains the
11740 same value as &$domain$&. However, if a &"child"& address (for example,
11741 generated by an alias, forward, or filter file) is being processed, this
11742 variable contains the domain of the original address (lower cased). This
11743 differs from &$parent_domain$& only when there is more than one level of
11744 aliasing or forwarding. When more than one address is being delivered in a
11745 single transport run, &$original_domain$& is not set.
11746
11747 If a new address is created by means of a &%deliver%& command in a system
11748 filter, it is set up with an artificial &"parent"& address. This has the local
11749 part &'system-filter'& and the default qualify domain.
11750
11751 .vitem &$original_local_part$&
11752 .vindex "&$local_part$&"
11753 .vindex "&$original_local_part$&"
11754 When a top-level address is being processed for delivery, this contains the
11755 same value as &$local_part$&, unless a prefix or suffix was removed from the
11756 local part, because &$original_local_part$& always contains the full local
11757 part. When a &"child"& address (for example, generated by an alias, forward, or
11758 filter file) is being processed, this variable contains the full local part of
11759 the original address.
11760
11761 If the router that did the redirection processed the local part
11762 case-insensitively, the value in &$original_local_part$& is in lower case.
11763 This variable differs from &$parent_local_part$& only when there is more than
11764 one level of aliasing or forwarding. When more than one address is being
11765 delivered in a single transport run, &$original_local_part$& is not set.
11766
11767 If a new address is created by means of a &%deliver%& command in a system
11768 filter, it is set up with an artificial &"parent"& address. This has the local
11769 part &'system-filter'& and the default qualify domain.
11770
11771 .vitem &$originator_gid$&
11772 .cindex "gid (group id)" "of originating user"
11773 .cindex "sender" "gid"
11774 .vindex "&$caller_gid$&"
11775 .vindex "&$originator_gid$&"
11776 This variable contains the value of &$caller_gid$& that was set when the
11777 message was received. For messages received via the command line, this is the
11778 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11779 normally the gid of the Exim user.
11780
11781 .vitem &$originator_uid$&
11782 .cindex "uid (user id)" "of originating user"
11783 .cindex "sender" "uid"
11784 .vindex "&$caller_uid$&"
11785 .vindex "&$originaltor_uid$&"
11786 The value of &$caller_uid$& that was set when the message was received. For
11787 messages received via the command line, this is the uid of the sending user.
11788 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11789 user.
11790
11791 .vitem &$parent_domain$&
11792 .vindex "&$parent_domain$&"
11793 This variable is similar to &$original_domain$& (see
11794 above), except that it refers to the immediately preceding parent address.
11795
11796 .vitem &$parent_local_part$&
11797 .vindex "&$parent_local_part$&"
11798 This variable is similar to &$original_local_part$&
11799 (see above), except that it refers to the immediately preceding parent address.
11800
11801 .vitem &$pid$&
11802 .cindex "pid (process id)" "of current process"
11803 .vindex "&$pid$&"
11804 This variable contains the current process id.
11805
11806 .vitem &$pipe_addresses$&
11807 .cindex "filter" "transport filter"
11808 .cindex "transport" "filter"
11809 .vindex "&$pipe_addresses$&"
11810 This is not an expansion variable, but is mentioned here because the string
11811 &`$pipe_addresses`& is handled specially in the command specification for the
11812 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11813 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11814 It cannot be used in general expansion strings, and provokes an &"unknown
11815 variable"& error if encountered.
11816
11817 .vitem &$primary_hostname$&
11818 .vindex "&$primary_hostname$&"
11819 This variable contains the value set by &%primary_hostname%& in the
11820 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11821 a single-component name, Exim calls &[gethostbyname()]& (or
11822 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11823 qualified host name. See also &$smtp_active_hostname$&.
11824
11825
11826 .vitem &$prvscheck_address$&
11827 This variable is used in conjunction with the &%prvscheck%& expansion item,
11828 which is described in sections &<<SECTexpansionitems>>& and
11829 &<<SECTverifyPRVS>>&.
11830
11831 .vitem &$prvscheck_keynum$&
11832 This variable is used in conjunction with the &%prvscheck%& expansion item,
11833 which is described in sections &<<SECTexpansionitems>>& and
11834 &<<SECTverifyPRVS>>&.
11835
11836 .vitem &$prvscheck_result$&
11837 This variable is used in conjunction with the &%prvscheck%& expansion item,
11838 which is described in sections &<<SECTexpansionitems>>& and
11839 &<<SECTverifyPRVS>>&.
11840
11841 .vitem &$qualify_domain$&
11842 .vindex "&$qualify_domain$&"
11843 The value set for the &%qualify_domain%& option in the configuration file.
11844
11845 .vitem &$qualify_recipient$&
11846 .vindex "&$qualify_recipient$&"
11847 The value set for the &%qualify_recipient%& option in the configuration file,
11848 or if not set, the value of &$qualify_domain$&.
11849
11850 .vitem &$rcpt_count$&
11851 .vindex "&$rcpt_count$&"
11852 When a message is being received by SMTP, this variable contains the number of
11853 RCPT commands received for the current message. If this variable is used in a
11854 RCPT ACL, its value includes the current command.
11855
11856 .vitem &$rcpt_defer_count$&
11857 .vindex "&$rcpt_defer_count$&"
11858 .cindex "4&'xx'& responses" "count of"
11859 When a message is being received by SMTP, this variable contains the number of
11860 RCPT commands in the current message that have previously been rejected with a
11861 temporary (4&'xx'&) response.
11862
11863 .vitem &$rcpt_fail_count$&
11864 .vindex "&$rcpt_fail_count$&"
11865 When a message is being received by SMTP, this variable contains the number of
11866 RCPT commands in the current message that have previously been rejected with a
11867 permanent (5&'xx'&) response.
11868
11869 .vitem &$received_count$&
11870 .vindex "&$received_count$&"
11871 This variable contains the number of &'Received:'& header lines in the message,
11872 including the one added by Exim (so its value is always greater than zero). It
11873 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11874 delivering.
11875
11876 .vitem &$received_for$&
11877 .vindex "&$received_for$&"
11878 If there is only a single recipient address in an incoming message, this
11879 variable contains that address when the &'Received:'& header line is being
11880 built. The value is copied after recipient rewriting has happened, but before
11881 the &[local_scan()]& function is run.
11882
11883 .vitem &$received_ip_address$&
11884 .vindex "&$received_ip_address$&"
11885 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11886 variable is set to the address of the local IP interface, and &$received_port$&
11887 is set to the local port number. (The remote IP address and port are in
11888 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11889 the port value is -1 unless it has been set using the &%-oMi%& command line
11890 option.
11891
11892 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11893 could be used, for example, to make the file name for a TLS certificate depend
11894 on which interface and/or port is being used for the incoming connection. The
11895 values of &$received_ip_address$& and &$received_port$& are saved with any
11896 messages that are received, thus making these variables available at delivery
11897 time.
11898
11899 &*Note:*& There are no equivalent variables for outgoing connections, because
11900 the values are unknown (unless they are explicitly set by options of the
11901 &(smtp)& transport).
11902
11903 .vitem &$received_port$&
11904 .vindex "&$received_port$&"
11905 See &$received_ip_address$&.
11906
11907 .vitem &$received_protocol$&
11908 .vindex "&$received_protocol$&"
11909 When a message is being processed, this variable contains the name of the
11910 protocol by which it was received. Most of the names used by Exim are defined
11911 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11912 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11913 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11914 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11915 connection and the client was successfully authenticated.
11916
11917 Exim uses the protocol name &"smtps"& for the case when encryption is
11918 automatically set up on connection without the use of STARTTLS (see
11919 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11920 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11921 where the client initially uses EHLO, sets up an encrypted connection using
11922 STARTTLS, and then uses HELO afterwards.
11923
11924 The &%-oMr%& option provides a way of specifying a custom protocol name for
11925 messages that are injected locally by trusted callers. This is commonly used to
11926 identify messages that are being re-injected after some kind of scanning.
11927
11928 .vitem &$received_time$&
11929 .vindex "&$received_time$&"
11930 This variable contains the date and time when the current message was received,
11931 as a number of seconds since the start of the Unix epoch.
11932
11933 .vitem &$recipient_data$&
11934 .vindex "&$recipient_data$&"
11935 This variable is set after an indexing lookup success in an ACL &%recipients%&
11936 condition. It contains the data from the lookup, and the value remains set
11937 until the next &%recipients%& test. Thus, you can do things like this:
11938 .display
11939 &`require recipients  = cdb*@;/some/file`&
11940 &`deny    `&&'some further test involving'& &`$recipient_data`&
11941 .endd
11942 &*Warning*&: This variable is set only when a lookup is used as an indexing
11943 method in the address list, using the semicolon syntax as in the example above.
11944 The variable is not set for a lookup that is used as part of the string
11945 expansion that all such lists undergo before being interpreted.
11946
11947 .vitem &$recipient_verify_failure$&
11948 .vindex "&$recipient_verify_failure$&"
11949 In an ACL, when a recipient verification fails, this variable contains
11950 information about the failure. It is set to one of the following words:
11951
11952 .ilist
11953 &"qualify"&: The address was unqualified (no domain), and the message
11954 was neither local nor came from an exempted host.
11955
11956 .next
11957 &"route"&: Routing failed.
11958
11959 .next
11960 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11961 or before the MAIL command (that is, on initial connection, HELO, or
11962 MAIL).
11963
11964 .next
11965 &"recipient"&: The RCPT command in a callout was rejected.
11966 .next
11967
11968 &"postmaster"&: The postmaster check in a callout was rejected.
11969 .endlist
11970
11971 The main use of this variable is expected to be to distinguish between
11972 rejections of MAIL and rejections of RCPT.
11973
11974 .vitem &$recipients$&
11975 .vindex "&$recipients$&"
11976 This variable contains a list of envelope recipients for a message. A comma and
11977 a space separate the addresses in the replacement text. However, the variable
11978 is not generally available, to prevent exposure of Bcc recipients in
11979 unprivileged users' filter files. You can use &$recipients$& only in these
11980 cases:
11981
11982 .olist
11983 In a system filter file.
11984 .next
11985 In the ACLs associated with the DATA command and with non-SMTP messages, that
11986 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11987 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11988 &%acl_not_smtp_mime%&.
11989 .next
11990 From within a &[local_scan()]& function.
11991 .endlist
11992
11993
11994 .vitem &$recipients_count$&
11995 .vindex "&$recipients_count$&"
11996 When a message is being processed, this variable contains the number of
11997 envelope recipients that came with the message. Duplicates are not excluded
11998 from the count. While a message is being received over SMTP, the number
11999 increases for each accepted recipient. It can be referenced in an ACL.
12000
12001
12002 .vitem &$regex_match_string$&
12003 .vindex "&$regex_match_string$&"
12004 This variable is set to contain the matching regular expression after a
12005 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12006
12007
12008 .vitem &$reply_address$&
12009 .vindex "&$reply_address$&"
12010 When a message is being processed, this variable contains the contents of the
12011 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12012 contents of the &'From:'& header line. Apart from the removal of leading
12013 white space, the value is not processed in any way. In particular, no RFC 2047
12014 decoding or character code translation takes place.
12015
12016 .vitem &$return_path$&
12017 .vindex "&$return_path$&"
12018 When a message is being delivered, this variable contains the return path &--
12019 the sender field that will be sent as part of the envelope. It is not enclosed
12020 in <> characters. At the start of routing an address, &$return_path$& has the
12021 same value as &$sender_address$&, but if, for example, an incoming message to a
12022 mailing list has been expanded by a router which specifies a different address
12023 for bounce messages, &$return_path$& subsequently contains the new bounce
12024 address, whereas &$sender_address$& always contains the original sender address
12025 that was received with the message. In other words, &$sender_address$& contains
12026 the incoming envelope sender, and &$return_path$& contains the outgoing
12027 envelope sender.
12028
12029 .vitem &$return_size_limit$&
12030 .vindex "&$return_size_limit$&"
12031 This is an obsolete name for &$bounce_return_size_limit$&.
12032
12033 .vitem &$router_name$&
12034 .cindex "router" "name"
12035 .cindex "name" "of router"
12036 .vindex "&$router_name$&"
12037 During the running of a router this variable contains its name.
12038
12039 .vitem &$runrc$&
12040 .cindex "return code" "from &%run%& expansion"
12041 .vindex "&$runrc$&"
12042 This variable contains the return code from a command that is run by the
12043 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12044 assume the order in which option values are expanded, except for those
12045 preconditions whose order of testing is documented. Therefore, you cannot
12046 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12047 another.
12048
12049 .vitem &$self_hostname$&
12050 .oindex "&%self%&" "value of host name"
12051 .vindex "&$self_hostname$&"
12052 When an address is routed to a supposedly remote host that turns out to be the
12053 local host, what happens is controlled by the &%self%& generic router option.
12054 One of its values causes the address to be passed to another router. When this
12055 happens, &$self_hostname$& is set to the name of the local host that the
12056 original router encountered. In other circumstances its contents are null.
12057
12058 .vitem &$sender_address$&
12059 .vindex "&$sender_address$&"
12060 When a message is being processed, this variable contains the sender's address
12061 that was received in the message's envelope. The case of letters in the address
12062 is retained, in both the local part and the domain. For bounce messages, the
12063 value of this variable is the empty string. See also &$return_path$&.
12064
12065 .vitem &$sender_address_data$&
12066 .vindex "&$address_data$&"
12067 .vindex "&$sender_address_data$&"
12068 If &$address_data$& is set when the routers are called from an ACL to verify a
12069 sender address, the final value is preserved in &$sender_address_data$&, to
12070 distinguish it from data from a recipient address. The value does not persist
12071 after the end of the current ACL statement. If you want to preserve it for
12072 longer, you can save it in an ACL variable.
12073
12074 .vitem &$sender_address_domain$&
12075 .vindex "&$sender_address_domain$&"
12076 The domain portion of &$sender_address$&.
12077
12078 .vitem &$sender_address_local_part$&
12079 .vindex "&$sender_address_local_part$&"
12080 The local part portion of &$sender_address$&.
12081
12082 .vitem &$sender_data$&
12083 .vindex "&$sender_data$&"
12084 This variable is set after a lookup success in an ACL &%senders%& condition or
12085 in a router &%senders%& option. It contains the data from the lookup, and the
12086 value remains set until the next &%senders%& test. Thus, you can do things like
12087 this:
12088 .display
12089 &`require senders      = cdb*@;/some/file`&
12090 &`deny    `&&'some further test involving'& &`$sender_data`&
12091 .endd
12092 &*Warning*&: This variable is set only when a lookup is used as an indexing
12093 method in the address list, using the semicolon syntax as in the example above.
12094 The variable is not set for a lookup that is used as part of the string
12095 expansion that all such lists undergo before being interpreted.
12096
12097 .vitem &$sender_fullhost$&
12098 .vindex "&$sender_fullhost$&"
12099 When a message is received from a remote host, this variable contains the host
12100 name and IP address in a single string. It ends with the IP address in square
12101 brackets, followed by a colon and a port number if the logging of ports is
12102 enabled. The format of the rest of the string depends on whether the host
12103 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12104 looking up its IP address. (Looking up the IP address can be forced by the
12105 &%host_lookup%& option, independent of verification.) A plain host name at the
12106 start of the string is a verified host name; if this is not present,
12107 verification either failed or was not requested. A host name in parentheses is
12108 the argument of a HELO or EHLO command. This is omitted if it is identical to
12109 the verified host name or to the host's IP address in square brackets.
12110
12111 .vitem &$sender_helo_name$&
12112 .vindex "&$sender_helo_name$&"
12113 When a message is received from a remote host that has issued a HELO or EHLO
12114 command, the argument of that command is placed in this variable. It is also
12115 set if HELO or EHLO is used when a message is received using SMTP locally via
12116 the &%-bs%& or &%-bS%& options.
12117
12118 .vitem &$sender_host_address$&
12119 .vindex "&$sender_host_address$&"
12120 When a message is received from a remote host, this variable contains that
12121 host's IP address. For locally submitted messages, it is empty.
12122
12123 .vitem &$sender_host_authenticated$&
12124 .vindex "&$sender_host_authenticated$&"
12125 This variable contains the name (not the public name) of the authenticator
12126 driver that successfully authenticated the client from which the message was
12127 received. It is empty if there was no successful authentication. See also
12128 &$authenticated_id$&.
12129
12130 .vitem &$sender_host_dnssec$&
12131 .vindex "&$sender_host_dnssec$&"
12132 If an attempt to populate &$sender_host_name$& has been made
12133 (by reference, &%hosts_lookup%& or
12134 otherwise) then this boolean will have been set true if, and only if, the
12135 resolver library states that the reverse DNS was authenticated data.  At all
12136 other times, this variable is false.
12137
12138 It is likely that you will need to coerce DNSSEC support on in the resolver
12139 library, by setting:
12140 .code
12141 dns_dnssec_ok = 1
12142 .endd
12143
12144 Exim does not perform DNSSEC validation itself, instead leaving that to a
12145 validating resolver (eg, unbound, or bind with suitable configuration).
12146
12147 Exim does not (currently) check to see if the forward DNS was also secured
12148 with DNSSEC, only the reverse DNS.
12149
12150 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12151 mechanism in the list, then this variable will be false.
12152
12153
12154 .vitem &$sender_host_name$&
12155 .vindex "&$sender_host_name$&"
12156 When a message is received from a remote host, this variable contains the
12157 host's name as obtained by looking up its IP address. For messages received by
12158 other means, this variable is empty.
12159
12160 .vindex "&$host_lookup_failed$&"
12161 If the host name has not previously been looked up, a reference to
12162 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12163 A looked up name is accepted only if it leads back to the original IP address
12164 via a forward lookup. If either the reverse or the forward lookup fails to find
12165 any data, or if the forward lookup does not yield the original IP address,
12166 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12167
12168 .vindex "&$host_lookup_deferred$&"
12169 However, if either of the lookups cannot be completed (for example, there is a
12170 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12171 &$host_lookup_failed$& remains set to &"0"&.
12172
12173 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12174 host name again if there is a subsequent reference to &$sender_host_name$&
12175 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12176 is set to &"1"&.
12177
12178 Exim does not automatically look up every calling host's name. If you want
12179 maximum efficiency, you should arrange your configuration so that it avoids
12180 these lookups altogether. The lookup happens only if one or more of the
12181 following are true:
12182
12183 .ilist
12184 A string containing &$sender_host_name$& is expanded.
12185 .next
12186 The calling host matches the list in &%host_lookup%&. In the default
12187 configuration, this option is set to *, so it must be changed if lookups are
12188 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12189 .next
12190 Exim needs the host name in order to test an item in a host list. The items
12191 that require this are described in sections &<<SECThoslispatnam>>& and
12192 &<<SECThoslispatnamsk>>&.
12193 .next
12194 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12195 In this case, the host name is required to compare with the name quoted in any
12196 EHLO or HELO commands that the client issues.
12197 .next
12198 The remote host issues a EHLO or HELO command that quotes one of the
12199 domains in &%helo_lookup_domains%&. The default value of this option is
12200 . ==== As this is a nested list, any displays it contains must be indented
12201 . ==== as otherwise they are too far to the left.
12202 .code
12203   helo_lookup_domains = @ : @[]
12204 .endd
12205 which causes a lookup if a remote host (incorrectly) gives the server's name or
12206 IP address in an EHLO or HELO command.
12207 .endlist
12208
12209
12210 .vitem &$sender_host_port$&
12211 .vindex "&$sender_host_port$&"
12212 When a message is received from a remote host, this variable contains the port
12213 number that was used on the remote host.
12214
12215 .vitem &$sender_ident$&
12216 .vindex "&$sender_ident$&"
12217 When a message is received from a remote host, this variable contains the
12218 identification received in response to an RFC 1413 request. When a message has
12219 been received locally, this variable contains the login name of the user that
12220 called Exim.
12221
12222 .vitem &$sender_rate_$&&'xxx'&
12223 A number of variables whose names begin &$sender_rate_$& are set as part of the
12224 &%ratelimit%& ACL condition. Details are given in section
12225 &<<SECTratelimiting>>&.
12226
12227 .vitem &$sender_rcvhost$&
12228 .cindex "DNS" "reverse lookup"
12229 .cindex "reverse DNS lookup"
12230 .vindex "&$sender_rcvhost$&"
12231 This is provided specifically for use in &'Received:'& headers. It starts with
12232 either the verified host name (as obtained from a reverse DNS lookup) or, if
12233 there is no verified host name, the IP address in square brackets. After that
12234 there may be text in parentheses. When the first item is a verified host name,
12235 the first thing in the parentheses is the IP address in square brackets,
12236 followed by a colon and a port number if port logging is enabled. When the
12237 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12238 the parentheses.
12239
12240 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12241 was used and its argument was not identical to the real host name or IP
12242 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12243 all three items are present in the parentheses, a newline and tab are inserted
12244 into the string, to improve the formatting of the &'Received:'& header.
12245
12246 .vitem &$sender_verify_failure$&
12247 .vindex "&$sender_verify_failure$&"
12248 In an ACL, when a sender verification fails, this variable contains information
12249 about the failure. The details are the same as for
12250 &$recipient_verify_failure$&.
12251
12252 .vitem &$sending_ip_address$&
12253 .vindex "&$sending_ip_address$&"
12254 This variable is set whenever an outgoing SMTP connection to another host has
12255 been set up. It contains the IP address of the local interface that is being
12256 used. This is useful if a host that has more than one IP address wants to take
12257 on different personalities depending on which one is being used. For incoming
12258 connections, see &$received_ip_address$&.
12259
12260 .vitem &$sending_port$&
12261 .vindex "&$sending_port$&"
12262 This variable is set whenever an outgoing SMTP connection to another host has
12263 been set up. It contains the local port that is being used. For incoming
12264 connections, see &$received_port$&.
12265
12266 .vitem &$smtp_active_hostname$&
12267 .vindex "&$smtp_active_hostname$&"
12268 During an incoming SMTP session, this variable contains the value of the active
12269 host name, as specified by the &%smtp_active_hostname%& option. The value of
12270 &$smtp_active_hostname$& is saved with any message that is received, so its
12271 value can be consulted during routing and delivery.
12272
12273 .vitem &$smtp_command$&
12274 .vindex "&$smtp_command$&"
12275 During the processing of an incoming SMTP command, this variable contains the
12276 entire command. This makes it possible to distinguish between HELO and EHLO in
12277 the HELO ACL, and also to distinguish between commands such as these:
12278 .code
12279 MAIL FROM:<>
12280 MAIL FROM: <>
12281 .endd
12282 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12283 command, the address in &$smtp_command$& is the original address before any
12284 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12285 the address after SMTP-time rewriting.
12286
12287 .vitem &$smtp_command_argument$&
12288 .cindex "SMTP" "command, argument for"
12289 .vindex "&$smtp_command_argument$&"
12290 While an ACL is running to check an SMTP command, this variable contains the
12291 argument, that is, the text that follows the command name, with leading white
12292 space removed. Following the introduction of &$smtp_command$&, this variable is
12293 somewhat redundant, but is retained for backwards compatibility.
12294
12295 .vitem &$smtp_count_at_connection_start$&
12296 .vindex "&$smtp_count_at_connection_start$&"
12297 This variable is set greater than zero only in processes spawned by the Exim
12298 daemon for handling incoming SMTP connections. The name is deliberately long,
12299 in order to emphasize what the contents are. When the daemon accepts a new
12300 connection, it increments this variable. A copy of the variable is passed to
12301 the child process that handles the connection, but its value is fixed, and
12302 never changes. It is only an approximation of how many incoming connections
12303 there actually are, because many other connections may come and go while a
12304 single connection is being processed. When a child process terminates, the
12305 daemon decrements its copy of the variable.
12306
12307 .vitem "&$sn0$& &-- &$sn9$&"
12308 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12309 that were current at the end of the system filter file. This allows a system
12310 filter file to set values that can be tested in users' filter files. For
12311 example, a system filter could set a value indicating how likely it is that a
12312 message is junk mail.
12313
12314 .vitem &$spam_$&&'xxx'&
12315 A number of variables whose names start with &$spam$& are available when Exim
12316 is compiled with the content-scanning extension. For details, see section
12317 &<<SECTscanspamass>>&.
12318
12319
12320 .vitem &$spool_directory$&
12321 .vindex "&$spool_directory$&"
12322 The name of Exim's spool directory.
12323
12324 .vitem &$spool_inodes$&
12325 .vindex "&$spool_inodes$&"
12326 The number of free inodes in the disk partition where Exim's spool files are
12327 being written. The value is recalculated whenever the variable is referenced.
12328 If the relevant file system does not have the concept of inodes, the value of
12329 is -1. See also the &%check_spool_inodes%& option.
12330
12331 .vitem &$spool_space$&
12332 .vindex "&$spool_space$&"
12333 The amount of free space (as a number of kilobytes) in the disk partition where
12334 Exim's spool files are being written. The value is recalculated whenever the
12335 variable is referenced. If the operating system does not have the ability to
12336 find the amount of free space (only true for experimental systems), the space
12337 value is -1. For example, to check in an ACL that there is at least 50
12338 megabytes free on the spool, you could write:
12339 .code
12340 condition = ${if > {$spool_space}{50000}}
12341 .endd
12342 See also the &%check_spool_space%& option.
12343
12344
12345 .vitem &$thisaddress$&
12346 .vindex "&$thisaddress$&"
12347 This variable is set only during the processing of the &%foranyaddress%&
12348 command in a filter file. Its use is explained in the description of that
12349 command, which can be found in the separate document entitled &'Exim's
12350 interfaces to mail filtering'&.
12351
12352 .vitem &$tls_in_bits$&
12353 .vindex "&$tls_in_bits$&"
12354 Contains an approximation of the TLS cipher's bit-strength
12355 on the inbound connection; the meaning of
12356 this depends upon the TLS implementation used.
12357 If TLS has not been negotiated, the value will be 0.
12358 The value of this is automatically fed into the Cyrus SASL authenticator
12359 when acting as a server, to specify the "external SSF" (a SASL term).
12360
12361 The deprecated &$tls_bits$& variable refers to the inbound side
12362 except when used in the context of an outbound SMTP delivery, when it refers to
12363 the outbound.
12364
12365 .vitem &$tls_out_bits$&
12366 .vindex "&$tls_out_bits$&"
12367 Contains an approximation of the TLS cipher's bit-strength
12368 on an outbound SMTP connection; the meaning of
12369 this depends upon the TLS implementation used.
12370 If TLS has not been negotiated, the value will be 0.
12371
12372 .vitem &$tls_in_ourcert$&
12373 .vindex "&$tls_in_ourcert$&"
12374 This variable refers to the certificate presented to the peer of an
12375 inbound connection when the message was received.
12376 It is only useful as the argument of a
12377 .new
12378 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12379 .wen
12380 or a &%def%& condition.
12381
12382 .vitem &$tls_in_peercert$&
12383 .vindex "&$tls_in_peercert$&"
12384 This variable refers to the certificate presented by the peer of an
12385 inbound connection when the message was received.
12386 It is only useful as the argument of a
12387 .new
12388 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12389 .wen
12390 or a &%def%& condition.
12391
12392 .vitem &$tls_out_ourcert$&
12393 .vindex "&$tls_out_ourcert$&"
12394 This variable refers to the certificate presented to the peer of an
12395 outbound connection.  It is only useful as the argument of a
12396 .new
12397 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12398 .wen
12399 or a &%def%& condition.
12400
12401 .vitem &$tls_out_peercert$&
12402 .vindex "&$tls_out_peercert$&"
12403 This variable refers to the certificate presented by the peer of an
12404 outbound connection.  It is only useful as the argument of a
12405 .new
12406 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12407 .wen
12408 or a &%def%& condition.
12409
12410 .vitem &$tls_in_certificate_verified$&
12411 .vindex "&$tls_in_certificate_verified$&"
12412 This variable is set to &"1"& if a TLS certificate was verified when the
12413 message was received, and &"0"& otherwise.
12414
12415 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12416 except when used in the context of an outbound SMTP delivery, when it refers to
12417 the outbound.
12418
12419 .vitem &$tls_out_certificate_verified$&
12420 .vindex "&$tls_out_certificate_verified$&"
12421 This variable is set to &"1"& if a TLS certificate was verified when an
12422 outbound SMTP connection was made,
12423 and &"0"& otherwise.
12424
12425 .vitem &$tls_in_cipher$&
12426 .vindex "&$tls_in_cipher$&"
12427 .vindex "&$tls_cipher$&"
12428 When a message is received from a remote host over an encrypted SMTP
12429 connection, this variable is set to the cipher suite that was negotiated, for
12430 example DES-CBC3-SHA. In other circumstances, in particular, for message
12431 received over unencrypted connections, the variable is empty. Testing
12432 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12433 non-encrypted connections during ACL processing.
12434
12435 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12436 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12437 becomes the same as &$tls_out_cipher$&.
12438
12439 .vitem &$tls_out_cipher$&
12440 .vindex "&$tls_out_cipher$&"
12441 This variable is
12442 cleared before any outgoing SMTP connection is made,
12443 and then set to the outgoing cipher suite if one is negotiated. See chapter
12444 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12445 details of the &(smtp)& transport.
12446
12447 .vitem &$tls_in_ocsp$&
12448 .vindex "&$tls_in_ocsp$&"
12449 When a message is received from a remote client connection
12450 the result of any OCSP request from the client is encoded in this variable:
12451 .code
12452 0 OCSP proof was not requested (default value)
12453 1 No response to request
12454 2 Response not verified
12455 3 Verification failed
12456 4 Verification succeeded
12457 .endd
12458
12459 .vitem &$tls_out_ocsp$&
12460 .vindex "&$tls_out_ocsp$&"
12461 When a message is sent to a remote host connection
12462 the result of any OCSP request made is encoded in this variable.
12463 See &$tls_in_ocsp$& for values.
12464
12465 .vitem &$tls_in_peerdn$&
12466 .vindex "&$tls_in_peerdn$&"
12467 .vindex "&$tls_peerdn$&"
12468 When a message is received from a remote host over an encrypted SMTP
12469 connection, and Exim is configured to request a certificate from the client,
12470 the value of the Distinguished Name of the certificate is made available in the
12471 &$tls_in_peerdn$& during subsequent processing.
12472
12473 The deprecated &$tls_peerdn$& variable refers to the inbound side
12474 except when used in the context of an outbound SMTP delivery, when it refers to
12475 the outbound.
12476
12477 .vitem &$tls_out_peerdn$&
12478 .vindex "&$tls_out_peerdn$&"
12479 When a message is being delivered to a remote host over an encrypted SMTP
12480 connection, and Exim is configured to request a certificate from the server,
12481 the value of the Distinguished Name of the certificate is made available in the
12482 &$tls_out_peerdn$& during subsequent processing.
12483
12484 .vitem &$tls_in_sni$&
12485 .vindex "&$tls_in_sni$&"
12486 .vindex "&$tls_sni$&"
12487 .cindex "TLS" "Server Name Indication"
12488 When a TLS session is being established, if the client sends the Server
12489 Name Indication extension, the value will be placed in this variable.
12490 If the variable appears in &%tls_certificate%& then this option and
12491 some others, described in &<<SECTtlssni>>&,
12492 will be re-expanded early in the TLS session, to permit
12493 a different certificate to be presented (and optionally a different key to be
12494 used) to the client, based upon the value of the SNI extension.
12495
12496 The deprecated &$tls_sni$& variable refers to the inbound side
12497 except when used in the context of an outbound SMTP delivery, when it refers to
12498 the outbound.
12499
12500 .vitem &$tls_out_sni$&
12501 .vindex "&$tls_out_sni$&"
12502 .cindex "TLS" "Server Name Indication"
12503 During outbound
12504 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12505 the transport.
12506
12507 .vitem &$tod_bsdinbox$&
12508 .vindex "&$tod_bsdinbox$&"
12509 The time of day and the date, in the format required for BSD-style mailbox
12510 files, for example: Thu Oct 17 17:14:09 1995.
12511
12512 .vitem &$tod_epoch$&
12513 .vindex "&$tod_epoch$&"
12514 The time and date as a number of seconds since the start of the Unix epoch.
12515
12516 .vitem &$tod_epoch_l$&
12517 .vindex "&$tod_epoch_l$&"
12518 The time and date as a number of microseconds since the start of the Unix epoch.
12519
12520 .vitem &$tod_full$&
12521 .vindex "&$tod_full$&"
12522 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12523 +0100. The timezone is always given as a numerical offset from UTC, with
12524 positive values used for timezones that are ahead (east) of UTC, and negative
12525 values for those that are behind (west).
12526
12527 .vitem &$tod_log$&
12528 .vindex "&$tod_log$&"
12529 The time and date in the format used for writing Exim's log files, for example:
12530 1995-10-12 15:32:29, but without a timezone.
12531
12532 .vitem &$tod_logfile$&
12533 .vindex "&$tod_logfile$&"
12534 This variable contains the date in the format yyyymmdd. This is the format that
12535 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12536 flag.
12537
12538 .vitem &$tod_zone$&
12539 .vindex "&$tod_zone$&"
12540 This variable contains the numerical value of the local timezone, for example:
12541 -0500.
12542
12543 .vitem &$tod_zulu$&
12544 .vindex "&$tod_zulu$&"
12545 This variable contains the UTC date and time in &"Zulu"& format, as specified
12546 by ISO 8601, for example: 20030221154023Z.
12547
12548 .vitem &$transport_name$&
12549 .cindex "transport" "name"
12550 .cindex "name" "of transport"
12551 .vindex "&$transport_name$&"
12552 During the running of a transport, this variable contains its name.
12553
12554 .vitem &$value$&
12555 .vindex "&$value$&"
12556 This variable contains the result of an expansion lookup, extraction operation,
12557 or external command, as described above. It is also used during a
12558 &*reduce*& expansion.
12559
12560 .vitem &$version_number$&
12561 .vindex "&$version_number$&"
12562 The version number of Exim.
12563
12564 .vitem &$warn_message_delay$&
12565 .vindex "&$warn_message_delay$&"
12566 This variable is set only during the creation of a message warning about a
12567 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12568
12569 .vitem &$warn_message_recipients$&
12570 .vindex "&$warn_message_recipients$&"
12571 This variable is set only during the creation of a message warning about a
12572 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12573 .endlist
12574 .ecindex IIDstrexp
12575
12576
12577
12578 . ////////////////////////////////////////////////////////////////////////////
12579 . ////////////////////////////////////////////////////////////////////////////
12580
12581 .chapter "Embedded Perl" "CHAPperl"
12582 .scindex IIDperl "Perl" "calling from Exim"
12583 Exim can be built to include an embedded Perl interpreter. When this is done,
12584 Perl subroutines can be called as part of the string expansion process. To make
12585 use of the Perl support, you need version 5.004 or later of Perl installed on
12586 your system. To include the embedded interpreter in the Exim binary, include
12587 the line
12588 .code
12589 EXIM_PERL = perl.o
12590 .endd
12591 in your &_Local/Makefile_& and then build Exim in the normal way.
12592
12593
12594 .section "Setting up so Perl can be used" "SECID85"
12595 .oindex "&%perl_startup%&"
12596 Access to Perl subroutines is via a global configuration option called
12597 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12598 no &%perl_startup%& option in the Exim configuration file then no Perl
12599 interpreter is started and there is almost no overhead for Exim (since none of
12600 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12601 option then the associated value is taken to be Perl code which is executed in
12602 a newly created Perl interpreter.
12603
12604 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12605 need backslashes before any characters to escape special meanings. The option
12606 should usually be something like
12607 .code
12608 perl_startup = do '/etc/exim.pl'
12609 .endd
12610 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12611 use from Exim. Exim can be configured either to start up a Perl interpreter as
12612 soon as it is entered, or to wait until the first time it is needed. Starting
12613 the interpreter at the beginning ensures that it is done while Exim still has
12614 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12615 fact used in a particular run. Also, note that this does not mean that Exim is
12616 necessarily running as root when Perl is called at a later time. By default,
12617 the interpreter is started only when it is needed, but this can be changed in
12618 two ways:
12619
12620 .ilist
12621 .oindex "&%perl_at_start%&"
12622 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12623 a startup when Exim is entered.
12624 .next
12625 The command line option &%-ps%& also requests a startup when Exim is entered,
12626 overriding the setting of &%perl_at_start%&.
12627 .endlist
12628
12629 There is also a command line option &%-pd%& (for delay) which suppresses the
12630 initial startup, even if &%perl_at_start%& is set.
12631
12632
12633 .section "Calling Perl subroutines" "SECID86"
12634 When the configuration file includes a &%perl_startup%& option you can make use
12635 of the string expansion item to call the Perl subroutines that are defined
12636 by the &%perl_startup%& code. The operator is used in any of the following
12637 forms:
12638 .code
12639 ${perl{foo}}
12640 ${perl{foo}{argument}}
12641 ${perl{foo}{argument1}{argument2} ... }
12642 .endd
12643 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12644 arguments may be passed. Passing more than this results in an expansion failure
12645 with an error message of the form
12646 .code
12647 Too many arguments passed to Perl subroutine "foo" (max is 8)
12648 .endd
12649 The return value of the Perl subroutine is evaluated in a scalar context before
12650 it is passed back to Exim to be inserted into the expanded string. If the
12651 return value is &'undef'&, the expansion is forced to fail in the same way as
12652 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12653 by obeying Perl's &%die%& function, the expansion fails with the error message
12654 that was passed to &%die%&.
12655
12656
12657 .section "Calling Exim functions from Perl" "SECID87"
12658 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12659 is available to call back into Exim's string expansion function. For example,
12660 the Perl code
12661 .code
12662 my $lp = Exim::expand_string('$local_part');
12663 .endd
12664 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12665 Note those are single quotes and not double quotes to protect against
12666 &$local_part$& being interpolated as a Perl variable.
12667
12668 If the string expansion is forced to fail by a &"fail"& item, the result of
12669 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12670 expansion string, the Perl call from the original expansion string fails with
12671 an appropriate error message, in the same way as if &%die%& were used.
12672
12673 .cindex "debugging" "from embedded Perl"
12674 .cindex "log" "writing from embedded Perl"
12675 Two other Exim functions are available for use from within Perl code.
12676 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12677 debugging is enabled. If you want a newline at the end, you must supply it.
12678 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12679 timestamp. In this case, you should not supply a terminating newline.
12680
12681
12682 .section "Use of standard output and error by Perl" "SECID88"
12683 .cindex "Perl" "standard output and error"
12684 You should not write to the standard error or output streams from within your
12685 Perl code, as it is not defined how these are set up. In versions of Exim
12686 before 4.50, it is possible for the standard output or error to refer to the
12687 SMTP connection during message reception via the daemon. Writing to this stream
12688 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12689 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12690 avoided, but the output is lost.
12691
12692 .cindex "Perl" "use of &%warn%&"
12693 The Perl &%warn%& statement writes to the standard error stream by default.
12694 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12695 you have no control. When Exim starts up the Perl interpreter, it arranges for
12696 output from the &%warn%& statement to be written to the Exim main log. You can
12697 change this by including appropriate Perl magic somewhere in your Perl code.
12698 For example, to discard &%warn%& output completely, you need this:
12699 .code
12700 $SIG{__WARN__} = sub { };
12701 .endd
12702 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12703 example, the code for the subroutine is empty, so it does nothing, but you can
12704 include any Perl code that you like. The text of the &%warn%& message is passed
12705 as the first subroutine argument.
12706 .ecindex IIDperl
12707
12708
12709 . ////////////////////////////////////////////////////////////////////////////
12710 . ////////////////////////////////////////////////////////////////////////////
12711
12712 .chapter "Starting the daemon and the use of network interfaces" &&&
12713          "CHAPinterfaces" &&&
12714          "Starting the daemon"
12715 .cindex "daemon" "starting"
12716 .cindex "interface" "listening"
12717 .cindex "network interface"
12718 .cindex "interface" "network"
12719 .cindex "IP address" "for listening"
12720 .cindex "daemon" "listening IP addresses"
12721 .cindex "TCP/IP" "setting listening interfaces"
12722 .cindex "TCP/IP" "setting listening ports"
12723 A host that is connected to a TCP/IP network may have one or more physical
12724 hardware network interfaces. Each of these interfaces may be configured as one
12725 or more &"logical"& interfaces, which are the entities that a program actually
12726 works with. Each of these logical interfaces is associated with an IP address.
12727 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12728 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12729 knowledge about the host's interfaces for use in three different circumstances:
12730
12731 .olist
12732 When a listening daemon is started, Exim needs to know which interfaces
12733 and ports to listen on.
12734 .next
12735 When Exim is routing an address, it needs to know which IP addresses
12736 are associated with local interfaces. This is required for the correct
12737 processing of MX lists by removing the local host and others with the
12738 same or higher priority values. Also, Exim needs to detect cases
12739 when an address is routed to an IP address that in fact belongs to the
12740 local host. Unless the &%self%& router option or the &%allow_localhost%&
12741 option of the smtp transport is set (as appropriate), this is treated
12742 as an error situation.
12743 .next
12744 When Exim connects to a remote host, it may need to know which interface to use
12745 for the outgoing connection.
12746 .endlist
12747
12748
12749 Exim's default behaviour is likely to be appropriate in the vast majority
12750 of cases. If your host has only one interface, and you want all its IP
12751 addresses to be treated in the same way, and you are using only the
12752 standard SMTP port, you should not need to take any special action. The
12753 rest of this chapter does not apply to you.
12754
12755 In a more complicated situation you may want to listen only on certain
12756 interfaces, or on different ports, and for this reason there are a number of
12757 options that can be used to influence Exim's behaviour. The rest of this
12758 chapter describes how they operate.
12759
12760 When a message is received over TCP/IP, the interface and port that were
12761 actually used are set in &$received_ip_address$& and &$received_port$&.
12762
12763
12764
12765 .section "Starting a listening daemon" "SECID89"
12766 When a listening daemon is started (by means of the &%-bd%& command line
12767 option), the interfaces and ports on which it listens are controlled by the
12768 following options:
12769
12770 .ilist
12771 &%daemon_smtp_ports%& contains a list of default ports
12772 or service names.
12773 (For backward compatibility, this option can also be specified in the singular.)
12774 .next
12775 &%local_interfaces%& contains list of interface IP addresses on which to
12776 listen. Each item may optionally also specify a port.
12777 .endlist
12778
12779 The default list separator in both cases is a colon, but this can be changed as
12780 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12781 it is usually best to change the separator to avoid having to double all the
12782 colons. For example:
12783 .code
12784 local_interfaces = <; 127.0.0.1 ; \
12785                       192.168.23.65 ; \
12786                       ::1 ; \
12787                       3ffe:ffff:836f::fe86:a061
12788 .endd
12789 There are two different formats for specifying a port along with an IP address
12790 in &%local_interfaces%&:
12791
12792 .olist
12793 The port is added onto the address with a dot separator. For example, to listen
12794 on port 1234 on two different IP addresses:
12795 .code
12796 local_interfaces = <; 192.168.23.65.1234 ; \
12797                       3ffe:ffff:836f::fe86:a061.1234
12798 .endd
12799 .next
12800 The IP address is enclosed in square brackets, and the port is added
12801 with a colon separator, for example:
12802 .code
12803 local_interfaces = <; [192.168.23.65]:1234 ; \
12804                       [3ffe:ffff:836f::fe86:a061]:1234
12805 .endd
12806 .endlist
12807
12808 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12809 default setting contains just one port:
12810 .code
12811 daemon_smtp_ports = smtp
12812 .endd
12813 If more than one port is listed, each interface that does not have its own port
12814 specified listens on all of them. Ports that are listed in
12815 &%daemon_smtp_ports%& can be identified either by name (defined in
12816 &_/etc/services_&) or by number. However, when ports are given with individual
12817 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12818
12819
12820
12821 .section "Special IP listening addresses" "SECID90"
12822 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12823 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12824 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12825 instead of setting up separate listening sockets for each interface. The
12826 default value of &%local_interfaces%& is
12827 .code
12828 local_interfaces = 0.0.0.0
12829 .endd
12830 when Exim is built without IPv6 support; otherwise it is:
12831 .code
12832 local_interfaces = <; ::0 ; 0.0.0.0
12833 .endd
12834 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12835
12836
12837
12838 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12839 The &%-oX%& command line option can be used to override the values of
12840 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12841 instance. Another way of doing this would be to use macros and the &%-D%&
12842 option. However, &%-oX%& can be used by any admin user, whereas modification of
12843 the runtime configuration by &%-D%& is allowed only when the caller is root or
12844 exim.
12845
12846 The value of &%-oX%& is a list of items. The default colon separator can be
12847 changed in the usual way if required. If there are any items that do not
12848 contain dots or colons (that is, are not IP addresses), the value of
12849 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12850 items that do contain dots or colons, the value of &%local_interfaces%& is
12851 replaced by those items. Thus, for example,
12852 .code
12853 -oX 1225
12854 .endd
12855 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12856 whereas
12857 .code
12858 -oX 192.168.34.5.1125
12859 .endd
12860 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12861 (However, since &%local_interfaces%& now contains no items without ports, the
12862 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12863
12864
12865
12866 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12867 .cindex "ssmtp protocol"
12868 .cindex "smtps protocol"
12869 .cindex "SMTP" "ssmtp protocol"
12870 .cindex "SMTP" "smtps protocol"
12871 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12872 before the STARTTLS command was standardized for SMTP. Some legacy clients
12873 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12874 list of port numbers or service names,
12875 connections to those ports must use SSMTP. The most
12876 common use of this option is expected to be
12877 .code
12878 tls_on_connect_ports = 465
12879 .endd
12880 because 465 is the usual port number used by the legacy clients. There is also
12881 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12882 this way when a daemon is started.
12883
12884 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12885 daemon to listen on those ports. You must still specify them in
12886 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12887 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12888 connections via the daemon.)
12889
12890
12891
12892
12893 .section "IPv6 address scopes" "SECID92"
12894 .cindex "IPv6" "address scopes"
12895 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12896 can, in principle, have the same link-local IPv6 address on different
12897 interfaces. Thus, additional information is needed, over and above the IP
12898 address, to distinguish individual interfaces. A convention of using a
12899 percent sign followed by something (often the interface name) has been
12900 adopted in some cases, leading to addresses like this:
12901 .code
12902 fe80::202:b3ff:fe03:45c1%eth0
12903 .endd
12904 To accommodate this usage, a percent sign followed by an arbitrary string is
12905 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12906 to convert a textual IPv6 address for actual use. This function recognizes the
12907 percent convention in operating systems that support it, and it processes the
12908 address appropriately. Unfortunately, some older libraries have problems with
12909 &[getaddrinfo()]&. If
12910 .code
12911 IPV6_USE_INET_PTON=yes
12912 .endd
12913 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12914 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12915 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12916 function.) Of course, this means that the additional functionality of
12917 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12918
12919 .section "Disabling IPv6" "SECID93"
12920 .cindex "IPv6" "disabling"
12921 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12922 run on a host whose kernel does not support IPv6. The binary will fall back to
12923 using IPv4, but it may waste resources looking up AAAA records, and trying to
12924 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12925 .oindex "&%disable_ipv6%&"
12926 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12927 activities take place. AAAA records are never looked up, and any IPv6 addresses
12928 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12929 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12930 to handle IPv6 literal addresses.
12931
12932 On the other hand, when IPv6 is in use, there may be times when you want to
12933 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12934 option to globally suppress the lookup of AAAA records for specified domains,
12935 and you can use the &%ignore_target_hosts%& generic router option to ignore
12936 IPv6 addresses in an individual router.
12937
12938
12939
12940 .section "Examples of starting a listening daemon" "SECID94"
12941 The default case in an IPv6 environment is
12942 .code
12943 daemon_smtp_ports = smtp
12944 local_interfaces = <; ::0 ; 0.0.0.0
12945 .endd
12946 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12947 Either one or two sockets may be used, depending on the characteristics of
12948 the TCP/IP stack. (This is complicated and messy; for more information,
12949 read the comments in the &_daemon.c_& source file.)
12950
12951 To specify listening on ports 25 and 26 on all interfaces:
12952 .code
12953 daemon_smtp_ports = 25 : 26
12954 .endd
12955 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12956 .code
12957 local_interfaces = <; ::0.25     ; ::0.26 \
12958                       0.0.0.0.25 ; 0.0.0.0.26
12959 .endd
12960 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12961 IPv4 loopback address only:
12962 .code
12963 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12964 .endd
12965 To specify listening on the default port on specific interfaces only:
12966 .code
12967 local_interfaces = 10.0.0.67 : 192.168.34.67
12968 .endd
12969 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12970
12971
12972
12973 .section "Recognizing the local host" "SECTreclocipadd"
12974 The &%local_interfaces%& option is also used when Exim needs to determine
12975 whether or not an IP address refers to the local host. That is, the IP
12976 addresses of all the interfaces on which a daemon is listening are always
12977 treated as local.
12978
12979 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12980 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12981 available interfaces from the operating system, and extracts the relevant
12982 (that is, IPv4 or IPv6) addresses to use for checking.
12983
12984 Some systems set up large numbers of virtual interfaces in order to provide
12985 many virtual web servers. In this situation, you may want to listen for
12986 email on only a few of the available interfaces, but nevertheless treat all
12987 interfaces as local when routing. You can do this by setting
12988 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12989 &"all"& wildcard values. These addresses are recognized as local, but are not
12990 used for listening. Consider this example:
12991 .code
12992 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12993                       192.168.53.235 ; \
12994                       3ffe:2101:12:1:a00:20ff:fe86:a061
12995
12996 extra_local_interfaces = <; ::0 ; 0.0.0.0
12997 .endd
12998 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12999 address, but all available interface addresses are treated as local when
13000 Exim is routing.
13001
13002 In some environments the local host name may be in an MX list, but with an IP
13003 address that is not assigned to any local interface. In other cases it may be
13004 desirable to treat other host names as if they referred to the local host. Both
13005 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13006 This contains host names rather than IP addresses. When a host is referenced
13007 during routing, either via an MX record or directly, it is treated as the local
13008 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13009 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13010
13011
13012
13013 .section "Delivering to a remote host" "SECID95"
13014 Delivery to a remote host is handled by the smtp transport. By default, it
13015 allows the system's TCP/IP functions to choose which interface to use (if
13016 there is more than one) when connecting to a remote host. However, the
13017 &%interface%& option can be set to specify which interface is used. See the
13018 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13019 details.
13020
13021
13022
13023
13024 . ////////////////////////////////////////////////////////////////////////////
13025 . ////////////////////////////////////////////////////////////////////////////
13026
13027 .chapter "Main configuration" "CHAPmainconfig"
13028 .scindex IIDconfima "configuration file" "main section"
13029 .scindex IIDmaiconf "main configuration"
13030 The first part of the run time configuration file contains three types of item:
13031
13032 .ilist
13033 Macro definitions: These lines start with an upper case letter. See section
13034 &<<SECTmacrodefs>>& for details of macro processing.
13035 .next
13036 Named list definitions: These lines start with one of the words &"domainlist"&,
13037 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13038 section &<<SECTnamedlists>>&.
13039 .next
13040 Main configuration settings: Each setting occupies one line of the file
13041 (with possible continuations). If any setting is preceded by the word
13042 &"hide"&, the &%-bP%& command line option displays its value to admin users
13043 only. See section &<<SECTcos>>& for a description of the syntax of these option
13044 settings.
13045 .endlist
13046
13047 This chapter specifies all the main configuration options, along with their
13048 types and default values. For ease of finding a particular option, they appear
13049 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13050 are now so many options, they are first listed briefly in functional groups, as
13051 an aid to finding the name of the option you are looking for. Some options are
13052 listed in more than one group.
13053
13054 .section "Miscellaneous" "SECID96"
13055 .table2
13056 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13057 .row &%disable_ipv6%&                "do no IPv6 processing"
13058 .row &%keep_malformed%&              "for broken files &-- should not happen"
13059 .row &%localhost_number%&            "for unique message ids in clusters"
13060 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13061 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13062 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13063 .row &%print_topbitchars%&           "top-bit characters are printing"
13064 .row &%timezone%&                    "force time zone"
13065 .endtable
13066
13067
13068 .section "Exim parameters" "SECID97"
13069 .table2
13070 .row &%exim_group%&                  "override compiled-in value"
13071 .row &%exim_path%&                   "override compiled-in value"
13072 .row &%exim_user%&                   "override compiled-in value"
13073 .row &%primary_hostname%&            "default from &[uname()]&"
13074 .row &%split_spool_directory%&       "use multiple directories"
13075 .row &%spool_directory%&             "override compiled-in value"
13076 .endtable
13077
13078
13079
13080 .section "Privilege controls" "SECID98"
13081 .table2
13082 .row &%admin_groups%&                "groups that are Exim admin users"
13083 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13084 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13085 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13086 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13087 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13088 .row &%never_users%&                 "do not run deliveries as these"
13089 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13090 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13091 .row &%trusted_groups%&              "groups that are trusted"
13092 .row &%trusted_users%&               "users that are trusted"
13093 .endtable
13094
13095
13096
13097 .section "Logging" "SECID99"
13098 .table2
13099 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13100 .row &%log_file_path%&               "override compiled-in value"
13101 .row &%log_selector%&                "set/unset optional logging"
13102 .row &%log_timezone%&                "add timezone to log lines"
13103 .row &%message_logs%&                "create per-message logs"
13104 .row &%preserve_message_logs%&       "after message completion"
13105 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13106 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13107 .row &%syslog_facility%&             "set syslog &""facility""& field"
13108 .row &%syslog_processname%&          "set syslog &""ident""& field"
13109 .row &%syslog_timestamp%&            "timestamp syslog lines"
13110 .row &%write_rejectlog%&             "control use of message log"
13111 .endtable
13112
13113
13114
13115 .section "Frozen messages" "SECID100"
13116 .table2
13117 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13118 .row &%freeze_tell%&                 "send message when freezing"
13119 .row &%move_frozen_messages%&        "to another directory"
13120 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13121 .endtable
13122
13123
13124
13125 .section "Data lookups" "SECID101"
13126 .table2
13127 .row &%ibase_servers%&               "InterBase servers"
13128 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13129 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13130 .row &%ldap_cert_file%&              "client cert file for LDAP"
13131 .row &%ldap_cert_key%&               "client key file for LDAP"
13132 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13133 .row &%ldap_default_servers%&        "used if no server in query"
13134 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13135 .row &%ldap_start_tls%&              "require TLS within LDAP"
13136 .row &%ldap_version%&                "set protocol version"
13137 .row &%lookup_open_max%&             "lookup files held open"
13138 .row &%mysql_servers%&               "default MySQL servers"
13139 .row &%oracle_servers%&              "Oracle servers"
13140 .row &%pgsql_servers%&               "default PostgreSQL servers"
13141 .row &%sqlite_lock_timeout%&         "as it says"
13142 .endtable
13143
13144
13145
13146 .section "Message ids" "SECID102"
13147 .table2
13148 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13149 .row &%message_id_header_text%&      "ditto"
13150 .endtable
13151
13152
13153
13154 .section "Embedded Perl Startup" "SECID103"
13155 .table2
13156 .row &%perl_at_start%&               "always start the interpreter"
13157 .row &%perl_startup%&                "code to obey when starting Perl"
13158 .endtable
13159
13160
13161
13162 .section "Daemon" "SECID104"
13163 .table2
13164 .row &%daemon_smtp_ports%&           "default ports"
13165 .row &%daemon_startup_retries%&      "number of times to retry"
13166 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13167 .row &%extra_local_interfaces%&      "not necessarily listened on"
13168 .row &%local_interfaces%&            "on which to listen, with optional ports"
13169 .row &%pid_file_path%&               "override compiled-in value"
13170 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13171 .endtable
13172
13173
13174
13175 .section "Resource control" "SECID105"
13176 .table2
13177 .row &%check_log_inodes%&            "before accepting a message"
13178 .row &%check_log_space%&             "before accepting a message"
13179 .row &%check_spool_inodes%&          "before accepting a message"
13180 .row &%check_spool_space%&           "before accepting a message"
13181 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13182 .row &%queue_only_load%&             "queue incoming if load high"
13183 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13184 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13185 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13186 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13187 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13188 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13189 .row &%smtp_accept_max_per_connection%& "messages per connection"
13190 .row &%smtp_accept_max_per_host%&    "connections from one host"
13191 .row &%smtp_accept_queue%&           "queue mail if more connections"
13192 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13193                                            connection"
13194 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13195 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13196 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13197 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13198 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13199 .endtable
13200
13201
13202
13203 .section "Policy controls" "SECID106"
13204 .table2
13205 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13206 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13207 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13208 .row &%acl_smtp_auth%&               "ACL for AUTH"
13209 .row &%acl_smtp_connect%&            "ACL for connection"
13210 .row &%acl_smtp_data%&               "ACL for DATA"
13211 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13212 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13213 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13214 .row &%acl_smtp_expn%&               "ACL for EXPN"
13215 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13216 .row &%acl_smtp_mail%&               "ACL for MAIL"
13217 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13218 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13219 .row &%acl_smtp_predata%&            "ACL for start of data"
13220 .row &%acl_smtp_quit%&               "ACL for QUIT"
13221 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13222 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13223 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13224 .row &%av_scanner%&                  "specify virus scanner"
13225 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13226                                       words""&"
13227 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13228 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13229 .row &%header_maxsize%&              "total size of message header"
13230 .row &%header_line_maxsize%&         "individual header line limit"
13231 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13232 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13233 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13234 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13235 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13236 .row &%host_lookup%&                 "host name looked up for these hosts"
13237 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13238 .row &%host_reject_connection%&      "reject connection from these hosts"
13239 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13240 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13241 .row &%message_size_limit%&          "for all messages"
13242 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13243 .row &%spamd_address%&               "set interface to SpamAssassin"
13244 .row &%strict_acl_vars%&             "object to unset ACL variables"
13245 .endtable
13246
13247
13248
13249 .section "Callout cache" "SECID107"
13250 .table2
13251 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13252                                          item"
13253 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13254                                          item"
13255 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13256 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13257 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13258 .endtable
13259
13260
13261
13262 .section "TLS" "SECID108"
13263 .table2
13264 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13265 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13266 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13267 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13268 .row &%tls_certificate%&             "location of server certificate"
13269 .row &%tls_crl%&                     "certificate revocation list"
13270 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13271 .row &%tls_dhparam%&                 "DH parameters for server"
13272 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13273 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13274 .row &%tls_privatekey%&              "location of server private key"
13275 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13276 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13277 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13278 .row &%tls_verify_certificates%&     "expected client certificates"
13279 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13280 .endtable
13281
13282
13283
13284 .section "Local user handling" "SECID109"
13285 .table2
13286 .row &%finduser_retries%&            "useful in NIS environments"
13287 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13288 .row &%gecos_pattern%&               "ditto"
13289 .row &%max_username_length%&         "for systems that truncate"
13290 .row &%unknown_login%&               "used when no login name found"
13291 .row &%unknown_username%&            "ditto"
13292 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13293 .row &%uucp_from_sender%&            "ditto"
13294 .endtable
13295
13296
13297
13298 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13299 .table2
13300 .row &%header_maxsize%&              "total size of message header"
13301 .row &%header_line_maxsize%&         "individual header line limit"
13302 .row &%message_size_limit%&          "applies to all messages"
13303 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13304 .row &%received_header_text%&        "expanded to make &'Received:'&"
13305 .row &%received_headers_max%&        "for mail loop detection"
13306 .row &%recipients_max%&              "limit per message"
13307 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13308 .endtable
13309
13310
13311
13312
13313 .section "Non-SMTP incoming messages" "SECID111"
13314 .table2
13315 .row &%receive_timeout%&             "for non-SMTP messages"
13316 .endtable
13317
13318
13319
13320
13321
13322 .section "Incoming SMTP messages" "SECID112"
13323 See also the &'Policy controls'& section above.
13324
13325 .table2
13326 .row &%host_lookup%&                 "host name looked up for these hosts"
13327 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13328 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13329 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13330 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13331 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13332 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13333 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13334 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13335 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13336 .row &%smtp_accept_max_per_connection%& "messages per connection"
13337 .row &%smtp_accept_max_per_host%&    "connections from one host"
13338 .row &%smtp_accept_queue%&           "queue mail if more connections"
13339 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13340                                            connection"
13341 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13342 .row &%smtp_active_hostname%&        "host name to use in messages"
13343 .row &%smtp_banner%&                 "text for welcome banner"
13344 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13345 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13346 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13347 .row &%smtp_etrn_command%&           "what to run for ETRN"
13348 .row &%smtp_etrn_serialize%&         "only one at once"
13349 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13350 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13351 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13352 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13353 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13354 .row &%smtp_receive_timeout%&        "per command or data line"
13355 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13356 .row &%smtp_return_error_details%&   "give detail on rejections"
13357 .endtable
13358
13359
13360
13361 .section "SMTP extensions" "SECID113"
13362 .table2
13363 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13364 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13365 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13366 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13367 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13368 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13369 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13370 .endtable
13371
13372
13373
13374 .section "Processing messages" "SECID114"
13375 .table2
13376 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13377 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13378 .row &%allow_utf8_domains%&          "in addresses"
13379 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13380                                       words""&"
13381 .row &%delivery_date_remove%&        "from incoming messages"
13382 .row &%envelope_to_remove%&          "from incoming messages"
13383 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13384 .row &%headers_charset%&             "default for translations"
13385 .row &%qualify_domain%&              "default for senders"
13386 .row &%qualify_recipient%&           "default for recipients"
13387 .row &%return_path_remove%&          "from incoming messages"
13388 .row &%strip_excess_angle_brackets%& "in addresses"
13389 .row &%strip_trailing_dot%&          "at end of addresses"
13390 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13391 .endtable
13392
13393
13394
13395 .section "System filter" "SECID115"
13396 .table2
13397 .row &%system_filter%&               "locate system filter"
13398 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13399                                             directory"
13400 .row &%system_filter_file_transport%& "transport for delivery to a file"
13401 .row &%system_filter_group%&         "group for filter running"
13402 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13403 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13404 .row &%system_filter_user%&          "user for filter running"
13405 .endtable
13406
13407
13408
13409 .section "Routing and delivery" "SECID116"
13410 .table2
13411 .row &%disable_ipv6%&                "do no IPv6 processing"
13412 .row &%dns_again_means_nonexist%&    "for broken domains"
13413 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13414 .row &%dns_dnssec_ok%&               "parameter for resolver"
13415 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13416 .row &%dns_retrans%&                 "parameter for resolver"
13417 .row &%dns_retry%&                   "parameter for resolver"
13418 .row &%dns_use_edns0%&               "parameter for resolver"
13419 .row &%hold_domains%&                "hold delivery for these domains"
13420 .row &%local_interfaces%&            "for routing checks"
13421 .row &%queue_domains%&               "no immediate delivery for these"
13422 .row &%queue_only%&                  "no immediate delivery at all"
13423 .row &%queue_only_file%&             "no immediate delivery if file exists"
13424 .row &%queue_only_load%&             "no immediate delivery if load is high"
13425 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13426 .row &%queue_only_override%&         "allow command line to override"
13427 .row &%queue_run_in_order%&          "order of arrival"
13428 .row &%queue_run_max%&               "of simultaneous queue runners"
13429 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13430 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13431 .row &%remote_sort_domains%&         "order of remote deliveries"
13432 .row &%retry_data_expire%&           "timeout for retry data"
13433 .row &%retry_interval_max%&          "safety net for retry rules"
13434 .endtable
13435
13436
13437
13438 .section "Bounce and warning messages" "SECID117"
13439 .table2
13440 .row &%bounce_message_file%&         "content of bounce"
13441 .row &%bounce_message_text%&         "content of bounce"
13442 .row &%bounce_return_body%&          "include body if returning message"
13443 .row &%bounce_return_message%&       "include original message in bounce"
13444 .row &%bounce_return_size_limit%&    "limit on returned message"
13445 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13446 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13447 .row &%errors_copy%&                 "copy bounce messages"
13448 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13449 .row &%delay_warning%&               "time schedule"
13450 .row &%delay_warning_condition%&     "condition for warning messages"
13451 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13452 .row &%smtp_return_error_details%&   "give detail on rejections"
13453 .row &%warn_message_file%&           "content of warning message"
13454 .endtable
13455
13456
13457
13458 .section "Alphabetical list of main options" "SECTalomo"
13459 Those options that undergo string expansion before use are marked with
13460 &dagger;.
13461
13462 .option accept_8bitmime main boolean true
13463 .cindex "8BITMIME"
13464 .cindex "8-bit characters"
13465 .cindex "log" "selectors"
13466 .cindex "log" "8BITMIME"
13467 This option causes Exim to send 8BITMIME in its response to an SMTP
13468 EHLO command, and to accept the BODY= parameter on MAIL commands.
13469 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13470 takes no steps to do anything special with messages received by this route.
13471
13472 Historically Exim kept this option off by default, but the maintainers
13473 feel that in today's Internet, this causes more problems than it solves.
13474 It now defaults to true.
13475 A more detailed analysis of the issues is provided by Dan Bernstein:
13476 .display
13477 &url(http://cr.yp.to/smtp/8bitmime.html)
13478 .endd
13479
13480 To log received 8BITMIME status use
13481 .code
13482 log_selector = +8bitmime
13483 .endd
13484
13485 .option acl_not_smtp main string&!! unset
13486 .cindex "&ACL;" "for non-SMTP messages"
13487 .cindex "non-SMTP messages" "ACLs for"
13488 This option defines the ACL that is run when a non-SMTP message has been
13489 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13490 further details.
13491
13492 .option acl_not_smtp_mime main string&!! unset
13493 This option defines the ACL that is run for individual MIME parts of non-SMTP
13494 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13495 SMTP messages.
13496
13497 .option acl_not_smtp_start main string&!! unset
13498 .cindex "&ACL;" "at start of non-SMTP message"
13499 .cindex "non-SMTP messages" "ACLs for"
13500 This option defines the ACL that is run before Exim starts reading a
13501 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13502
13503 .option acl_smtp_auth main string&!! unset
13504 .cindex "&ACL;" "setting up for SMTP commands"
13505 .cindex "AUTH" "ACL for"
13506 This option defines the ACL that is run when an SMTP AUTH command is
13507 received. See chapter &<<CHAPACL>>& for further details.
13508
13509 .option acl_smtp_connect main string&!! unset
13510 .cindex "&ACL;" "on SMTP connection"
13511 This option defines the ACL that is run when an SMTP connection is received.
13512 See chapter &<<CHAPACL>>& for further details.
13513
13514 .option acl_smtp_data main string&!! unset
13515 .cindex "DATA" "ACL for"
13516 This option defines the ACL that is run after an SMTP DATA command has been
13517 processed and the message itself has been received, but before the final
13518 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13519
13520 .option acl_smtp_data_prdr main string&!! unset
13521 .cindex "DATA" "ACL for"
13522 .cindex "&ACL;" "PRDR-related"
13523 .cindex "&ACL;" "per-user data processing"
13524 This option defines the ACL that,
13525 if the PRDR feature has been negotiated,
13526 is run for each recipient after an SMTP DATA command has been
13527 processed and the message itself has been received, but before the
13528 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13529
13530 .option acl_smtp_etrn main string&!! unset
13531 .cindex "ETRN" "ACL for"
13532 This option defines the ACL that is run when an SMTP ETRN command is
13533 received. See chapter &<<CHAPACL>>& for further details.
13534
13535 .option acl_smtp_expn main string&!! unset
13536 .cindex "EXPN" "ACL for"
13537 This option defines the ACL that is run when an SMTP EXPN command is
13538 received. See chapter &<<CHAPACL>>& for further details.
13539
13540 .option acl_smtp_helo main string&!! unset
13541 .cindex "EHLO" "ACL for"
13542 .cindex "HELO" "ACL for"
13543 This option defines the ACL that is run when an SMTP EHLO or HELO
13544 command is received. See chapter &<<CHAPACL>>& for further details.
13545
13546
13547 .option acl_smtp_mail main string&!! unset
13548 .cindex "MAIL" "ACL for"
13549 This option defines the ACL that is run when an SMTP MAIL command is
13550 received. See chapter &<<CHAPACL>>& for further details.
13551
13552 .option acl_smtp_mailauth main string&!! unset
13553 .cindex "AUTH" "on MAIL command"
13554 This option defines the ACL that is run when there is an AUTH parameter on
13555 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13556 &<<CHAPSMTPAUTH>>& for details of authentication.
13557
13558 .option acl_smtp_mime main string&!! unset
13559 .cindex "MIME content scanning" "ACL for"
13560 This option is available when Exim is built with the content-scanning
13561 extension. It defines the ACL that is run for each MIME part in a message. See
13562 section &<<SECTscanmimepart>>& for details.
13563
13564 .option acl_smtp_predata main string&!! unset
13565 This option defines the ACL that is run when an SMTP DATA command is
13566 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13567 further details.
13568
13569 .option acl_smtp_quit main string&!! unset
13570 .cindex "QUIT, ACL for"
13571 This option defines the ACL that is run when an SMTP QUIT command is
13572 received. See chapter &<<CHAPACL>>& for further details.
13573
13574 .option acl_smtp_rcpt main string&!! unset
13575 .cindex "RCPT" "ACL for"
13576 This option defines the ACL that is run when an SMTP RCPT command is
13577 received. See chapter &<<CHAPACL>>& for further details.
13578
13579 .option acl_smtp_starttls main string&!! unset
13580 .cindex "STARTTLS, ACL for"
13581 This option defines the ACL that is run when an SMTP STARTTLS command is
13582 received. See chapter &<<CHAPACL>>& for further details.
13583
13584 .option acl_smtp_vrfy main string&!! unset
13585 .cindex "VRFY" "ACL for"
13586 This option defines the ACL that is run when an SMTP VRFY command is
13587 received. See chapter &<<CHAPACL>>& for further details.
13588
13589 .option admin_groups main "string list&!!" unset
13590 .cindex "admin user"
13591 This option is expanded just once, at the start of Exim's processing. If the
13592 current group or any of the supplementary groups of an Exim caller is in this
13593 colon-separated list, the caller has admin privileges. If all your system
13594 programmers are in a specific group, for example, you can give them all Exim
13595 admin privileges by putting that group in &%admin_groups%&. However, this does
13596 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13597 To permit this, you have to add individuals to the Exim group.
13598
13599 .option allow_domain_literals main boolean false
13600 .cindex "domain literal"
13601 If this option is set, the RFC 2822 domain literal format is permitted in
13602 email addresses. The option is not set by default, because the domain literal
13603 format is not normally required these days, and few people know about it. It
13604 has, however, been exploited by mail abusers.
13605
13606 Unfortunately, it seems that some DNS black list maintainers are using this
13607 format to report black listing to postmasters. If you want to accept messages
13608 addressed to your hosts by IP address, you need to set
13609 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13610 domains (defined in the named domain list &%local_domains%& in the default
13611 configuration). This &"magic string"& matches the domain literal form of all
13612 the local host's IP addresses.
13613
13614
13615 .option allow_mx_to_ip main boolean false
13616 .cindex "MX record" "pointing to IP address"
13617 It appears that more and more DNS zone administrators are breaking the rules
13618 and putting domain names that look like IP addresses on the right hand side of
13619 MX records. Exim follows the rules and rejects this, giving an error message
13620 that explains the mis-configuration. However, some other MTAs support this
13621 practice, so to avoid &"Why can't Exim do this?"& complaints,
13622 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13623 recommended, except when you have no other choice.
13624
13625 .option allow_utf8_domains main boolean false
13626 .cindex "domain" "UTF-8 characters in"
13627 .cindex "UTF-8" "in domain name"
13628 Lots of discussion is going on about internationalized domain names. One
13629 camp is strongly in favour of just using UTF-8 characters, and it seems
13630 that at least two other MTAs permit this. This option allows Exim users to
13631 experiment if they wish.
13632
13633 If it is set true, Exim's domain parsing function allows valid
13634 UTF-8 multicharacters to appear in domain name components, in addition to
13635 letters, digits, and hyphens. However, just setting this option is not
13636 enough; if you want to look up these domain names in the DNS, you must also
13637 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13638 suitable setting is:
13639 .code
13640 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13641   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13642 .endd
13643 Alternatively, you can just disable this feature by setting
13644 .code
13645 dns_check_names_pattern =
13646 .endd
13647 That is, set the option to an empty string so that no check is done.
13648
13649
13650 .option auth_advertise_hosts main "host list&!!" *
13651 .cindex "authentication" "advertising"
13652 .cindex "AUTH" "advertising"
13653 If any server authentication mechanisms are configured, Exim advertises them in
13654 response to an EHLO command only if the calling host matches this list.
13655 Otherwise, Exim does not advertise AUTH.
13656 Exim does not accept AUTH commands from clients to which it has not
13657 advertised the availability of AUTH. The advertising of individual
13658 authentication mechanisms can be controlled by the use of the
13659 &%server_advertise_condition%& generic authenticator option on the individual
13660 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13661
13662 Certain mail clients (for example, Netscape) require the user to provide a name
13663 and password for authentication if AUTH is advertised, even though it may
13664 not be needed (the host may accept messages from hosts on its local LAN without
13665 authentication, for example). The &%auth_advertise_hosts%& option can be used
13666 to make these clients more friendly by excluding them from the set of hosts to
13667 which Exim advertises AUTH.
13668
13669 .cindex "AUTH" "advertising when encrypted"
13670 If you want to advertise the availability of AUTH only when the connection
13671 is encrypted using TLS, you can make use of the fact that the value of this
13672 option is expanded, with a setting like this:
13673 .code
13674 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13675 .endd
13676 .vindex "&$tls_in_cipher$&"
13677 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13678 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13679 expansion is *, which matches all hosts.
13680
13681
13682 .option auto_thaw main time 0s
13683 .cindex "thawing messages"
13684 .cindex "unfreezing messages"
13685 If this option is set to a time greater than zero, a queue runner will try a
13686 new delivery attempt on any frozen message, other than a bounce message, if
13687 this much time has passed since it was frozen. This may result in the message
13688 being re-frozen if nothing has changed since the last attempt. It is a way of
13689 saying &"keep on trying, even though there are big problems"&.
13690
13691 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13692 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13693 thought to be very useful any more, and its use should probably be avoided.
13694
13695
13696 .option av_scanner main string "see below"
13697 This option is available if Exim is built with the content-scanning extension.
13698 It specifies which anti-virus scanner to use. The default value is:
13699 .code
13700 sophie:/var/run/sophie
13701 .endd
13702 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13703 before use. See section &<<SECTscanvirus>>& for further details.
13704
13705
13706 .option bi_command main string unset
13707 .oindex "&%-bi%&"
13708 This option supplies the name of a command that is run when Exim is called with
13709 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13710 just the command name, it is not a complete command line. If an argument is
13711 required, it must come from the &%-oA%& command line option.
13712
13713
13714 .option bounce_message_file main string unset
13715 .cindex "bounce message" "customizing"
13716 .cindex "customizing" "bounce message"
13717 This option defines a template file containing paragraphs of text to be used
13718 for constructing bounce messages.  Details of the file's contents are given in
13719 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13720
13721
13722 .option bounce_message_text main string unset
13723 When this option is set, its contents are included in the default bounce
13724 message immediately after &"This message was created automatically by mail
13725 delivery software."& It is not used if &%bounce_message_file%& is set.
13726
13727 .option bounce_return_body main boolean true
13728 .cindex "bounce message" "including body"
13729 This option controls whether the body of an incoming message is included in a
13730 bounce message when &%bounce_return_message%& is true. The default setting
13731 causes the entire message, both header and body, to be returned (subject to the
13732 value of &%bounce_return_size_limit%&). If this option is false, only the
13733 message header is included. In the case of a non-SMTP message containing an
13734 error that is detected during reception, only those header lines preceding the
13735 point at which the error was detected are returned.
13736 .cindex "bounce message" "including original"
13737
13738 .option bounce_return_message main boolean true
13739 If this option is set false, none of the original message is included in
13740 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13741 &%bounce_return_body%&.
13742
13743
13744 .option bounce_return_size_limit main integer 100K
13745 .cindex "size" "of bounce, limit"
13746 .cindex "bounce message" "size limit"
13747 .cindex "limit" "bounce message size"
13748 This option sets a limit in bytes on the size of messages that are returned to
13749 senders as part of bounce messages when &%bounce_return_message%& is true. The
13750 limit should be less than the value of the global &%message_size_limit%& and of
13751 any &%message_size_limit%& settings on transports, to allow for the bounce text
13752 that Exim generates. If this option is set to zero there is no limit.
13753
13754 When the body of any message that is to be included in a bounce message is
13755 greater than the limit, it is truncated, and a comment pointing this out is
13756 added at the top. The actual cutoff may be greater than the value given, owing
13757 to the use of buffering for transferring the message in chunks (typically 8K in
13758 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13759 messages.
13760
13761 .option bounce_sender_authentication main string unset
13762 .cindex "bounce message" "sender authentication"
13763 .cindex "authentication" "bounce message"
13764 .cindex "AUTH" "on bounce message"
13765 This option provides an authenticated sender address that is sent with any
13766 bounce messages generated by Exim that are sent over an authenticated SMTP
13767 connection. A typical setting might be:
13768 .code
13769 bounce_sender_authentication = mailer-daemon@my.domain.example
13770 .endd
13771 which would cause bounce messages to be sent using the SMTP command:
13772 .code
13773 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13774 .endd
13775 The value of &%bounce_sender_authentication%& must always be a complete email
13776 address.
13777
13778 .option callout_domain_negative_expire main time 3h
13779 .cindex "caching" "callout timeouts"
13780 .cindex "callout" "caching timeouts"
13781 This option specifies the expiry time for negative callout cache data for a
13782 domain. See section &<<SECTcallver>>& for details of callout verification, and
13783 section &<<SECTcallvercache>>& for details of the caching.
13784
13785
13786 .option callout_domain_positive_expire main time 7d
13787 This option specifies the expiry time for positive callout cache data for a
13788 domain. See section &<<SECTcallver>>& for details of callout verification, and
13789 section &<<SECTcallvercache>>& for details of the caching.
13790
13791
13792 .option callout_negative_expire main time 2h
13793 This option specifies the expiry time for negative callout cache data for an
13794 address. See section &<<SECTcallver>>& for details of callout verification, and
13795 section &<<SECTcallvercache>>& for details of the caching.
13796
13797
13798 .option callout_positive_expire main time 24h
13799 This option specifies the expiry time for positive callout cache data for an
13800 address. See section &<<SECTcallver>>& for details of callout verification, and
13801 section &<<SECTcallvercache>>& for details of the caching.
13802
13803
13804 .option callout_random_local_part main string&!! "see below"
13805 This option defines the &"random"& local part that can be used as part of
13806 callout verification. The default value is
13807 .code
13808 $primary_hostname-$tod_epoch-testing
13809 .endd
13810 See section &<<CALLaddparcall>>& for details of how this value is used.
13811
13812
13813 .option check_log_inodes main integer 0
13814 See &%check_spool_space%& below.
13815
13816
13817 .option check_log_space main integer 0
13818 See &%check_spool_space%& below.
13819
13820 .oindex "&%check_rfc2047_length%&"
13821 .cindex "RFC 2047" "disabling length check"
13822 .option check_rfc2047_length main boolean true
13823 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13824 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13825 word; strings to be encoded that exceed this length are supposed to use
13826 multiple encoded words. By default, Exim does not recognize encoded words that
13827 exceed the maximum length. However, it seems that some software, in violation
13828 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13829 set false, Exim recognizes encoded words of any length.
13830
13831
13832 .option check_spool_inodes main integer 0
13833 See &%check_spool_space%& below.
13834
13835
13836 .option check_spool_space main integer 0
13837 .cindex "checking disk space"
13838 .cindex "disk space, checking"
13839 .cindex "spool directory" "checking space"
13840 The four &%check_...%& options allow for checking of disk resources before a
13841 message is accepted.
13842
13843 .vindex "&$log_inodes$&"
13844 .vindex "&$log_space$&"
13845 .vindex "&$spool_inodes$&"
13846 .vindex "&$spool_space$&"
13847 When any of these options are set, they apply to all incoming messages. If you
13848 want to apply different checks to different kinds of message, you can do so by
13849 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13850 &$spool_space$& in an ACL with appropriate additional conditions.
13851
13852
13853 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13854 either value is greater than zero, for example:
13855 .code
13856 check_spool_space = 10M
13857 check_spool_inodes = 100
13858 .endd
13859 The spool partition is the one that contains the directory defined by
13860 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13861 transit.
13862
13863 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13864 files are written if either is greater than zero. These should be set only if
13865 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13866
13867 If there is less space or fewer inodes than requested, Exim refuses to accept
13868 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13869 error response to the MAIL command. If ESMTP is in use and there was a
13870 SIZE parameter on the MAIL command, its value is added to the
13871 &%check_spool_space%& value, and the check is performed even if
13872 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13873
13874 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13875 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13876
13877 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13878 failure a message is written to stderr and Exim exits with a non-zero code, as
13879 it obviously cannot send an error message of any kind.
13880
13881 .option daemon_smtp_ports main string &`smtp`&
13882 .cindex "port" "for daemon"
13883 .cindex "TCP/IP" "setting listening ports"
13884 This option specifies one or more default SMTP ports on which the Exim daemon
13885 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13886 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13887
13888 .option daemon_startup_retries main integer 9
13889 .cindex "daemon startup, retrying"
13890 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13891 the daemon at startup when it cannot immediately bind a listening socket
13892 (typically because the socket is already in use): &%daemon_startup_retries%&
13893 defines the number of retries after the first failure, and
13894 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13895
13896 .option daemon_startup_sleep main time 30s
13897 See &%daemon_startup_retries%&.
13898
13899 .option delay_warning main "time list" 24h
13900 .cindex "warning of delay"
13901 .cindex "delay warning, specifying"
13902 When a message is delayed, Exim sends a warning message to the sender at
13903 intervals specified by this option. The data is a colon-separated list of times
13904 after which to send warning messages. If the value of the option is an empty
13905 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13906 message has been on the queue for longer than the last time, the last interval
13907 between the times is used to compute subsequent warning times. For example,
13908 with
13909 .code
13910 delay_warning = 4h:8h:24h
13911 .endd
13912 the first message is sent after 4 hours, the second after 8 hours, and
13913 the third one after 24 hours. After that, messages are sent every 16 hours,
13914 because that is the interval between the last two times on the list. If you set
13915 just one time, it specifies the repeat interval. For example, with:
13916 .code
13917 delay_warning = 6h
13918 .endd
13919 messages are repeated every six hours. To stop warnings after a given time, set
13920 a very large time at the end of the list. For example:
13921 .code
13922 delay_warning = 2h:12h:99d
13923 .endd
13924 Note that the option is only evaluated at the time a delivery attempt fails,
13925 which depends on retry and queue-runner configuration.
13926 Typically retries will be configured more frequently than warning messages.
13927
13928 .option delay_warning_condition main string&!! "see below"
13929 .vindex "&$domain$&"
13930 The string is expanded at the time a warning message might be sent. If all the
13931 deferred addresses have the same domain, it is set in &$domain$& during the
13932 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13933 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13934 &"false"& (the comparison being done caselessly) then the warning message is
13935 not sent. The default is:
13936 .code
13937 delay_warning_condition = ${if or {\
13938   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13939   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13940   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13941   } {no}{yes}}
13942 .endd
13943 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13944 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13945 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13946 &"auto-replied"& in an &'Auto-Submitted:'& header.
13947
13948 .option deliver_drop_privilege main boolean false
13949 .cindex "unprivileged delivery"
13950 .cindex "delivery" "unprivileged"
13951 If this option is set true, Exim drops its root privilege at the start of a
13952 delivery process, and runs as the Exim user throughout. This severely restricts
13953 the kinds of local delivery that are possible, but is viable in certain types
13954 of configuration. There is a discussion about the use of root privilege in
13955 chapter &<<CHAPsecurity>>&.
13956
13957 .option deliver_queue_load_max main fixed-point unset
13958 .cindex "load average"
13959 .cindex "queue runner" "abandoning"
13960 When this option is set, a queue run is abandoned if the system load average
13961 becomes greater than the value of the option. The option has no effect on
13962 ancient operating systems on which Exim cannot determine the load average.
13963 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13964
13965
13966 .option delivery_date_remove main boolean true
13967 .cindex "&'Delivery-date:'& header line"
13968 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13969 message when it is delivered, in exactly the same way as &'Return-path:'& is
13970 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13971 should not be present in incoming messages, and this option causes them to be
13972 removed at the time the message is received, to avoid any problems that might
13973 occur when a delivered message is subsequently sent on to some other recipient.
13974
13975 .option disable_fsync main boolean false
13976 .cindex "&[fsync()]&, disabling"
13977 This option is available only if Exim was built with the compile-time option
13978 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13979 a runtime configuration generates an &"unknown option"& error. You should not
13980 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13981 really, really, really understand what you are doing. &'No pre-compiled
13982 distributions of Exim should ever make this option available.'&
13983
13984 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13985 updated files' data to be written to disc before continuing. Unexpected events
13986 such as crashes and power outages may cause data to be lost or scrambled.
13987 Here be Dragons. &*Beware.*&
13988
13989
13990 .option disable_ipv6 main boolean false
13991 .cindex "IPv6" "disabling"
13992 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13993 activities take place. AAAA records are never looked up, and any IPv6 addresses
13994 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13995 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13996 to handle IPv6 literal addresses.
13997
13998
13999 .option dns_again_means_nonexist main "domain list&!!" unset
14000 .cindex "DNS" "&""try again""& response; overriding"
14001 DNS lookups give a &"try again"& response for the DNS errors
14002 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14003 keep trying to deliver a message, or to give repeated temporary errors to
14004 incoming mail. Sometimes the effect is caused by a badly set up name server and
14005 may persist for a long time. If a domain which exhibits this problem matches
14006 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14007 This option should be used with care. You can make it apply to reverse lookups
14008 by a setting such as this:
14009 .code
14010 dns_again_means_nonexist = *.in-addr.arpa
14011 .endd
14012 This option applies to all DNS lookups that Exim does. It also applies when the
14013 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14014 since these are most likely to be caused by DNS lookup problems. The
14015 &(dnslookup)& router has some options of its own for controlling what happens
14016 when lookups for MX or SRV records give temporary errors. These more specific
14017 options are applied after this global option.
14018
14019 .option dns_check_names_pattern main string "see below"
14020 .cindex "DNS" "pre-check of name syntax"
14021 When this option is set to a non-empty string, it causes Exim to check domain
14022 names for characters that are not allowed in host names before handing them to
14023 the DNS resolver, because some resolvers give temporary errors for names that
14024 contain unusual characters. If a domain name contains any unwanted characters,
14025 a &"not found"& result is forced, and the resolver is not called. The check is
14026 done by matching the domain name against a regular expression, which is the
14027 value of this option. The default pattern is
14028 .code
14029 dns_check_names_pattern = \
14030   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14031 .endd
14032 which permits only letters, digits, slashes, and hyphens in components, but
14033 they must start and end with a letter or digit. Slashes are not, in fact,
14034 permitted in host names, but they are found in certain NS records (which can be
14035 accessed in Exim by using a &%dnsdb%& lookup). If you set
14036 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14037 empty string.
14038
14039 .option dns_csa_search_limit main integer 5
14040 This option controls the depth of parental searching for CSA SRV records in the
14041 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14042
14043 .option dns_csa_use_reverse main boolean true
14044 This option controls whether or not an IP address, given as a CSA domain, is
14045 reversed and looked up in the reverse DNS, as described in more detail in
14046 section &<<SECTverifyCSA>>&.
14047
14048
14049 .option dns_dnssec_ok main integer -1
14050 .cindex "DNS" "resolver options"
14051 .cindex "DNS" "DNSSEC"
14052 If this option is set to a non-negative number then Exim will initialise the
14053 DNS resolver library to either use or not use DNSSEC, overriding the system
14054 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14055
14056 If the resolver library does not support DNSSEC then this option has no effect.
14057
14058
14059 .option dns_ipv4_lookup main "domain list&!!" unset
14060 .cindex "IPv6" "DNS lookup for AAAA records"
14061 .cindex "DNS" "IPv6 lookup for AAAA records"
14062 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14063 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14064 (A records) when trying to find IP addresses for hosts, unless the host's
14065 domain matches this list.
14066
14067 This is a fudge to help with name servers that give big delays or otherwise do
14068 not work for the AAAA record type. In due course, when the world's name
14069 servers have all been upgraded, there should be no need for this option.
14070
14071
14072 .option dns_retrans main time 0s
14073 .cindex "DNS" "resolver options"
14074 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14075 retransmission and retry parameters for DNS lookups. Values of zero (the
14076 defaults) leave the system default settings unchanged. The first value is the
14077 time between retries, and the second is the number of retries. It isn't
14078 totally clear exactly how these settings affect the total time a DNS lookup may
14079 take. I haven't found any documentation about timeouts on DNS lookups; these
14080 parameter values are available in the external resolver interface structure,
14081 but nowhere does it seem to describe how they are used or what you might want
14082 to set in them.
14083
14084
14085 .option dns_retry main integer 0
14086 See &%dns_retrans%& above.
14087
14088
14089 .option dns_use_edns0 main integer -1
14090 .cindex "DNS" "resolver options"
14091 .cindex "DNS" "EDNS0"
14092 If this option is set to a non-negative number then Exim will initialise the
14093 DNS resolver library to either use or not use EDNS0 extensions, overriding
14094 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14095 on.
14096
14097 If the resolver library does not support EDNS0 then this option has no effect.
14098
14099
14100 .option drop_cr main boolean false
14101 This is an obsolete option that is now a no-op. It used to affect the way Exim
14102 handled CR and LF characters in incoming messages. What happens now is
14103 described in section &<<SECTlineendings>>&.
14104
14105 .option dsn_from main "string&!!" "see below"
14106 .cindex "&'From:'& header line" "in bounces"
14107 .cindex "bounce messages" "&'From:'& line, specifying"
14108 This option can be used to vary the contents of &'From:'& header lines in
14109 bounces and other automatically generated messages (&"Delivery Status
14110 Notifications"& &-- hence the name of the option). The default setting is:
14111 .code
14112 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14113 .endd
14114 The value is expanded every time it is needed. If the expansion fails, a
14115 panic is logged, and the default value is used.
14116
14117 .option envelope_to_remove main boolean true
14118 .cindex "&'Envelope-to:'& header line"
14119 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14120 message when it is delivered, in exactly the same way as &'Return-path:'& is
14121 handled. &'Envelope-to:'& records the original recipient address from the
14122 messages's envelope that caused the delivery to happen. Such headers should not
14123 be present in incoming messages, and this option causes them to be removed at
14124 the time the message is received, to avoid any problems that might occur when a
14125 delivered message is subsequently sent on to some other recipient.
14126
14127
14128 .option errors_copy main "string list&!!" unset
14129 .cindex "bounce message" "copy to other address"
14130 .cindex "copy of bounce message"
14131 Setting this option causes Exim to send bcc copies of bounce messages that it
14132 generates to other addresses. &*Note*&: This does not apply to bounce messages
14133 coming from elsewhere. The value of the option is a colon-separated list of
14134 items. Each item consists of a pattern, terminated by white space, followed by
14135 a comma-separated list of email addresses. If a pattern contains spaces, it
14136 must be enclosed in double quotes.
14137
14138 Each pattern is processed in the same way as a single item in an address list
14139 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14140 the bounce message, the message is copied to the addresses on the list. The
14141 items are scanned in order, and once a matching one is found, no further items
14142 are examined. For example:
14143 .code
14144 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14145               rqps@mydomain   hostmaster@mydomain.example,\
14146                               postmaster@mydomain.example
14147 .endd
14148 .vindex "&$domain$&"
14149 .vindex "&$local_part$&"
14150 The address list is expanded before use. The expansion variables &$local_part$&
14151 and &$domain$& are set from the original recipient of the error message, and if
14152 there was any wildcard matching in the pattern, the expansion
14153 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14154 variables &$0$&, &$1$&, etc. are set in the normal way.
14155
14156
14157 .option errors_reply_to main string unset
14158 .cindex "bounce message" "&'Reply-to:'& in"
14159 By default, Exim's bounce and delivery warning messages contain the header line
14160 .display
14161 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14162 .endd
14163 .oindex &%quota_warn_message%&
14164 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14165 A warning message that is generated by the &%quota_warn_message%& option in an
14166 &(appendfile)& transport may contain its own &'From:'& header line that
14167 overrides the default.
14168
14169 Experience shows that people reply to bounce messages. If the
14170 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14171 and warning messages. For example:
14172 .code
14173 errors_reply_to = postmaster@my.domain.example
14174 .endd
14175 The value of the option is not expanded. It must specify a valid RFC 2822
14176 address. However, if a warning message that is generated by the
14177 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14178 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14179 not used.
14180
14181
14182 .option exim_group main string "compile-time configured"
14183 .cindex "gid (group id)" "Exim's own"
14184 .cindex "Exim group"
14185 This option changes the gid under which Exim runs when it gives up root
14186 privilege. The default value is compiled into the binary. The value of this
14187 option is used only when &%exim_user%& is also set. Unless it consists entirely
14188 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14189 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14190 security issues.
14191
14192
14193 .option exim_path main string "see below"
14194 .cindex "Exim binary, path name"
14195 This option specifies the path name of the Exim binary, which is used when Exim
14196 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14197 the directory configured at compile time by the BIN_DIRECTORY setting. It
14198 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14199 other place.
14200 &*Warning*&: Do not use a macro to define the value of this option, because
14201 you will break those Exim utilities that scan the configuration file to find
14202 where the binary is. (They then use the &%-bP%& option to extract option
14203 settings such as the value of &%spool_directory%&.)
14204
14205
14206 .option exim_user main string "compile-time configured"
14207 .cindex "uid (user id)" "Exim's own"
14208 .cindex "Exim user"
14209 This option changes the uid under which Exim runs when it gives up root
14210 privilege. The default value is compiled into the binary. Ownership of the run
14211 time configuration file and the use of the &%-C%& and &%-D%& command line
14212 options is checked against the values in the binary, not what is set here.
14213
14214 Unless it consists entirely of digits, the string is looked up using
14215 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14216 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14217 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14218
14219
14220 .option extra_local_interfaces main "string list" unset
14221 This option defines network interfaces that are to be considered local when
14222 routing, but which are not used for listening by the daemon. See section
14223 &<<SECTreclocipadd>>& for details.
14224
14225
14226 . Allow this long option name to split; give it unsplit as a fifth argument
14227 . for the automatic .oindex that is generated by .option.
14228
14229 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14230          extract_addresses_remove_arguments
14231 .oindex "&%-t%&"
14232 .cindex "command line" "addresses with &%-t%&"
14233 .cindex "Sendmail compatibility" "&%-t%& option"
14234 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14235 are present on the command line when the &%-t%& option is used to build an
14236 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14237 line addresses are removed from the recipients list. This is also how Smail
14238 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14239 command line addresses are added to those obtained from the header lines. When
14240 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14241 argument headers. If it is set false, Exim adds rather than removes argument
14242 addresses.
14243
14244
14245 .option finduser_retries main integer 0
14246 .cindex "NIS, retrying user lookups"
14247 On systems running NIS or other schemes in which user and group information is
14248 distributed from a remote system, there can be times when &[getpwnam()]& and
14249 related functions fail, even when given valid data, because things time out.
14250 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14251 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14252 many extra times to find a user or a group, waiting for one second between
14253 retries.
14254
14255 .cindex "&_/etc/passwd_&" "multiple reading of"
14256 You should not set this option greater than zero if your user information is in
14257 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14258 search the file multiple times for non-existent users, and also cause delay.
14259
14260
14261
14262 .option freeze_tell main "string list, comma separated" unset
14263 .cindex "freezing messages" "sending a message when freezing"
14264 On encountering certain errors, or when configured to do so in a system filter,
14265 ACL, or special router, Exim freezes a message. This means that no further
14266 delivery attempts take place until an administrator thaws the message, or the
14267 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14268 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14269 warning message whenever it freezes something, unless the message it is
14270 freezing is a locally-generated bounce message. (Without this exception there
14271 is the possibility of looping.) The warning message is sent to the addresses
14272 supplied as the comma-separated value of this option. If several of the
14273 message's addresses cause freezing, only a single message is sent. If the
14274 freezing was automatic, the reason(s) for freezing can be found in the message
14275 log. If you configure freezing in a filter or ACL, you must arrange for any
14276 logging that you require.
14277
14278
14279 .option gecos_name main string&!! unset
14280 .cindex "HP-UX"
14281 .cindex "&""gecos""& field, parsing"
14282 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14283 password file to hold other information in addition to users' real names. Exim
14284 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14285 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14286 of the field are used unchanged, except that, if an ampersand is encountered,
14287 it is replaced by the user's login name with the first character forced to
14288 upper case, since this is a convention that is observed on many systems.
14289
14290 When these options are set, &%gecos_pattern%& is treated as a regular
14291 expression that is to be applied to the field (again with && replaced by the
14292 login name), and if it matches, &%gecos_name%& is expanded and used as the
14293 user's name.
14294
14295 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14296 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14297 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14298 name terminates at the first comma, the following can be used:
14299 .code
14300 gecos_pattern = ([^,]*)
14301 gecos_name = $1
14302 .endd
14303
14304 .option gecos_pattern main string unset
14305 See &%gecos_name%& above.
14306
14307
14308 .option gnutls_compat_mode main boolean unset
14309 This option controls whether GnuTLS is used in compatibility mode in an Exim
14310 server. This reduces security slightly, but improves interworking with older
14311 implementations of TLS.
14312
14313
14314 option gnutls_allow_auto_pkcs11 main boolean unset
14315 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14316 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14317
14318 See
14319 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14320 for documentation.
14321
14322
14323
14324 .option headers_charset main string "see below"
14325 This option sets a default character set for translating from encoded MIME
14326 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14327 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14328 ultimate default is ISO-8859-1. For more details see the description of header
14329 insertions in section &<<SECTexpansionitems>>&.
14330
14331
14332
14333 .option header_maxsize main integer "see below"
14334 .cindex "header section" "maximum size of"
14335 .cindex "limit" "size of message header section"
14336 This option controls the overall maximum size of a message's header
14337 section. The default is the value of HEADER_MAXSIZE in
14338 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14339 sections are rejected.
14340
14341
14342 .option header_line_maxsize main integer 0
14343 .cindex "header lines" "maximum size of"
14344 .cindex "limit" "size of one header line"
14345 This option limits the length of any individual header line in a message, after
14346 all the continuations have been joined together. Messages with individual
14347 header lines that are longer than the limit are rejected. The default value of
14348 zero means &"no limit"&.
14349
14350
14351
14352
14353 .option helo_accept_junk_hosts main "host list&!!" unset
14354 .cindex "HELO" "accepting junk data"
14355 .cindex "EHLO" "accepting junk data"
14356 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14357 mail, and gives an error response for invalid data. Unfortunately, there are
14358 some SMTP clients that send syntactic junk. They can be accommodated by setting
14359 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14360 if you want to do semantic checking.
14361 See also &%helo_allow_chars%& for a way of extending the permitted character
14362 set.
14363
14364
14365 .option helo_allow_chars main string unset
14366 .cindex "HELO" "underscores in"
14367 .cindex "EHLO" "underscores in"
14368 .cindex "underscore in EHLO/HELO"
14369 This option can be set to a string of rogue characters that are permitted in
14370 all EHLO and HELO names in addition to the standard letters, digits,
14371 hyphens, and dots. If you really must allow underscores, you can set
14372 .code
14373 helo_allow_chars = _
14374 .endd
14375 Note that the value is one string, not a list.
14376
14377
14378 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14379 .cindex "HELO" "forcing reverse lookup"
14380 .cindex "EHLO" "forcing reverse lookup"
14381 If the domain given by a client in a HELO or EHLO command matches this
14382 list, a reverse lookup is done in order to establish the host's true name. The
14383 default forces a lookup if the client host gives the server's name or any of
14384 its IP addresses (in brackets), something that broken clients have been seen to
14385 do.
14386
14387
14388 .option helo_try_verify_hosts main "host list&!!" unset
14389 .cindex "HELO verifying" "optional"
14390 .cindex "EHLO" "verifying, optional"
14391 By default, Exim just checks the syntax of HELO and EHLO commands (see
14392 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14393 to do more extensive checking of the data supplied by these commands. The ACL
14394 condition &`verify = helo`& is provided to make this possible.
14395 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14396 to force the check to occur. From release 4.53 onwards, this is no longer
14397 necessary. If the check has not been done before &`verify = helo`& is
14398 encountered, it is done at that time. Consequently, this option is obsolete.
14399 Its specification is retained here for backwards compatibility.
14400
14401 When an EHLO or HELO command is received, if the calling host matches
14402 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14403 EHLO command either:
14404
14405 .ilist
14406 is an IP literal matching the calling address of the host, or
14407 .next
14408 .cindex "DNS" "reverse lookup"
14409 .cindex "reverse DNS lookup"
14410 matches the host name that Exim obtains by doing a reverse lookup of the
14411 calling host address, or
14412 .next
14413 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14414 available) yields the calling host address.
14415 .endlist
14416
14417 However, the EHLO or HELO command is not rejected if any of the checks
14418 fail. Processing continues, but the result of the check is remembered, and can
14419 be detected later in an ACL by the &`verify = helo`& condition.
14420
14421 .option helo_verify_hosts main "host list&!!" unset
14422 .cindex "HELO verifying" "mandatory"
14423 .cindex "EHLO" "verifying, mandatory"
14424 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14425 backwards compatibility. For hosts that match this option, Exim checks the host
14426 name given in the HELO or EHLO in the same way as for
14427 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14428 rejected with a 550 error, and entries are written to the main and reject logs.
14429 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14430 error.
14431
14432 .option hold_domains main "domain list&!!" unset
14433 .cindex "domain" "delaying delivery"
14434 .cindex "delivery" "delaying certain domains"
14435 This option allows mail for particular domains to be held on the queue
14436 manually. The option is overridden if a message delivery is forced with the
14437 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14438 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14439 item in &%hold_domains%&, no routing or delivery for that address is done, and
14440 it is deferred every time the message is looked at.
14441
14442 This option is intended as a temporary operational measure for delaying the
14443 delivery of mail while some problem is being sorted out, or some new
14444 configuration tested. If you just want to delay the processing of some
14445 domains until a queue run occurs, you should use &%queue_domains%& or
14446 &%queue_smtp_domains%&, not &%hold_domains%&.
14447
14448 A setting of &%hold_domains%& does not override Exim's code for removing
14449 messages from the queue if they have been there longer than the longest retry
14450 time in any retry rule. If you want to hold messages for longer than the normal
14451 retry times, insert a dummy retry rule with a long retry time.
14452
14453
14454 .option host_lookup main "host list&!!" unset
14455 .cindex "host name" "lookup, forcing"
14456 Exim does not look up the name of a calling host from its IP address unless it
14457 is required to compare against some host list, or the host matches
14458 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14459 option (which normally contains IP addresses rather than host names). The
14460 default configuration file contains
14461 .code
14462 host_lookup = *
14463 .endd
14464 which causes a lookup to happen for all hosts. If the expense of these lookups
14465 is felt to be too great, the setting can be changed or removed.
14466
14467 After a successful reverse lookup, Exim does a forward lookup on the name it
14468 has obtained, to verify that it yields the IP address that it started with. If
14469 this check fails, Exim behaves as if the name lookup failed.
14470
14471 .vindex "&$host_lookup_failed$&"
14472 .vindex "&$sender_host_name$&"
14473 After any kind of failure, the host name (in &$sender_host_name$&) remains
14474 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14475 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14476 &`verify = reverse_host_lookup`& in ACLs.
14477
14478
14479 .option host_lookup_order main "string list" &`bydns:byaddr`&
14480 This option specifies the order of different lookup methods when Exim is trying
14481 to find a host name from an IP address. The default is to do a DNS lookup
14482 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14483 if that fails. You can change the order of these lookups, or omit one entirely,
14484 if you want.
14485
14486 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14487 multiple PTR records in the DNS and the IP address is not listed in
14488 &_/etc/hosts_&. Different operating systems give different results in this
14489 case. That is why the default tries a DNS lookup first.
14490
14491
14492
14493 .option host_reject_connection main "host list&!!" unset
14494 .cindex "host" "rejecting connections from"
14495 If this option is set, incoming SMTP calls from the hosts listed are rejected
14496 as soon as the connection is made.
14497 This option is obsolete, and retained only for backward compatibility, because
14498 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14499 connections immediately.
14500
14501 The ability to give an immediate rejection (either by this option or using an
14502 ACL) is provided for use in unusual cases. Many hosts will just try again,
14503 sometimes without much delay. Normally, it is better to use an ACL to reject
14504 incoming messages at a later stage, such as after RCPT commands. See
14505 chapter &<<CHAPACL>>&.
14506
14507
14508 .option hosts_connection_nolog main "host list&!!" unset
14509 .cindex "host" "not logging connections from"
14510 This option defines a list of hosts for which connection logging does not
14511 happen, even though the &%smtp_connection%& log selector is set. For example,
14512 you might want not to log SMTP connections from local processes, or from
14513 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14514 the daemon; you should therefore strive to restrict its value to a short inline
14515 list of IP addresses and networks. To disable logging SMTP connections from
14516 local processes, you must create a host list with an empty item. For example:
14517 .code
14518 hosts_connection_nolog = :
14519 .endd
14520 If the &%smtp_connection%& log selector is not set, this option has no effect.
14521
14522
14523
14524 .option hosts_treat_as_local main "domain list&!!" unset
14525 .cindex "local host" "domains treated as"
14526 .cindex "host" "treated as local"
14527 If this option is set, any host names that match the domain list are treated as
14528 if they were the local host when Exim is scanning host lists obtained from MX
14529 records
14530 or other sources. Note that the value of this option is a domain list, not a
14531 host list, because it is always used to check host names, not IP addresses.
14532
14533 This option also applies when Exim is matching the special items
14534 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14535 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14536 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14537 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14538 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14539 interfaces and recognizing the local host.
14540
14541
14542 .option ibase_servers main "string list" unset
14543 .cindex "InterBase" "server list"
14544 This option provides a list of InterBase servers and associated connection data,
14545 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14546 The option is available only if Exim has been built with InterBase support.
14547
14548
14549
14550 .option ignore_bounce_errors_after main time 10w
14551 .cindex "bounce message" "discarding"
14552 .cindex "discarding bounce message"
14553 This option affects the processing of bounce messages that cannot be delivered,
14554 that is, those that suffer a permanent delivery failure. (Bounce messages that
14555 suffer temporary delivery failures are of course retried in the usual way.)
14556
14557 After a permanent delivery failure, bounce messages are frozen,
14558 because there is no sender to whom they can be returned. When a frozen bounce
14559 message has been on the queue for more than the given time, it is unfrozen at
14560 the next queue run, and a further delivery is attempted. If delivery fails
14561 again, the bounce message is discarded. This makes it possible to keep failed
14562 bounce messages around for a shorter time than the normal maximum retry time
14563 for frozen messages. For example,
14564 .code
14565 ignore_bounce_errors_after = 12h
14566 .endd
14567 retries failed bounce message deliveries after 12 hours, discarding any further
14568 failures. If the value of this option is set to a zero time period, bounce
14569 failures are discarded immediately. Setting a very long time (as in the default
14570 value) has the effect of disabling this option. For ways of automatically
14571 dealing with other kinds of frozen message, see &%auto_thaw%& and
14572 &%timeout_frozen_after%&.
14573
14574
14575 .option ignore_fromline_hosts main "host list&!!" unset
14576 .cindex "&""From""& line"
14577 .cindex "UUCP" "&""From""& line"
14578 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14579 the headers of a message. By default this is treated as the start of the
14580 message's body, which means that any following headers are not recognized as
14581 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14582 match those hosts that insist on sending it. If the sender is actually a local
14583 process rather than a remote host, and is using &%-bs%& to inject the messages,
14584 &%ignore_fromline_local%& must be set to achieve this effect.
14585
14586
14587 .option ignore_fromline_local main boolean false
14588 See &%ignore_fromline_hosts%& above.
14589
14590
14591 .option keep_malformed main time 4d
14592 This option specifies the length of time to keep messages whose spool files
14593 have been corrupted in some way. This should, of course, never happen. At the
14594 next attempt to deliver such a message, it gets removed. The incident is
14595 logged.
14596
14597
14598 .option ldap_ca_cert_dir main string unset
14599 .cindex "LDAP", "TLS CA certificate directory"
14600 This option indicates which directory contains CA certificates for verifying
14601 a TLS certificate presented by an LDAP server.
14602 While Exim does not provide a default value, your SSL library may.
14603 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14604 and constrained to be a directory.
14605
14606
14607 .option ldap_ca_cert_file main string unset
14608 .cindex "LDAP", "TLS CA certificate file"
14609 This option indicates which file contains CA certificates for verifying
14610 a TLS certificate presented by an LDAP server.
14611 While Exim does not provide a default value, your SSL library may.
14612 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14613 and constrained to be a file.
14614
14615
14616 .option ldap_cert_file main string unset
14617 .cindex "LDAP" "TLS client certificate file"
14618 This option indicates which file contains an TLS client certificate which
14619 Exim should present to the LDAP server during TLS negotiation.
14620 Should be used together with &%ldap_cert_key%&.
14621
14622
14623 .option ldap_cert_key main string unset
14624 .cindex "LDAP" "TLS client key file"
14625 This option indicates which file contains the secret/private key to use
14626 to prove identity to the LDAP server during TLS negotiation.
14627 Should be used together with &%ldap_cert_file%&, which contains the
14628 identity to be proven.
14629
14630
14631 .option ldap_cipher_suite main string unset
14632 .cindex "LDAP" "TLS cipher suite"
14633 This controls the TLS cipher-suite negotiation during TLS negotiation with
14634 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14635 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14636
14637
14638 .option ldap_default_servers main "string list" unset
14639 .cindex "LDAP" "default servers"
14640 This option provides a list of LDAP servers which are tried in turn when an
14641 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14642 details of LDAP queries. This option is available only when Exim has been built
14643 with LDAP support.
14644
14645
14646 .option ldap_require_cert main string unset.
14647 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14648 This should be one of the values "hard", "demand", "allow", "try" or "never".
14649 A value other than one of these is interpreted as "never".
14650 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14651 Although Exim does not set a default, the LDAP library probably defaults
14652 to hard/demand.
14653
14654
14655 .option ldap_start_tls main boolean false
14656 .cindex "LDAP" "whether or not to negotiate TLS"
14657 If set, Exim will attempt to negotiate TLS with the LDAP server when
14658 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14659 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14660 of SSL-on-connect.
14661 In the event of failure to negotiate TLS, the action taken is controlled
14662 by &%ldap_require_cert%&.
14663
14664
14665 .option ldap_version main integer unset
14666 .cindex "LDAP" "protocol version, forcing"
14667 This option can be used to force Exim to set a specific protocol version for
14668 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14669 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14670 the LDAP headers; otherwise it is 2. This option is available only when Exim
14671 has been built with LDAP support.
14672
14673
14674
14675 .option local_from_check main boolean true
14676 .cindex "&'Sender:'& header line" "disabling addition of"
14677 .cindex "&'From:'& header line" "disabling checking of"
14678 When a message is submitted locally (that is, not over a TCP/IP connection) by
14679 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14680 checks that the &'From:'& header line matches the login of the calling user and
14681 the domain specified by &%qualify_domain%&.
14682
14683 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14684 locally submitted message is automatically qualified by Exim, unless the
14685 &%-bnq%& command line option is used.
14686
14687 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14688 on the local part. If the &'From:'& header line does not match, Exim adds a
14689 &'Sender:'& header with an address constructed from the calling user's login
14690 and the default qualify domain.
14691
14692 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14693 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14694 &'Sender:'& header lines supplied by untrusted users, you must also set
14695 &%local_sender_retain%& to be true.
14696
14697 .cindex "envelope sender"
14698 These options affect only the header lines in the message. The envelope sender
14699 is still forced to be the login id at the qualify domain unless
14700 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14701
14702 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14703 request similar header line checking. See section &<<SECTthesenhea>>&, which
14704 has more details about &'Sender:'& processing.
14705
14706
14707
14708
14709 .option local_from_prefix main string unset
14710 When Exim checks the &'From:'& header line of locally submitted messages for
14711 matching the login id (see &%local_from_check%& above), it can be configured to
14712 ignore certain prefixes and suffixes in the local part of the address. This is
14713 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14714 appropriate lists, in the same form as the &%local_part_prefix%& and
14715 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14716 example, if
14717 .code
14718 local_from_prefix = *-
14719 .endd
14720 is set, a &'From:'& line containing
14721 .code
14722 From: anything-user@your.domain.example
14723 .endd
14724 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14725 matches the actual sender address that is constructed from the login name and
14726 qualify domain.
14727
14728
14729 .option local_from_suffix main string unset
14730 See &%local_from_prefix%& above.
14731
14732
14733 .option local_interfaces main "string list" "see below"
14734 This option controls which network interfaces are used by the daemon for
14735 listening; they are also used to identify the local host when routing. Chapter
14736 &<<CHAPinterfaces>>& contains a full description of this option and the related
14737 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14738 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14739 &%local_interfaces%& is
14740 .code
14741 local_interfaces = 0.0.0.0
14742 .endd
14743 when Exim is built without IPv6 support; otherwise it is
14744 .code
14745 local_interfaces = <; ::0 ; 0.0.0.0
14746 .endd
14747
14748 .option local_scan_timeout main time 5m
14749 .cindex "timeout" "for &[local_scan()]& function"
14750 .cindex "&[local_scan()]& function" "timeout"
14751 This timeout applies to the &[local_scan()]& function (see chapter
14752 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14753 the incoming message is rejected with a temporary error if it is an SMTP
14754 message. For a non-SMTP message, the message is dropped and Exim ends with a
14755 non-zero code. The incident is logged on the main and reject logs.
14756
14757
14758
14759 .option local_sender_retain main boolean false
14760 .cindex "&'Sender:'& header line" "retaining from local submission"
14761 When a message is submitted locally (that is, not over a TCP/IP connection) by
14762 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14763 do not want this to happen, you must set &%local_sender_retain%&, and you must
14764 also set &%local_from_check%& to be false (Exim will complain if you do not).
14765 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14766 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14767
14768
14769
14770
14771 .option localhost_number main string&!! unset
14772 .cindex "host" "locally unique number for"
14773 .cindex "message ids" "with multiple hosts"
14774 .vindex "&$localhost_number$&"
14775 Exim's message ids are normally unique only within the local host. If
14776 uniqueness among a set of hosts is required, each host must set a different
14777 value for the &%localhost_number%& option. The string is expanded immediately
14778 after reading the configuration file (so that a number can be computed from the
14779 host name, for example) and the result of the expansion must be a number in the
14780 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14781 systems). This is available in subsequent string expansions via the variable
14782 &$localhost_number$&. When &%localhost_number is set%&, the final two
14783 characters of the message id, instead of just being a fractional part of the
14784 time, are computed from the time and the local host number as described in
14785 section &<<SECTmessiden>>&.
14786
14787
14788
14789 .option log_file_path main "string list&!!" "set at compile time"
14790 .cindex "log" "file path for"
14791 This option sets the path which is used to determine the names of Exim's log
14792 files, or indicates that logging is to be to syslog, or both. It is expanded
14793 when Exim is entered, so it can, for example, contain a reference to the host
14794 name. If no specific path is set for the log files at compile or run time, they
14795 are written in a sub-directory called &_log_& in Exim's spool directory.
14796 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14797 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14798 used. If this string is fixed at your installation (contains no expansion
14799 variables) it is recommended that you do not set this option in the
14800 configuration file, but instead supply the path using LOG_FILE_PATH in
14801 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14802 early on &-- in particular, failure to read the configuration file.
14803
14804
14805 .option log_selector main string unset
14806 .cindex "log" "selectors"
14807 This option can be used to reduce or increase the number of things that Exim
14808 writes to its log files. Its argument is made up of names preceded by plus or
14809 minus characters. For example:
14810 .code
14811 log_selector = +arguments -retry_defer
14812 .endd
14813 A list of possible names and what they control is given in the chapter on
14814 logging, in section &<<SECTlogselector>>&.
14815
14816
14817 .option log_timezone main boolean false
14818 .cindex "log" "timezone for entries"
14819 .vindex "&$tod_log$&"
14820 .vindex "&$tod_zone$&"
14821 By default, the timestamps on log lines are in local time without the
14822 timezone. This means that if your timezone changes twice a year, the timestamps
14823 in log lines are ambiguous for an hour when the clocks go back. One way of
14824 avoiding this problem is to set the timezone to UTC. An alternative is to set
14825 &%log_timezone%& true. This turns on the addition of the timezone offset to
14826 timestamps in log lines. Turning on this option can add quite a lot to the size
14827 of log files because each line is extended by 6 characters. Note that the
14828 &$tod_log$& variable contains the log timestamp without the zone, but there is
14829 another variable called &$tod_zone$& that contains just the timezone offset.
14830
14831
14832 .option lookup_open_max main integer 25
14833 .cindex "too many open files"
14834 .cindex "open files, too many"
14835 .cindex "file" "too many open"
14836 .cindex "lookup" "maximum open files"
14837 .cindex "limit" "open files for lookups"
14838 This option limits the number of simultaneously open files for single-key
14839 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14840 Exim normally keeps these files open during routing, because often the same
14841 file is required several times. If the limit is reached, Exim closes the least
14842 recently used file. Note that if you are using the &'ndbm'& library, it
14843 actually opens two files for each logical DBM database, though it still counts
14844 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14845 open files"& errors with NDBM, you need to reduce the value of
14846 &%lookup_open_max%&.
14847
14848
14849 .option max_username_length main integer 0
14850 .cindex "length of login name"
14851 .cindex "user name" "maximum length"
14852 .cindex "limit" "user name length"
14853 Some operating systems are broken in that they truncate long arguments to
14854 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14855 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14856 an argument that is longer behaves as if &[getpwnam()]& failed.
14857
14858
14859 .option message_body_newlines main bool false
14860 .cindex "message body" "newlines in variables"
14861 .cindex "newline" "in message body variables"
14862 .vindex "&$message_body$&"
14863 .vindex "&$message_body_end$&"
14864 By default, newlines in the message body are replaced by spaces when setting
14865 the &$message_body$& and &$message_body_end$& expansion variables. If this
14866 option is set true, this no longer happens.
14867
14868
14869 .option message_body_visible main integer 500
14870 .cindex "body of message" "visible size"
14871 .cindex "message body" "visible size"
14872 .vindex "&$message_body$&"
14873 .vindex "&$message_body_end$&"
14874 This option specifies how much of a message's body is to be included in the
14875 &$message_body$& and &$message_body_end$& expansion variables.
14876
14877
14878 .option message_id_header_domain main string&!! unset
14879 .cindex "&'Message-ID:'& header line"
14880 If this option is set, the string is expanded and used as the right hand side
14881 (domain) of the &'Message-ID:'& header that Exim creates if a
14882 locally-originated incoming message does not have one. &"Locally-originated"&
14883 means &"not received over TCP/IP."&
14884 Otherwise, the primary host name is used.
14885 Only letters, digits, dot and hyphen are accepted; any other characters are
14886 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14887 empty string, the option is ignored.
14888
14889
14890 .option message_id_header_text main string&!! unset
14891 If this variable is set, the string is expanded and used to augment the text of
14892 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14893 message does not have one. The text of this header is required by RFC 2822 to
14894 take the form of an address. By default, Exim uses its internal message id as
14895 the local part, and the primary host name as the domain. If this option is set,
14896 it is expanded, and provided the expansion is not forced to fail, and does not
14897 yield an empty string, the result is inserted into the header immediately
14898 before the @, separated from the internal message id by a dot. Any characters
14899 that are illegal in an address are automatically converted into hyphens. This
14900 means that variables such as &$tod_log$& can be used, because the spaces and
14901 colons will become hyphens.
14902
14903
14904 .option message_logs main boolean true
14905 .cindex "message logs" "disabling"
14906 .cindex "log" "message log; disabling"
14907 If this option is turned off, per-message log files are not created in the
14908 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14909 Exim, by reducing the number of files involved in handling a message from a
14910 minimum of four (header spool file, body spool file, delivery journal, and
14911 per-message log) to three. The other major I/O activity is Exim's main log,
14912 which is not affected by this option.
14913
14914
14915 .option message_size_limit main string&!! 50M
14916 .cindex "message" "size limit"
14917 .cindex "limit" "message size"
14918 .cindex "size" "of message, limit"
14919 This option limits the maximum size of message that Exim will process. The
14920 value is expanded for each incoming connection so, for example, it can be made
14921 to depend on the IP address of the remote host for messages arriving via
14922 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14923 optionally followed by K or M.
14924
14925 &*Note*&: This limit cannot be made to depend on a message's sender or any
14926 other properties of an individual message, because it has to be advertised in
14927 the server's response to EHLO. String expansion failure causes a temporary
14928 error. A value of zero means no limit, but its use is not recommended. See also
14929 &%bounce_return_size_limit%&.
14930
14931 Incoming SMTP messages are failed with a 552 error if the limit is
14932 exceeded; locally-generated messages either get a stderr message or a delivery
14933 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14934 an oversized message is logged in both the main and the reject logs. See also
14935 the generic transport option &%message_size_limit%&, which limits the size of
14936 message that an individual transport can process.
14937
14938 If you use a virus-scanner and set this option to to a value larger than the
14939 maximum size that your virus-scanner is configured to support, you may get
14940 failures triggered by large mails.  The right size to configure for the
14941 virus-scanner depends upon what data is passed and the options in use but it's
14942 probably safest to just set it to a little larger than this value.  Eg, with a
14943 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14944 some problems may result.
14945
14946 A value of 0 will disable size limit checking; Exim will still advertise the
14947 SIZE extension in an EHLO response, but without a limit, so as to permit
14948 SMTP clients to still indicate the message size along with the MAIL verb.
14949
14950
14951 .option move_frozen_messages main boolean false
14952 .cindex "frozen messages" "moving"
14953 This option, which is available only if Exim has been built with the setting
14954 .code
14955 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14956 .endd
14957 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14958 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14959 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14960 standard utilities for handling such moved messages, and they do not show up in
14961 lists generated by &%-bp%& or by the Exim monitor.
14962
14963
14964 .option mua_wrapper main boolean false
14965 Setting this option true causes Exim to run in a very restrictive mode in which
14966 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14967 contains a full description of this facility.
14968
14969
14970
14971 .option mysql_servers main "string list" unset
14972 .cindex "MySQL" "server list"
14973 This option provides a list of MySQL servers and associated connection data, to
14974 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14975 option is available only if Exim has been built with MySQL support.
14976
14977
14978 .option never_users main "string list&!!" unset
14979 This option is expanded just once, at the start of Exim's processing. Local
14980 message deliveries are normally run in processes that are setuid to the
14981 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14982 It is usually desirable to prevent any deliveries from running as root, as a
14983 safety precaution.
14984
14985 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14986 list of users that must not be used for local deliveries. This list is fixed in
14987 the binary and cannot be overridden by the configuration file. By default, it
14988 contains just the single user name &"root"&. The &%never_users%& runtime option
14989 can be used to add more users to the fixed list.
14990
14991 If a message is to be delivered as one of the users on the fixed list or the
14992 &%never_users%& list, an error occurs, and delivery is deferred. A common
14993 example is
14994 .code
14995 never_users = root:daemon:bin
14996 .endd
14997 Including root is redundant if it is also on the fixed list, but it does no
14998 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14999 transport driver.
15000
15001
15002 .option openssl_options main "string list" "+no_sslv2"
15003 .cindex "OpenSSL "compatibility options"
15004 This option allows an administrator to adjust the SSL options applied
15005 by OpenSSL to connections.  It is given as a space-separated list of items,
15006 each one to be +added or -subtracted from the current value.
15007
15008 This option is only available if Exim is built against OpenSSL.  The values
15009 available for this option vary according to the age of your OpenSSL install.
15010 The &"all"& value controls a subset of flags which are available, typically
15011 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15012 list the values known on your system and Exim should support all the
15013 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15014 names lose the leading &"SSL_OP_"& and are lower-cased.
15015
15016 Note that adjusting the options can have severe impact upon the security of
15017 SSL as used by Exim.  It is possible to disable safety checks and shoot
15018 yourself in the foot in various unpleasant ways.  This option should not be
15019 adjusted lightly.  An unrecognised item will be detected at startup, by
15020 invoking Exim with the &%-bV%& flag.
15021
15022 Historical note: prior to release 4.80, Exim defaulted this value to
15023 "+dont_insert_empty_fragments", which may still be needed for compatibility
15024 with some clients, but which lowers security by increasing exposure to
15025 some now infamous attacks.
15026
15027 An example:
15028 .code
15029 # Make both old MS and old Eudora happy:
15030 openssl_options = -all +microsoft_big_sslv3_buffer \
15031                        +dont_insert_empty_fragments
15032 .endd
15033
15034 Possible options may include:
15035 .ilist
15036 &`all`&
15037 .next
15038 &`allow_unsafe_legacy_renegotiation`&
15039 .next
15040 &`cipher_server_preference`&
15041 .next
15042 &`dont_insert_empty_fragments`&
15043 .next
15044 &`ephemeral_rsa`&
15045 .next
15046 &`legacy_server_connect`&
15047 .next
15048 &`microsoft_big_sslv3_buffer`&
15049 .next
15050 &`microsoft_sess_id_bug`&
15051 .next
15052 &`msie_sslv2_rsa_padding`&
15053 .next
15054 &`netscape_challenge_bug`&
15055 .next
15056 &`netscape_reuse_cipher_change_bug`&
15057 .next
15058 &`no_compression`&
15059 .next
15060 &`no_session_resumption_on_renegotiation`&
15061 .next
15062 &`no_sslv2`&
15063 .next
15064 &`no_sslv3`&
15065 .next
15066 &`no_ticket`&
15067 .next
15068 &`no_tlsv1`&
15069 .next
15070 &`no_tlsv1_1`&
15071 .next
15072 &`no_tlsv1_2`&
15073 .next
15074 &`safari_ecdhe_ecdsa_bug`&
15075 .next
15076 &`single_dh_use`&
15077 .next
15078 &`single_ecdh_use`&
15079 .next
15080 &`ssleay_080_client_dh_bug`&
15081 .next
15082 &`sslref2_reuse_cert_type_bug`&
15083 .next
15084 &`tls_block_padding_bug`&
15085 .next
15086 &`tls_d5_bug`&
15087 .next
15088 &`tls_rollback_bug`&
15089 .endlist
15090
15091 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15092 all clients connecting using the MacOS SecureTransport TLS facility prior
15093 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15094 to negotiate TLS then this option value might help, provided that your OpenSSL
15095 release is new enough to contain this work-around.  This may be a situation
15096 where you have to upgrade OpenSSL to get buggy clients working.
15097
15098
15099 .option oracle_servers main "string list" unset
15100 .cindex "Oracle" "server list"
15101 This option provides a list of Oracle servers and associated connection data,
15102 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15103 The option is available only if Exim has been built with Oracle support.
15104
15105
15106 .option percent_hack_domains main "domain list&!!" unset
15107 .cindex "&""percent hack""&"
15108 .cindex "source routing" "in email address"
15109 .cindex "address" "source-routed"
15110 The &"percent hack"& is the convention whereby a local part containing a
15111 percent sign is re-interpreted as a new email address, with the percent
15112 replaced by @. This is sometimes called &"source routing"&, though that term is
15113 also applied to RFC 2822 addresses that begin with an @ character. If this
15114 option is set, Exim implements the percent facility for those domains listed,
15115 but no others. This happens before an incoming SMTP address is tested against
15116 an ACL.
15117
15118 &*Warning*&: The &"percent hack"& has often been abused by people who are
15119 trying to get round relaying restrictions. For this reason, it is best avoided
15120 if at all possible. Unfortunately, a number of less security-conscious MTAs
15121 implement it unconditionally. If you are running Exim on a gateway host, and
15122 routing mail through to internal MTAs without processing the local parts, it is
15123 a good idea to reject recipient addresses with percent characters in their
15124 local parts. Exim's default configuration does this.
15125
15126
15127 .option perl_at_start main boolean false
15128 This option is available only when Exim is built with an embedded Perl
15129 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15130
15131
15132 .option perl_startup main string unset
15133 This option is available only when Exim is built with an embedded Perl
15134 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15135
15136
15137 .option pgsql_servers main "string list" unset
15138 .cindex "PostgreSQL lookup type" "server list"
15139 This option provides a list of PostgreSQL servers and associated connection
15140 data, to be used in conjunction with &(pgsql)& lookups (see section
15141 &<<SECID72>>&). The option is available only if Exim has been built with
15142 PostgreSQL support.
15143
15144
15145 .option pid_file_path main string&!! "set at compile time"
15146 .cindex "daemon" "pid file path"
15147 .cindex "pid file, path for"
15148 This option sets the name of the file to which the Exim daemon writes its
15149 process id. The string is expanded, so it can contain, for example, references
15150 to the host name:
15151 .code
15152 pid_file_path = /var/log/$primary_hostname/exim.pid
15153 .endd
15154 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15155 spool directory.
15156 The value set by the option can be overridden by the &%-oP%& command line
15157 option. A pid file is not written if a &"non-standard"& daemon is run by means
15158 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15159
15160
15161 .option pipelining_advertise_hosts main "host list&!!" *
15162 .cindex "PIPELINING" "suppressing advertising"
15163 This option can be used to suppress the advertisement of the SMTP
15164 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15165 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15166 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15167 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15168 that clients will use it; &"out of order"& commands that are &"expected"& do
15169 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15170
15171
15172 .option prdr_enable main boolean false
15173 .cindex "PRDR" "enabling on server"
15174 This option can be used to enable the Per-Recipient Data Response extension
15175 to SMTP, defined by Eric Hall.
15176 If the option is set, PRDR is advertised by Exim when operating as a server.
15177 If the client requests PRDR, and more than one recipient, for a message 
15178 an additional ACL is called for each recipient after the message content
15179 is recieved.  See section &<<SECTPRDRACL>>&.
15180
15181 .option preserve_message_logs main boolean false
15182 .cindex "message logs" "preserving"
15183 If this option is set, message log files are not deleted when messages are
15184 completed. Instead, they are moved to a sub-directory of the spool directory
15185 called &_msglog.OLD_&, where they remain available for statistical or debugging
15186 purposes. This is a dangerous option to set on systems with any appreciable
15187 volume of mail. Use with care!
15188
15189
15190 .option primary_hostname main string "see below"
15191 .cindex "name" "of local host"
15192 .cindex "host" "name of local"
15193 .cindex "local host" "name of"
15194 .vindex "&$primary_hostname$&"
15195 This specifies the name of the current host. It is used in the default EHLO or
15196 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15197 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15198 The value is also used by default in some SMTP response messages from an Exim
15199 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15200
15201 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15202 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15203 contains only one component, Exim passes it to &[gethostbyname()]& (or
15204 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15205 version. The variable &$primary_hostname$& contains the host name, whether set
15206 explicitly by this option, or defaulted.
15207
15208
15209 .option print_topbitchars main boolean false
15210 .cindex "printing characters"
15211 .cindex "8-bit characters"
15212 By default, Exim considers only those characters whose codes lie in the range
15213 32&--126 to be printing characters. In a number of circumstances (for example,
15214 when writing log entries) non-printing characters are converted into escape
15215 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15216 is set, code values of 128 and above are also considered to be printing
15217 characters.
15218
15219 This option also affects the header syntax checks performed by the
15220 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15221 the user's full name when constructing From: and Sender: addresses (as
15222 described in section &<<SECTconstr>>&). Setting this option can cause
15223 Exim to generate eight bit message headers that do not conform to the
15224 standards.
15225
15226
15227 .option process_log_path main string unset
15228 .cindex "process log path"
15229 .cindex "log" "process log"
15230 .cindex "&'exiwhat'&"
15231 This option sets the name of the file to which an Exim process writes its
15232 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15233 utility script. If this option is unset, the file called &_exim-process.info_&
15234 in Exim's spool directory is used. The ability to specify the name explicitly
15235 can be useful in environments where two different Exims are running, using
15236 different spool directories.
15237
15238
15239 .option prod_requires_admin main boolean true
15240 .oindex "&%-M%&"
15241 .oindex "&%-R%&"
15242 .oindex "&%-q%&"
15243 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15244 admin user unless &%prod_requires_admin%& is set false. See also
15245 &%queue_list_requires_admin%&.
15246
15247
15248 .option qualify_domain main string "see below"
15249 .cindex "domain" "for qualifying addresses"
15250 .cindex "address" "qualification"
15251 This option specifies the domain name that is added to any envelope sender
15252 addresses that do not have a domain qualification. It also applies to
15253 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15254 are accepted by default only for locally-generated messages. Qualification is
15255 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15256 locally-generated messages, unless the &%-bnq%& command line option is used.
15257
15258 Messages from external sources must always contain fully qualified addresses,
15259 unless the sending host matches &%sender_unqualified_hosts%& or
15260 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15261 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15262 necessary. Internally, Exim always works with fully qualified envelope
15263 addresses. If &%qualify_domain%& is not set, it defaults to the
15264 &%primary_hostname%& value.
15265
15266
15267 .option qualify_recipient main string "see below"
15268 This option allows you to specify a different domain for qualifying recipient
15269 addresses to the one that is used for senders. See &%qualify_domain%& above.
15270
15271
15272
15273 .option queue_domains main "domain list&!!" unset
15274 .cindex "domain" "specifying non-immediate delivery"
15275 .cindex "queueing incoming messages"
15276 .cindex "message" "queueing certain domains"
15277 This option lists domains for which immediate delivery is not required.
15278 A delivery process is started whenever a message is received, but only those
15279 domains that do not match are processed. All other deliveries wait until the
15280 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15281
15282
15283 .option queue_list_requires_admin main boolean true
15284 .oindex "&%-bp%&"
15285 The &%-bp%& command-line option, which lists the messages that are on the
15286 queue, requires the caller to be an admin user unless
15287 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15288
15289
15290 .option queue_only main boolean false
15291 .cindex "queueing incoming messages"
15292 .cindex "message" "queueing unconditionally"
15293 If &%queue_only%& is set, a delivery process is not automatically started
15294 whenever a message is received. Instead, the message waits on the queue for the
15295 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15296 delivered immediately when certain conditions (such as heavy load) occur.
15297
15298 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15299 and &%-odi%& command line options override &%queue_only%& unless
15300 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15301 &%queue_only_load%&, and &%smtp_accept_queue%&.
15302
15303
15304 .option queue_only_file main string unset
15305 .cindex "queueing incoming messages"
15306 .cindex "message" "queueing by file existence"
15307 This option can be set to a colon-separated list of absolute path names, each
15308 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15309 it tests for the existence of each listed path using a call to &[stat()]&. For
15310 each path that exists, the corresponding queueing option is set.
15311 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15312 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15313 .code
15314 queue_only_file = smtp/some/file
15315 .endd
15316 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15317 &_/some/file_& exists.
15318
15319
15320 .option queue_only_load main fixed-point unset
15321 .cindex "load average"
15322 .cindex "queueing incoming messages"
15323 .cindex "message" "queueing by load"
15324 If the system load average is higher than this value, incoming messages from
15325 all sources are queued, and no automatic deliveries are started. If this
15326 happens during local or remote SMTP input, all subsequent messages received on
15327 the same SMTP connection are queued by default, whatever happens to the load in
15328 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15329 false.
15330
15331 Deliveries will subsequently be performed by queue runner processes. This
15332 option has no effect on ancient operating systems on which Exim cannot
15333 determine the load average. See also &%deliver_queue_load_max%& and
15334 &%smtp_load_reserve%&.
15335
15336
15337 .option queue_only_load_latch main boolean true
15338 .cindex "load average" "re-evaluating per message"
15339 When this option is true (the default), once one message has been queued
15340 because the load average is higher than the value set by &%queue_only_load%&,
15341 all subsequent messages received on the same SMTP connection are also queued.
15342 This is a deliberate choice; even though the load average may fall below the
15343 threshold, it doesn't seem right to deliver later messages on the same
15344 connection when not delivering earlier ones. However, there are special
15345 circumstances such as very long-lived connections from scanning appliances
15346 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15347 should be set false. This causes the value of the load average to be
15348 re-evaluated for each message.
15349
15350
15351 .option queue_only_override main boolean true
15352 .cindex "queueing incoming messages"
15353 When this option is true, the &%-od%&&'x'& command line options override the
15354 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15355 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15356 to override; they are accepted, but ignored.
15357
15358
15359 .option queue_run_in_order main boolean false
15360 .cindex "queue runner" "processing messages in order"
15361 If this option is set, queue runs happen in order of message arrival instead of
15362 in an arbitrary order. For this to happen, a complete list of the entire queue
15363 must be set up before the deliveries start. When the queue is all held in a
15364 single directory (the default), a single list is created for both the ordered
15365 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15366 single list is not created when &%queue_run_in_order%& is false. In this case,
15367 the sub-directories are processed one at a time (in a random order), and this
15368 avoids setting up one huge list for the whole queue. Thus, setting
15369 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15370 when the queue is large, because of the extra work in setting up the single,
15371 large list. In most situations, &%queue_run_in_order%& should not be set.
15372
15373
15374
15375 .option queue_run_max main integer 5
15376 .cindex "queue runner" "maximum number of"
15377 This controls the maximum number of queue runner processes that an Exim daemon
15378 can run simultaneously. This does not mean that it starts them all at once,
15379 but rather that if the maximum number are still running when the time comes to
15380 start another one, it refrains from starting another one. This can happen with
15381 very large queues and/or very sluggish deliveries. This option does not,
15382 however, interlock with other processes, so additional queue runners can be
15383 started by other means, or by killing and restarting the daemon.
15384
15385 Setting this option to zero does not suppress queue runs; rather, it disables
15386 the limit, allowing any number of simultaneous queue runner processes to be
15387 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15388 the daemon's command line.
15389
15390 .option queue_smtp_domains main "domain list&!!" unset
15391 .cindex "queueing incoming messages"
15392 .cindex "message" "queueing remote deliveries"
15393 When this option is set, a delivery process is started whenever a message is
15394 received, routing is performed, and local deliveries take place.
15395 However, if any SMTP deliveries are required for domains that match
15396 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15397 message waits on the queue for the next queue run. Since routing of the message
15398 has taken place, Exim knows to which remote hosts it must be delivered, and so
15399 when the queue run happens, multiple messages for the same host are delivered
15400 over a single SMTP connection. The &%-odqs%& command line option causes all
15401 SMTP deliveries to be queued in this way, and is equivalent to setting
15402 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15403 &%queue_domains%&.
15404
15405
15406 .option receive_timeout main time 0s
15407 .cindex "timeout" "for non-SMTP input"
15408 This option sets the timeout for accepting a non-SMTP message, that is, the
15409 maximum time that Exim waits when reading a message on the standard input. If
15410 the value is zero, it will wait for ever. This setting is overridden by the
15411 &%-or%& command line option. The timeout for incoming SMTP messages is
15412 controlled by &%smtp_receive_timeout%&.
15413
15414 .option received_header_text main string&!! "see below"
15415 .cindex "customizing" "&'Received:'& header"
15416 .cindex "&'Received:'& header line" "customizing"
15417 This string defines the contents of the &'Received:'& message header that is
15418 added to each message, except for the timestamp, which is automatically added
15419 on at the end (preceded by a semicolon). The string is expanded each time it is
15420 used. If the expansion yields an empty string, no &'Received:'& header line is
15421 added to the message. Otherwise, the string should start with the text
15422 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15423 header lines. The default setting is:
15424
15425 .code
15426 received_header_text = Received: \
15427   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15428   {${if def:sender_ident \
15429   {from ${quote_local_part:$sender_ident} }}\
15430   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15431   by $primary_hostname \
15432   ${if def:received_protocol {with $received_protocol}} \
15433   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15434   (Exim $version_number)\n\t\
15435   ${if def:sender_address \
15436   {(envelope-from <$sender_address>)\n\t}}\
15437   id $message_exim_id\
15438   ${if def:received_for {\n\tfor $received_for}}
15439 .endd
15440
15441 The reference to the TLS cipher is omitted when Exim is built without TLS
15442 support. The use of conditional expansions ensures that this works for both
15443 locally generated messages and messages received from remote hosts, giving
15444 header lines such as the following:
15445 .code
15446 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15447 by marley.carol.example with esmtp (Exim 4.00)
15448 (envelope-from <bob@carol.example>)
15449 id 16IOWa-00019l-00
15450 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15451 Received: by scrooge.carol.example with local (Exim 4.00)
15452 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15453 .endd
15454 Until the body of the message has been received, the timestamp is the time when
15455 the message started to be received. Once the body has arrived, and all policy
15456 checks have taken place, the timestamp is updated to the time at which the
15457 message was accepted.
15458
15459
15460 .option received_headers_max main integer 30
15461 .cindex "loop" "prevention"
15462 .cindex "mail loop prevention"
15463 .cindex "&'Received:'& header line" "counting"
15464 When a message is to be delivered, the number of &'Received:'& headers is
15465 counted, and if it is greater than this parameter, a mail loop is assumed to
15466 have occurred, the delivery is abandoned, and an error message is generated.
15467 This applies to both local and remote deliveries.
15468
15469
15470 .option recipient_unqualified_hosts main "host list&!!" unset
15471 .cindex "unqualified addresses"
15472 .cindex "host" "unqualified addresses from"
15473 This option lists those hosts from which Exim is prepared to accept unqualified
15474 recipient addresses in message envelopes. The addresses are made fully
15475 qualified by the addition of the &%qualify_recipient%& value. This option also
15476 affects message header lines. Exim does not reject unqualified recipient
15477 addresses in headers, but it qualifies them only if the message came from a
15478 host that matches &%recipient_unqualified_hosts%&,
15479 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15480 option was not set.
15481
15482
15483 .option recipients_max main integer 0
15484 .cindex "limit" "number of recipients"
15485 .cindex "recipient" "maximum number"
15486 If this option is set greater than zero, it specifies the maximum number of
15487 original recipients for any message. Additional recipients that are generated
15488 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15489 all recipients over the limit; earlier recipients are delivered as normal.
15490 Non-SMTP messages with too many recipients are failed, and no deliveries are
15491 done.
15492
15493 .cindex "RCPT" "maximum number of incoming"
15494 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15495 RCPT commands in a single message.
15496
15497
15498 .option recipients_max_reject main boolean false
15499 If this option is set true, Exim rejects SMTP messages containing too many
15500 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15501 error to the eventual DATA command. Otherwise (the default) it gives a 452
15502 error to the surplus RCPT commands and accepts the message on behalf of the
15503 initial set of recipients. The remote server should then re-send the message
15504 for the remaining recipients at a later time.
15505
15506
15507 .option remote_max_parallel main integer 2
15508 .cindex "delivery" "parallelism for remote"
15509 This option controls parallel delivery of one message to a number of remote
15510 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15511 does all the remote deliveries for a message one by one. Otherwise, if a single
15512 message has to be delivered to more than one remote host, or if several copies
15513 have to be sent to the same remote host, up to &%remote_max_parallel%&
15514 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15515 deliveries are required, the maximum number of processes are started, and as
15516 each one finishes, another is begun. The order of starting processes is the
15517 same as if sequential delivery were being done, and can be controlled by the
15518 &%remote_sort_domains%& option. If parallel delivery takes place while running
15519 with debugging turned on, the debugging output from each delivery process is
15520 tagged with its process id.
15521
15522 This option controls only the maximum number of parallel deliveries for one
15523 message in one Exim delivery process. Because Exim has no central queue
15524 manager, there is no way of controlling the total number of simultaneous
15525 deliveries if the configuration allows a delivery attempt as soon as a message
15526 is received.
15527
15528 .cindex "number of deliveries"
15529 .cindex "delivery" "maximum number of"
15530 If you want to control the total number of deliveries on the system, you
15531 need to set the &%queue_only%& option. This ensures that all incoming messages
15532 are added to the queue without starting a delivery process. Then set up an Exim
15533 daemon to start queue runner processes at appropriate intervals (probably
15534 fairly often, for example, every minute), and limit the total number of queue
15535 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15536 delivers only one message at a time, the maximum number of deliveries that can
15537 then take place at once is &%queue_run_max%& multiplied by
15538 &%remote_max_parallel%&.
15539
15540 If it is purely remote deliveries you want to control, use
15541 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15542 doing the SMTP routing before queueing, so that several messages for the same
15543 host will eventually get delivered down the same connection.
15544
15545
15546 .option remote_sort_domains main "domain list&!!" unset
15547 .cindex "sorting remote deliveries"
15548 .cindex "delivery" "sorting remote"
15549 When there are a number of remote deliveries for a message, they are sorted by
15550 domain into the order given by this list. For example,
15551 .code
15552 remote_sort_domains = *.cam.ac.uk:*.uk
15553 .endd
15554 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15555 then to those in the &%uk%& domain, then to any others.
15556
15557
15558 .option retry_data_expire main time 7d
15559 .cindex "hints database" "data expiry"
15560 This option sets a &"use before"& time on retry information in Exim's hints
15561 database. Any older retry data is ignored. This means that, for example, once a
15562 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15563 past failures.
15564
15565
15566 .option retry_interval_max main time 24h
15567 .cindex "retry" "limit on interval"
15568 .cindex "limit" "on retry interval"
15569 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15570 intervals between delivery attempts for messages that cannot be delivered
15571 straight away. This option sets an overall limit to the length of time between
15572 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15573 the default value.
15574
15575
15576 .option return_path_remove main boolean true
15577 .cindex "&'Return-path:'& header line" "removing"
15578 RFC 2821, section 4.4, states that an SMTP server must insert a
15579 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15580 The &'Return-path:'& header preserves the sender address as received in the
15581 MAIL command. This description implies that this header should not be present
15582 in an incoming message. If &%return_path_remove%& is true, any existing
15583 &'Return-path:'& headers are removed from messages at the time they are
15584 received. Exim's transports have options for adding &'Return-path:'& headers at
15585 the time of delivery. They are normally used only for final local deliveries.
15586
15587
15588 .option return_size_limit main integer 100K
15589 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15590
15591
15592 .option rfc1413_hosts main "host list&!!" *
15593 .cindex "RFC 1413"
15594 .cindex "host" "for RFC 1413 calls"
15595 RFC 1413 identification calls are made to any client host which matches an item
15596 in the list.
15597
15598 .option rfc1413_query_timeout main time 5s
15599 .cindex "RFC 1413" "query timeout"
15600 .cindex "timeout" "for RFC 1413 call"
15601 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15602 no RFC 1413 calls are ever made.
15603
15604
15605 .option sender_unqualified_hosts main "host list&!!" unset
15606 .cindex "unqualified addresses"
15607 .cindex "host" "unqualified addresses from"
15608 This option lists those hosts from which Exim is prepared to accept unqualified
15609 sender addresses. The addresses are made fully qualified by the addition of
15610 &%qualify_domain%&. This option also affects message header lines. Exim does
15611 not reject unqualified addresses in headers that contain sender addresses, but
15612 it qualifies them only if the message came from a host that matches
15613 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15614 using TCP/IP), and the &%-bnq%& option was not set.
15615
15616
15617 .option smtp_accept_keepalive main boolean true
15618 .cindex "keepalive" "on incoming connection"
15619 This option controls the setting of the SO_KEEPALIVE option on incoming
15620 TCP/IP socket connections. When set, it causes the kernel to probe idle
15621 connections periodically, by sending packets with &"old"& sequence numbers. The
15622 other end of the connection should send an acknowledgment if the connection is
15623 still okay or a reset if the connection has been aborted. The reason for doing
15624 this is that it has the beneficial effect of freeing up certain types of
15625 connection that can get stuck when the remote host is disconnected without
15626 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15627 hours to detect unreachable hosts.
15628
15629
15630
15631 .option smtp_accept_max main integer 20
15632 .cindex "limit" "incoming SMTP connections"
15633 .cindex "SMTP" "incoming connection count"
15634 .cindex "inetd"
15635 This option specifies the maximum number of simultaneous incoming SMTP calls
15636 that Exim will accept. It applies only to the listening daemon; there is no
15637 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15638 value is set to zero, no limit is applied. However, it is required to be
15639 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15640 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15641
15642 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15643 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15644 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15645 and &%smtp_load_reserve%& are then checked before accepting the connection.
15646
15647
15648 .option smtp_accept_max_nonmail main integer 10
15649 .cindex "limit" "non-mail SMTP commands"
15650 .cindex "SMTP" "limiting non-mail commands"
15651 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15652 the connection if there are too many. This option defines &"too many"&. The
15653 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15654 client looping sending EHLO, for example. The check is applied only if the
15655 client host matches &%smtp_accept_max_nonmail_hosts%&.
15656
15657 When a new message is expected, one occurrence of RSET is not counted. This
15658 allows a client to send one RSET between messages (this is not necessary,
15659 but some clients do it). Exim also allows one uncounted occurrence of HELO
15660 or EHLO, and one occurrence of STARTTLS between messages. After
15661 starting up a TLS session, another EHLO is expected, and so it too is not
15662 counted. The first occurrence of AUTH in a connection, or immediately
15663 following STARTTLS is not counted. Otherwise, all commands other than
15664 MAIL, RCPT, DATA, and QUIT are counted.
15665
15666
15667 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15668 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15669 check by setting this option. The default value makes it apply to all hosts. By
15670 changing the value, you can exclude any badly-behaved hosts that you have to
15671 live with.
15672
15673
15674 . Allow this long option name to split; give it unsplit as a fifth argument
15675 . for the automatic .oindex that is generated by .option.
15676 . We insert " &~&~" which is both pretty nasty visually and results in
15677 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15678 . zero-width-space, which would be nicer visually and results in (at least)
15679 . html that Firefox will split on when it's forced to reflow (rather than
15680 . inserting a horizontal scrollbar).  However, the text is still not
15681 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15682 . the option name to split.
15683
15684 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15685          smtp_accept_max_per_connection
15686 .cindex "SMTP" "limiting incoming message count"
15687 .cindex "limit" "messages per SMTP connection"
15688 The value of this option limits the number of MAIL commands that Exim is
15689 prepared to accept over a single SMTP connection, whether or not each command
15690 results in the transfer of a message. After the limit is reached, a 421
15691 response is given to subsequent MAIL commands. This limit is a safety
15692 precaution against a client that goes mad (incidents of this type have been
15693 seen).
15694
15695
15696 .option smtp_accept_max_per_host main string&!! unset
15697 .cindex "limit" "SMTP connections from one host"
15698 .cindex "host" "limiting SMTP connections from"
15699 This option restricts the number of simultaneous IP connections from a single
15700 host (strictly, from a single IP address) to the Exim daemon. The option is
15701 expanded, to enable different limits to be applied to different hosts by
15702 reference to &$sender_host_address$&. Once the limit is reached, additional
15703 connection attempts from the same host are rejected with error code 421. This
15704 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15705 of zero imposes no limit. If this option is set greater than zero, it is
15706 required that &%smtp_accept_max%& be non-zero.
15707
15708 &*Warning*&: When setting this option you should not use any expansion
15709 constructions that take an appreciable amount of time. The expansion and test
15710 happen in the main daemon loop, in order to reject additional connections
15711 without forking additional processes (otherwise a denial-of-service attack
15712 could cause a vast number or processes to be created). While the daemon is
15713 doing this processing, it cannot accept any other incoming connections.
15714
15715
15716
15717 .option smtp_accept_queue main integer 0
15718 .cindex "SMTP" "incoming connection count"
15719 .cindex "queueing incoming messages"
15720 .cindex "message" "queueing by SMTP connection count"
15721 If the number of simultaneous incoming SMTP connections being handled via the
15722 listening daemon exceeds this value, messages received by SMTP are just placed
15723 on the queue; no delivery processes are started automatically. The count is
15724 fixed at the start of an SMTP connection. It cannot be updated in the
15725 subprocess that receives messages, and so the queueing or not queueing applies
15726 to all messages received in the same connection.
15727
15728 A value of zero implies no limit, and clearly any non-zero value is useful only
15729 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15730 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15731 various &%-od%&&'x'& command line options.
15732
15733
15734 . See the comment on smtp_accept_max_per_connection
15735
15736 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15737          smtp_accept_queue_per_connection
15738 .cindex "queueing incoming messages"
15739 .cindex "message" "queueing by message count"
15740 This option limits the number of delivery processes that Exim starts
15741 automatically when receiving messages via SMTP, whether via the daemon or by
15742 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15743 and the number of messages received in a single SMTP session exceeds this
15744 number, subsequent messages are placed on the queue, but no delivery processes
15745 are started. This helps to limit the number of Exim processes when a server
15746 restarts after downtime and there is a lot of mail waiting for it on other
15747 systems. On large systems, the default should probably be increased, and on
15748 dial-in client systems it should probably be set to zero (that is, disabled).
15749
15750
15751 .option smtp_accept_reserve main integer 0
15752 .cindex "SMTP" "incoming call count"
15753 .cindex "host" "reserved"
15754 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15755 number of SMTP connections that are reserved for connections from the hosts
15756 that are specified in &%smtp_reserve_hosts%&. The value set in
15757 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15758 restricted to this number of connections; the option specifies a minimum number
15759 of connection slots for them, not a maximum. It is a guarantee that this group
15760 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15761 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15762 individual host.
15763
15764 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15765 set to 5, once there are 45 active connections (from any hosts), new
15766 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15767 provided the other criteria for acceptance are met.
15768
15769
15770 .option smtp_active_hostname main string&!! unset
15771 .cindex "host" "name in SMTP responses"
15772 .cindex "SMTP" "host name in responses"
15773 .vindex "&$primary_hostname$&"
15774 This option is provided for multi-homed servers that want to masquerade as
15775 several different hosts. At the start of an incoming SMTP connection, its value
15776 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15777 responses. For example, it is used as domain name in the response to an
15778 incoming HELO or EHLO command.
15779
15780 .vindex "&$smtp_active_hostname$&"
15781 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15782 is saved with any messages that are received. It is therefore available for use
15783 in routers and transports when the message is later delivered.
15784
15785 If this option is unset, or if its expansion is forced to fail, or if the
15786 expansion results in an empty string, the value of &$primary_hostname$& is
15787 used. Other expansion failures cause a message to be written to the main and
15788 panic logs, and the SMTP command receives a temporary error. Typically, the
15789 value of &%smtp_active_hostname%& depends on the incoming interface address.
15790 For example:
15791 .code
15792 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15793   {cox.mydomain}{box.mydomain}}
15794 .endd
15795
15796 Although &$smtp_active_hostname$& is primarily concerned with incoming
15797 messages, it is also used as the default for HELO commands in callout
15798 verification if there is no remote transport from which to obtain a
15799 &%helo_data%& value.
15800
15801 .option smtp_banner main string&!! "see below"
15802 .cindex "SMTP" "welcome banner"
15803 .cindex "banner for SMTP"
15804 .cindex "welcome banner for SMTP"
15805 .cindex "customizing" "SMTP banner"
15806 This string, which is expanded every time it is used, is output as the initial
15807 positive response to an SMTP connection. The default setting is:
15808 .code
15809 smtp_banner = $smtp_active_hostname ESMTP Exim \
15810   $version_number $tod_full
15811 .endd
15812 Failure to expand the string causes a panic error. If you want to create a
15813 multiline response to the initial SMTP connection, use &"\n"& in the string at
15814 appropriate points, but not at the end. Note that the 220 code is not included
15815 in this string. Exim adds it automatically (several times in the case of a
15816 multiline response).
15817
15818
15819 .option smtp_check_spool_space main boolean true
15820 .cindex "checking disk space"
15821 .cindex "disk space, checking"
15822 .cindex "spool directory" "checking space"
15823 When this option is set, if an incoming SMTP session encounters the SIZE
15824 option on a MAIL command, it checks that there is enough space in the
15825 spool directory's partition to accept a message of that size, while still
15826 leaving free the amount specified by &%check_spool_space%& (even if that value
15827 is zero). If there isn't enough space, a temporary error code is returned.
15828
15829
15830 .option smtp_connect_backlog main integer 20
15831 .cindex "connection backlog"
15832 .cindex "SMTP" "connection backlog"
15833 .cindex "backlog of connections"
15834 This option specifies a maximum number of waiting SMTP connections. Exim passes
15835 this value to the TCP/IP system when it sets up its listener. Once this number
15836 of connections are waiting for the daemon's attention, subsequent connection
15837 attempts are refused at the TCP/IP level. At least, that is what the manuals
15838 say; in some circumstances such connection attempts have been observed to time
15839 out instead. For large systems it is probably a good idea to increase the
15840 value (to 50, say). It also gives some protection against denial-of-service
15841 attacks by SYN flooding.
15842
15843
15844 .option smtp_enforce_sync main boolean true
15845 .cindex "SMTP" "synchronization checking"
15846 .cindex "synchronization checking in SMTP"
15847 The SMTP protocol specification requires the client to wait for a response from
15848 the server at certain points in the dialogue. Without PIPELINING these
15849 synchronization points are after every command; with PIPELINING they are
15850 fewer, but they still exist.
15851
15852 Some spamming sites send out a complete set of SMTP commands without waiting
15853 for any response. Exim protects against this by rejecting a message if the
15854 client has sent further input when it should not have. The error response &"554
15855 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15856 for this error cannot be perfect because of transmission delays (unexpected
15857 input may be on its way but not yet received when Exim checks). However, it
15858 does detect many instances.
15859
15860 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15861 If you want to disable the check selectively (for example, only for certain
15862 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15863 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15864
15865
15866
15867 .option smtp_etrn_command main string&!! unset
15868 .cindex "ETRN" "command to be run"
15869 .vindex "&$domain$&"
15870 If this option is set, the given command is run whenever an SMTP ETRN
15871 command is received from a host that is permitted to issue such commands (see
15872 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15873 are independently expanded. The expansion variable &$domain$& is set to the
15874 argument of the ETRN command, and no syntax checking is done on it. For
15875 example:
15876 .code
15877 smtp_etrn_command = /etc/etrn_command $domain \
15878                     $sender_host_address
15879 .endd
15880 A new process is created to run the command, but Exim does not wait for it to
15881 complete. Consequently, its status cannot be checked. If the command cannot be
15882 run, a line is written to the panic log, but the ETRN caller still receives
15883 a 250 success response. Exim is normally running under its own uid when
15884 receiving SMTP, so it is not possible for it to change the uid before running
15885 the command.
15886
15887
15888 .option smtp_etrn_serialize main boolean true
15889 .cindex "ETRN" "serializing"
15890 When this option is set, it prevents the simultaneous execution of more than
15891 one identical command as a result of ETRN in an SMTP connection. See
15892 section &<<SECTETRN>>& for details.
15893
15894
15895 .option smtp_load_reserve main fixed-point unset
15896 .cindex "load average"
15897 If the system load average ever gets higher than this, incoming SMTP calls are
15898 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15899 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15900 the load is over the limit. The option has no effect on ancient operating
15901 systems on which Exim cannot determine the load average. See also
15902 &%deliver_queue_load_max%& and &%queue_only_load%&.
15903
15904
15905
15906 .option smtp_max_synprot_errors main integer 3
15907 .cindex "SMTP" "limiting syntax and protocol errors"
15908 .cindex "limit" "SMTP syntax and protocol errors"
15909 Exim rejects SMTP commands that contain syntax or protocol errors. In
15910 particular, a syntactically invalid email address, as in this command:
15911 .code
15912 RCPT TO:<abc xyz@a.b.c>
15913 .endd
15914 causes immediate rejection of the command, before any other tests are done.
15915 (The ACL cannot be run if there is no valid address to set up for it.) An
15916 example of a protocol error is receiving RCPT before MAIL. If there are
15917 too many syntax or protocol errors in one SMTP session, the connection is
15918 dropped. The limit is set by this option.
15919
15920 .cindex "PIPELINING" "expected errors"
15921 When the PIPELINING extension to SMTP is in use, some protocol errors are
15922 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15923 Exim assumes that PIPELINING will be used if it advertises it (see
15924 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15925 not count towards the limit.
15926
15927
15928
15929 .option smtp_max_unknown_commands main integer 3
15930 .cindex "SMTP" "limiting unknown commands"
15931 .cindex "limit" "unknown SMTP commands"
15932 If there are too many unrecognized commands in an incoming SMTP session, an
15933 Exim server drops the connection. This is a defence against some kinds of abuse
15934 that subvert web
15935 clients
15936 into making connections to SMTP ports; in these circumstances, a number of
15937 non-SMTP command lines are sent first.
15938
15939
15940
15941 .option smtp_ratelimit_hosts main "host list&!!" unset
15942 .cindex "SMTP" "rate limiting"
15943 .cindex "limit" "rate of message arrival"
15944 .cindex "RCPT" "rate limiting"
15945 Some sites find it helpful to be able to limit the rate at which certain hosts
15946 can send them messages, and the rate at which an individual message can specify
15947 recipients.
15948
15949 Exim has two rate-limiting facilities. This section describes the older
15950 facility, which can limit rates within a single connection. The newer
15951 &%ratelimit%& ACL condition can limit rates across all connections. See section
15952 &<<SECTratelimiting>>& for details of the newer facility.
15953
15954 When a host matches &%smtp_ratelimit_hosts%&, the values of
15955 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15956 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15957 respectively. Each option, if set, must contain a set of four comma-separated
15958 values:
15959
15960 .ilist
15961 A threshold, before which there is no rate limiting.
15962 .next
15963 An initial time delay. Unlike other times in Exim, numbers with decimal
15964 fractional parts are allowed here.
15965 .next
15966 A factor by which to increase the delay each time.
15967 .next
15968 A maximum value for the delay. This should normally be less than 5 minutes,
15969 because after that time, the client is liable to timeout the SMTP command.
15970 .endlist
15971
15972 For example, these settings have been used successfully at the site which
15973 first suggested this feature, for controlling mail from their customers:
15974 .code
15975 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15976 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15977 .endd
15978 The first setting specifies delays that are applied to MAIL commands after
15979 two have been received over a single connection. The initial delay is 0.5
15980 seconds, increasing by a factor of 1.05 each time. The second setting applies
15981 delays to RCPT commands when more than four occur in a single message.
15982
15983
15984 .option smtp_ratelimit_mail main string unset
15985 See &%smtp_ratelimit_hosts%& above.
15986
15987
15988 .option smtp_ratelimit_rcpt main string unset
15989 See &%smtp_ratelimit_hosts%& above.
15990
15991
15992 .option smtp_receive_timeout main time 5m
15993 .cindex "timeout" "for SMTP input"
15994 .cindex "SMTP" "input timeout"
15995 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15996 input, including batch SMTP. If a line of input (either an SMTP command or a
15997 data line) is not received within this time, the SMTP connection is dropped and
15998 the message is abandoned.
15999 A line is written to the log containing one of the following messages:
16000 .code
16001 SMTP command timeout on connection from...
16002 SMTP data timeout on connection from...
16003 .endd
16004 The former means that Exim was expecting to read an SMTP command; the latter
16005 means that it was in the DATA phase, reading the contents of a message.
16006
16007
16008 .oindex "&%-os%&"
16009 The value set by this option can be overridden by the
16010 &%-os%& command-line option. A setting of zero time disables the timeout, but
16011 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16012 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16013 timeout is controlled by &%receive_timeout%& and &%-or%&.
16014
16015
16016 .option smtp_reserve_hosts main "host list&!!" unset
16017 This option defines hosts for which SMTP connections are reserved; see
16018 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16019
16020
16021 .option smtp_return_error_details main boolean false
16022 .cindex "SMTP" "details policy failures"
16023 .cindex "policy control" "rejection, returning details"
16024 In the default state, Exim uses bland messages such as
16025 &"Administrative prohibition"& when it rejects SMTP commands for policy
16026 reasons. Many sysadmins like this because it gives away little information
16027 to spammers. However, some other sysadmins who are applying strict checking
16028 policies want to give out much fuller information about failures. Setting
16029 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16030 example, instead of &"Administrative prohibition"&, it might give:
16031 .code
16032 550-Rejected after DATA: '>' missing at end of address:
16033 550 failing address in "From" header is: <user@dom.ain
16034 .endd
16035
16036 .option spamd_address main string "see below"
16037 This option is available when Exim is compiled with the content-scanning
16038 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16039 The default value is
16040 .code
16041 127.0.0.1 783
16042 .endd
16043 See section &<<SECTscanspamass>>& for more details.
16044
16045
16046
16047 .option split_spool_directory main boolean false
16048 .cindex "multiple spool directories"
16049 .cindex "spool directory" "split"
16050 .cindex "directories, multiple"
16051 If this option is set, it causes Exim to split its input directory into 62
16052 subdirectories, each with a single alphanumeric character as its name. The
16053 sixth character of the message id is used to allocate messages to
16054 subdirectories; this is the least significant base-62 digit of the time of
16055 arrival of the message.
16056
16057 Splitting up the spool in this way may provide better performance on systems
16058 where there are long mail queues, by reducing the number of files in any one
16059 directory. The msglog directory is also split up in a similar way to the input
16060 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16061 are still placed in the single directory &_msglog.OLD_&.
16062
16063 It is not necessary to take any special action for existing messages when
16064 changing &%split_spool_directory%&. Exim notices messages that are in the
16065 &"wrong"& place, and continues to process them. If the option is turned off
16066 after a period of being on, the subdirectories will eventually empty and be
16067 automatically deleted.
16068
16069 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16070 changes. Instead of creating a list of all messages in the queue, and then
16071 trying to deliver each one in turn, it constructs a list of those in one
16072 sub-directory and tries to deliver them, before moving on to the next
16073 sub-directory. The sub-directories are processed in a random order. This
16074 spreads out the scanning of the input directories, and uses less memory. It is
16075 particularly beneficial when there are lots of messages on the queue. However,
16076 if &%queue_run_in_order%& is set, none of this new processing happens. The
16077 entire queue has to be scanned and sorted before any deliveries can start.
16078
16079
16080 .option spool_directory main string&!! "set at compile time"
16081 .cindex "spool directory" "path to"
16082 This defines the directory in which Exim keeps its spool, that is, the messages
16083 it is waiting to deliver. The default value is taken from the compile-time
16084 configuration setting, if there is one. If not, this option must be set. The
16085 string is expanded, so it can contain, for example, a reference to
16086 &$primary_hostname$&.
16087
16088 If the spool directory name is fixed on your installation, it is recommended
16089 that you set it at build time rather than from this option, particularly if the
16090 log files are being written to the spool directory (see &%log_file_path%&).
16091 Otherwise log files cannot be used for errors that are detected early on, such
16092 as failures in the configuration file.
16093
16094 By using this option to override the compiled-in path, it is possible to run
16095 tests of Exim without using the standard spool.
16096
16097 .option sqlite_lock_timeout main time 5s
16098 .cindex "sqlite lookup type" "lock timeout"
16099 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16100 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16101
16102 .option strict_acl_vars main boolean false
16103 .cindex "&ACL;" "variables, handling unset"
16104 This option controls what happens if a syntactically valid but undefined ACL
16105 variable is referenced. If it is false (the default), an empty string
16106 is substituted; if it is true, an error is generated. See section
16107 &<<SECTaclvariables>>& for details of ACL variables.
16108
16109 .option strip_excess_angle_brackets main boolean false
16110 .cindex "angle brackets, excess"
16111 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16112 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16113 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16114 passed on to another MTA, the excess angle brackets are not passed on. If this
16115 option is not set, multiple pairs of angle brackets cause a syntax error.
16116
16117
16118 .option strip_trailing_dot main boolean false
16119 .cindex "trailing dot on domain"
16120 .cindex "dot" "trailing on domain"
16121 If this option is set, a trailing dot at the end of a domain in an address is
16122 ignored. If this is in the envelope and the message is passed on to another
16123 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16124 domain causes a syntax error.
16125 However, addresses in header lines are checked only when an ACL requests header
16126 syntax checking.
16127
16128
16129 .option syslog_duplication main boolean true
16130 .cindex "syslog" "duplicate log lines; suppressing"
16131 When Exim is logging to syslog, it writes the log lines for its three
16132 separate logs at different syslog priorities so that they can in principle
16133 be separated on the logging hosts. Some installations do not require this
16134 separation, and in those cases, the duplication of certain log lines is a
16135 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16136 particular log line is written to syslog. For lines that normally go to
16137 both the main log and the reject log, the reject log version (possibly
16138 containing message header lines) is written, at LOG_NOTICE priority.
16139 Lines that normally go to both the main and the panic log are written at
16140 the LOG_ALERT priority.
16141
16142
16143 .option syslog_facility main string unset
16144 .cindex "syslog" "facility; setting"
16145 This option sets the syslog &"facility"& name, used when Exim is logging to
16146 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16147 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16148 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16149 details of Exim's logging.
16150
16151
16152
16153 .option syslog_processname main string &`exim`&
16154 .cindex "syslog" "process name; setting"
16155 This option sets the syslog &"ident"& name, used when Exim is logging to
16156 syslog. The value must be no longer than 32 characters. See chapter
16157 &<<CHAPlog>>& for details of Exim's logging.
16158
16159
16160
16161 .option syslog_timestamp main boolean true
16162 .cindex "syslog" "timestamps"
16163 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16164 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16165 details of Exim's logging.
16166
16167
16168 .option system_filter main string&!! unset
16169 .cindex "filter" "system filter"
16170 .cindex "system filter" "specifying"
16171 .cindex "Sieve filter" "not available for system filter"
16172 This option specifies an Exim filter file that is applied to all messages at
16173 the start of each delivery attempt, before any routing is done. System filters
16174 must be Exim filters; they cannot be Sieve filters. If the system filter
16175 generates any deliveries to files or pipes, or any new mail messages, the
16176 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16177 which transports are to be used. Details of this facility are given in chapter
16178 &<<CHAPsystemfilter>>&.
16179
16180
16181 .option system_filter_directory_transport main string&!! unset
16182 .vindex "&$address_file$&"
16183 This sets the name of the transport driver that is to be used when the
16184 &%save%& command in a system message filter specifies a path ending in &"/"&,
16185 implying delivery of each message into a separate file in some directory.
16186 During the delivery, the variable &$address_file$& contains the path name.
16187
16188
16189 .option system_filter_file_transport main string&!! unset
16190 .cindex "file" "transport for system filter"
16191 This sets the name of the transport driver that is to be used when the &%save%&
16192 command in a system message filter specifies a path not ending in &"/"&. During
16193 the delivery, the variable &$address_file$& contains the path name.
16194
16195 .option system_filter_group main string unset
16196 .cindex "gid (group id)" "system filter"
16197 This option is used only when &%system_filter_user%& is also set. It sets the
16198 gid under which the system filter is run, overriding any gid that is associated
16199 with the user. The value may be numerical or symbolic.
16200
16201 .option system_filter_pipe_transport main string&!! unset
16202 .cindex "&(pipe)& transport" "for system filter"
16203 .vindex "&$address_pipe$&"
16204 This specifies the transport driver that is to be used when a &%pipe%& command
16205 is used in a system filter. During the delivery, the variable &$address_pipe$&
16206 contains the pipe command.
16207
16208
16209 .option system_filter_reply_transport main string&!! unset
16210 .cindex "&(autoreply)& transport" "for system filter"
16211 This specifies the transport driver that is to be used when a &%mail%& command
16212 is used in a system filter.
16213
16214
16215 .option system_filter_user main string unset
16216 .cindex "uid (user id)" "system filter"
16217 If this option is set to root, the system filter is run in the main Exim
16218 delivery process, as root.  Otherwise, the system filter runs in a separate
16219 process, as the given user, defaulting to the Exim run-time user.
16220 Unless the string consists entirely of digits, it
16221 is looked up in the password data. Failure to find the named user causes a
16222 configuration error. The gid is either taken from the password data, or
16223 specified by &%system_filter_group%&. When the uid is specified numerically,
16224 &%system_filter_group%& is required to be set.
16225
16226 If the system filter generates any pipe, file, or reply deliveries, the uid
16227 under which the filter is run is used when transporting them, unless a
16228 transport option overrides.
16229
16230
16231 .option tcp_nodelay main boolean true
16232 .cindex "daemon" "TCP_NODELAY on sockets"
16233 .cindex "Nagle algorithm"
16234 .cindex "TCP_NODELAY on listening sockets"
16235 If this option is set false, it stops the Exim daemon setting the
16236 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16237 turns off the &"Nagle algorithm"&, which is a way of improving network
16238 performance in interactive (character-by-character) situations. Turning it off
16239 should improve Exim's performance a bit, so that is what happens by default.
16240 However, it appears that some broken clients cannot cope, and time out. Hence
16241 this option. It affects only those sockets that are set up for listening by the
16242 daemon. Sockets created by the smtp transport for delivering mail always set
16243 TCP_NODELAY.
16244
16245
16246 .option timeout_frozen_after main time 0s
16247 .cindex "frozen messages" "timing out"
16248 .cindex "timeout" "frozen messages"
16249 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16250 message of any kind that has been on the queue for longer than the given time
16251 is automatically cancelled at the next queue run. If the frozen message is a
16252 bounce message, it is just discarded; otherwise, a bounce is sent to the
16253 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16254 If you want to timeout frozen bounce messages earlier than other kinds of
16255 frozen message, see &%ignore_bounce_errors_after%&.
16256
16257 &*Note:*& the default value of zero means no timeouts; with this setting,
16258 frozen messages remain on the queue forever (except for any frozen bounce
16259 messages that are released by &%ignore_bounce_errors_after%&).
16260
16261
16262 .option timezone main string unset
16263 .cindex "timezone, setting"
16264 The value of &%timezone%& is used to set the environment variable TZ while
16265 running Exim (if it is different on entry). This ensures that all timestamps
16266 created by Exim are in the required timezone. If you want all your timestamps
16267 to be in UTC (aka GMT) you should set
16268 .code
16269 timezone = UTC
16270 .endd
16271 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16272 or, if that is not set, from the value of the TZ environment variable when Exim
16273 is built. If &%timezone%& is set to the empty string, either at build or run
16274 time, any existing TZ variable is removed from the environment when Exim
16275 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16276 unfortunately not all, operating systems.
16277
16278
16279 .option tls_advertise_hosts main "host list&!!" unset
16280 .cindex "TLS" "advertising"
16281 .cindex "encryption" "on SMTP connection"
16282 .cindex "SMTP" "encrypted connection"
16283 When Exim is built with support for TLS encrypted connections, the availability
16284 of the STARTTLS command to set up an encrypted session is advertised in
16285 response to EHLO only to those client hosts that match this option. See
16286 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16287
16288
16289 .option tls_certificate main string&!! unset
16290 .cindex "TLS" "server certificate; location of"
16291 .cindex "certificate" "server, location of"
16292 The value of this option is expanded, and must then be the absolute path to a
16293 file which contains the server's certificates. The server's private key is also
16294 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16295 &<<CHAPTLS>>& for further details.
16296
16297 &*Note*&: The certificates defined by this option are used only when Exim is
16298 receiving incoming messages as a server. If you want to supply certificates for
16299 use when sending messages as a client, you must set the &%tls_certificate%&
16300 option in the relevant &(smtp)& transport.
16301
16302 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16303 if the OpenSSL build supports TLS extensions and the TLS client sends the
16304 Server Name Indication extension, then this option and others documented in
16305 &<<SECTtlssni>>& will be re-expanded.
16306
16307 .option tls_crl main string&!! unset
16308 .cindex "TLS" "server certificate revocation list"
16309 .cindex "certificate" "revocation list for server"
16310 This option specifies a certificate revocation list. The expanded value must
16311 be the name of a file that contains a CRL in PEM format.
16312
16313 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16314
16315
16316 .option tls_dh_max_bits main integer 2236
16317 .cindex "TLS" "D-H bit count"
16318 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16319 the chosen TLS library.  That value might prove to be too high for
16320 interoperability.  This option provides a maximum clamp on the value
16321 suggested, trading off security for interoperability.
16322
16323 The value must be at least 1024.
16324
16325 The value 2236 was chosen because, at time of adding the option, it was the
16326 hard-coded maximum value supported by the NSS cryptographic library, as used
16327 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16328
16329 If you prefer more security and are willing to break some clients, raise this
16330 number.
16331
16332 Note that the value passed to GnuTLS for *generating* a new prime may be a
16333 little less than this figure, because GnuTLS is inexact and may produce a
16334 larger prime than requested.
16335
16336
16337 .option tls_dhparam main string&!! unset
16338 .cindex "TLS" "D-H parameters for server"
16339 The value of this option is expanded and indicates the source of DH parameters
16340 to be used by Exim.
16341
16342 If it is a filename starting with a &`/`&, then it names a file from which DH
16343 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16344 PKCS#3 representation of the DH prime.  If the file does not exist, for
16345 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16346 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16347 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16348 and treated as though the &%tls_dhparam%& were set to "none".
16349
16350 If this option expands to the string "none", then no DH parameters will be
16351 loaded by Exim.
16352
16353 If this option expands to the string "historic" and Exim is using GnuTLS, then
16354 Exim will attempt to load a file from inside the spool directory.  If the file
16355 does not exist, Exim will attempt to create it.
16356 See section &<<SECTgnutlsparam>>& for further details.
16357
16358 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16359 a default DH prime; the default is the 2048 bit prime described in section
16360 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16361 in IKE is assigned number 23.
16362
16363 Otherwise, the option must expand to the name used by Exim for any of a number
16364 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16365 "ike" followed by the number used by IKE, of "default" which corresponds to
16366 "ike23".
16367
16368 The available primes are:
16369 &`ike1`&, &`ike2`&, &`ike5`&,
16370 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16371 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16372
16373 Some of these will be too small to be accepted by clients.
16374 Some may be too large to be accepted by clients.
16375
16376 The TLS protocol does not negotiate an acceptable size for this; clients tend
16377 to hard-drop connections if what is offered by the server is unacceptable,
16378 whether too large or too small, and there's no provision for the client to
16379 tell the server what these constraints are.  Thus, as a server operator, you
16380 need to make an educated guess as to what is most likely to work for your
16381 userbase.
16382
16383 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16384 is most likely to maximise interoperability.  The upper bound comes from
16385 applications using the Mozilla Network Security Services (NSS) library, which
16386 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16387 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16388 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16389 acceptable bound from 1024 to 2048.
16390
16391
16392 .option tls_ocsp_file main string&!! unset
16393 This option
16394 must if set expand to the absolute path to a file which contains a current
16395 status proof for the server's certificate, as obtained from the
16396 Certificate Authority.
16397
16398
16399 .option tls_on_connect_ports main "string list" unset
16400 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16401 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16402 set up without waiting for the client to issue a STARTTLS command. For
16403 further details, see section &<<SECTsupobssmt>>&.
16404
16405
16406
16407 .option tls_privatekey main string&!! unset
16408 .cindex "TLS" "server private key; location of"
16409 The value of this option is expanded, and must then be the absolute path to a
16410 file which contains the server's private key. If this option is unset, or if
16411 the expansion is forced to fail, or the result is an empty string, the private
16412 key is assumed to be in the same file as the server's certificates. See chapter
16413 &<<CHAPTLS>>& for further details.
16414
16415 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16416
16417
16418 .option tls_remember_esmtp main boolean false
16419 .cindex "TLS" "esmtp state; remembering"
16420 .cindex "TLS" "broken clients"
16421 If this option is set true, Exim violates the RFCs by remembering that it is in
16422 &"esmtp"& state after successfully negotiating a TLS session. This provides
16423 support for broken clients that fail to send a new EHLO after starting a
16424 TLS session.
16425
16426
16427 .option tls_require_ciphers main string&!! unset
16428 .cindex "TLS" "requiring specific ciphers"
16429 .cindex "cipher" "requiring specific"
16430 This option controls which ciphers can be used for incoming TLS connections.
16431 The &(smtp)& transport has an option of the same name for controlling outgoing
16432 connections. This option is expanded for each connection, so can be varied for
16433 different clients if required. The value of this option must be a list of
16434 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16435 in somewhat different ways. If GnuTLS is being used, the client controls the
16436 preference order of the available ciphers. Details are given in sections
16437 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16438
16439
16440 .option tls_try_verify_hosts main "host list&!!" unset
16441 .cindex "TLS" "client certificate verification"
16442 .cindex "certificate" "verification of client"
16443 See &%tls_verify_hosts%& below.
16444
16445
16446 .option tls_verify_certificates main string&!! unset
16447 .cindex "TLS" "client certificate verification"
16448 .cindex "certificate" "verification of client"
16449 The value of this option is expanded, and must then be the absolute path to
16450 a file containing permitted certificates for clients that
16451 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16452 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16453 directory containing certificate files. This does not work with GnuTLS; the
16454 option must be set to the name of a single file if you are using GnuTLS.
16455
16456 These certificates should be for the certificate authorities trusted, rather
16457 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16458 the value is a file then the certificates are sent by Exim as a server to
16459 connecting clients, defining the list of accepted certificate authorities.
16460 Thus the values defined should be considered public data.  To avoid this,
16461 use OpenSSL with a directory.
16462
16463 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16464
16465 A forced expansion failure or setting to an empty string is equivalent to
16466 being unset.
16467
16468
16469 .option tls_verify_hosts main "host list&!!" unset
16470 .cindex "TLS" "client certificate verification"
16471 .cindex "certificate" "verification of client"
16472 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16473 certificates from clients. The expected certificates are defined by
16474 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16475 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16476 &%tls_verify_certificates%& is not set.
16477
16478 Any client that matches &%tls_verify_hosts%& is constrained by
16479 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16480 present one of the listed certificates. If it does not, the connection is
16481 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16482 the host to use TLS. It can still send SMTP commands through unencrypted
16483 connections. Forcing a client to use TLS has to be done separately using an
16484 ACL to reject inappropriate commands when the connection is not encrypted.
16485
16486 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16487 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16488 certificate and checks it against &%tls_verify_certificates%&, but does not
16489 abort the connection if there is no certificate or if it does not match. This
16490 state can be detected in an ACL, which makes it possible to implement policies
16491 such as &"accept for relay only if a verified certificate has been received,
16492 but accept for local delivery if encrypted, even without a verified
16493 certificate"&.
16494
16495 Client hosts that match neither of these lists are not asked to present
16496 certificates.
16497
16498
16499 .option trusted_groups main "string list&!!" unset
16500 .cindex "trusted groups"
16501 .cindex "groups" "trusted"
16502 This option is expanded just once, at the start of Exim's processing. If this
16503 option is set, any process that is running in one of the listed groups, or
16504 which has one of them as a supplementary group, is trusted. The groups can be
16505 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16506 details of what trusted callers are permitted to do. If neither
16507 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16508 are trusted.
16509
16510 .option trusted_users main "string list&!!" unset
16511 .cindex "trusted users"
16512 .cindex "user" "trusted"
16513 This option is expanded just once, at the start of Exim's processing. If this
16514 option is set, any process that is running as one of the listed users is
16515 trusted. The users can be specified numerically or by name. See section
16516 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16517 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16518 Exim user are trusted.
16519
16520 .option unknown_login main string&!! unset
16521 .cindex "uid (user id)" "unknown caller"
16522 .vindex "&$caller_uid$&"
16523 This is a specialized feature for use in unusual configurations. By default, if
16524 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16525 gives up. The &%unknown_login%& option can be used to set a login name to be
16526 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16527 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16528 is used for the user's real name (gecos field), unless this has been set by the
16529 &%-F%& option.
16530
16531 .option unknown_username main string unset
16532 See &%unknown_login%&.
16533
16534 .option untrusted_set_sender main "address list&!!" unset
16535 .cindex "trusted users"
16536 .cindex "sender" "setting by untrusted user"
16537 .cindex "untrusted user setting sender"
16538 .cindex "user" "untrusted setting sender"
16539 .cindex "envelope sender"
16540 When an untrusted user submits a message to Exim using the standard input, Exim
16541 normally creates an envelope sender address from the user's login and the
16542 default qualification domain. Data from the &%-f%& option (for setting envelope
16543 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16544 is used) is ignored.
16545
16546 However, untrusted users are permitted to set an empty envelope sender address,
16547 to declare that a message should never generate any bounces. For example:
16548 .code
16549 exim -f '<>' user@domain.example
16550 .endd
16551 .vindex "&$sender_ident$&"
16552 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16553 other envelope sender addresses in a controlled way. When it is set, untrusted
16554 users are allowed to set envelope sender addresses that match any of the
16555 patterns in the list. Like all address lists, the string is expanded. The
16556 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16557 users to setting senders that start with their login ids
16558 followed by a hyphen
16559 by a setting like this:
16560 .code
16561 untrusted_set_sender = ^$sender_ident-
16562 .endd
16563 If you want to allow untrusted users to set envelope sender addresses without
16564 restriction, you can use
16565 .code
16566 untrusted_set_sender = *
16567 .endd
16568 The &%untrusted_set_sender%& option applies to all forms of local input, but
16569 only to the setting of the envelope sender. It does not permit untrusted users
16570 to use the other options which trusted user can use to override message
16571 parameters. Furthermore, it does not stop Exim from removing an existing
16572 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16573 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16574 overriding these actions. The handling of the &'Sender:'& header is also
16575 described in section &<<SECTthesenhea>>&.
16576
16577 The log line for a message's arrival shows the envelope sender following
16578 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16579 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16580 envelope sender address, the user's login is shown in parentheses after the
16581 sender address.
16582
16583
16584 .option uucp_from_pattern main string "see below"
16585 .cindex "&""From""& line"
16586 .cindex "UUCP" "&""From""& line"
16587 Some applications that pass messages to an MTA via a command line interface use
16588 an initial line starting with &"From&~"& to pass the envelope sender. In
16589 particular, this is used by UUCP software. Exim recognizes such a line by means
16590 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16591 matches, the sender address is constructed by expanding the contents of
16592 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16593 default pattern recognizes lines in the following two forms:
16594 .code
16595 From ph10 Fri Jan  5 12:35 GMT 1996
16596 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16597 .endd
16598 The pattern can be seen by running
16599 .code
16600 exim -bP uucp_from_pattern
16601 .endd
16602 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16603 year in the second case. The first word after &"From&~"& is matched in the
16604 regular expression by a parenthesized subpattern. The default value for
16605 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16606 (&"ph10"& in the example above) as the message's sender. See also
16607 &%ignore_fromline_hosts%&.
16608
16609
16610 .option uucp_from_sender main string&!! &`$1`&
16611 See &%uucp_from_pattern%& above.
16612
16613
16614 .option warn_message_file main string unset
16615 .cindex "warning of delay" "customizing the message"
16616 .cindex "customizing" "warning message"
16617 This option defines a template file containing paragraphs of text to be used
16618 for constructing the warning message which is sent by Exim when a message has
16619 been on the queue for a specified amount of time, as specified by
16620 &%delay_warning%&. Details of the file's contents are given in chapter
16621 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16622
16623
16624 .option write_rejectlog main boolean true
16625 .cindex "reject log" "disabling"
16626 If this option is set false, Exim no longer writes anything to the reject log.
16627 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16628 .ecindex IIDconfima
16629 .ecindex IIDmaiconf
16630
16631
16632
16633
16634 . ////////////////////////////////////////////////////////////////////////////
16635 . ////////////////////////////////////////////////////////////////////////////
16636
16637 .chapter "Generic options for routers" "CHAProutergeneric"
16638 .scindex IIDgenoprou1 "options" "generic; for routers"
16639 .scindex IIDgenoprou2 "generic options" "router"
16640 This chapter describes the generic options that apply to all routers.
16641 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16642
16643 For a general description of how a router operates, see sections
16644 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16645 which the preconditions are tested. The order of expansion of the options that
16646 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16647 &%headers_remove%&, &%transport%&.
16648
16649
16650
16651 .option address_data routers string&!! unset
16652 .cindex "router" "data attached to address"
16653 The string is expanded just before the router is run, that is, after all the
16654 precondition tests have succeeded. If the expansion is forced to fail, the
16655 router declines, the value of &%address_data%& remains unchanged, and the
16656 &%more%& option controls what happens next. Other expansion failures cause
16657 delivery of the address to be deferred.
16658
16659 .vindex "&$address_data$&"
16660 When the expansion succeeds, the value is retained with the address, and can be
16661 accessed using the variable &$address_data$& in the current router, subsequent
16662 routers, and the eventual transport.
16663
16664 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16665 that runs a user's filter file, the contents of &$address_data$& are accessible
16666 in the filter. This is not normally a problem, because such data is usually
16667 either not confidential or it &"belongs"& to the current user, but if you do
16668 put confidential data into &$address_data$& you need to remember this point.
16669
16670 Even if the router declines or passes, the value of &$address_data$& remains
16671 with the address, though it can be changed by another &%address_data%& setting
16672 on a subsequent router. If a router generates child addresses, the value of
16673 &$address_data$& propagates to them. This also applies to the special kind of
16674 &"child"& that is generated by a router with the &%unseen%& option.
16675
16676 The idea of &%address_data%& is that you can use it to look up a lot of data
16677 for the address once, and then pick out parts of the data later. For example,
16678 you could use a single LDAP lookup to return a string of the form
16679 .code
16680 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16681 .endd
16682 In the transport you could pick out the mailbox by a setting such as
16683 .code
16684 file = ${extract{mailbox}{$address_data}}
16685 .endd
16686 This makes the configuration file less messy, and also reduces the number of
16687 lookups (though Exim does cache lookups).
16688
16689 .vindex "&$sender_address_data$&"
16690 .vindex "&$address_data$&"
16691 The &%address_data%& facility is also useful as a means of passing information
16692 from one router to another, and from a router to a transport. In addition, if
16693 &$address_data$& is set by a router when verifying a recipient address from an
16694 ACL, it remains available for use in the rest of the ACL statement. After
16695 verifying a sender, the value is transferred to &$sender_address_data$&.
16696
16697
16698
16699 .option address_test routers&!? boolean true
16700 .oindex "&%-bt%&"
16701 .cindex "router" "skipping when address testing"
16702 If this option is set false, the router is skipped when routing is being tested
16703 by means of the &%-bt%& command line option. This can be a convenience when
16704 your first router sends messages to an external scanner, because it saves you
16705 having to set the &"already scanned"& indicator when testing real address
16706 routing.
16707
16708
16709
16710 .option cannot_route_message routers string&!! unset
16711 .cindex "router" "customizing &""cannot route""& message"
16712 .cindex "customizing" "&""cannot route""& message"
16713 This option specifies a text message that is used when an address cannot be
16714 routed because Exim has run out of routers. The default message is
16715 &"Unrouteable address"&. This option is useful only on routers that have
16716 &%more%& set false, or on the very last router in a configuration, because the
16717 value that is used is taken from the last router that is considered. This
16718 includes a router that is skipped because its preconditions are not met, as
16719 well as a router that declines. For example, using the default configuration,
16720 you could put:
16721 .code
16722 cannot_route_message = Remote domain not found in DNS
16723 .endd
16724 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16725 and
16726 .code
16727 cannot_route_message = Unknown local user
16728 .endd
16729 on the final router that checks for local users. If string expansion fails for
16730 this option, the default message is used. Unless the expansion failure was
16731 explicitly forced, a message about the failure is written to the main and panic
16732 logs, in addition to the normal message about the routing failure.
16733
16734
16735 .option caseful_local_part routers boolean false
16736 .cindex "case of local parts"
16737 .cindex "router" "case of local parts"
16738 By default, routers handle the local parts of addresses in a case-insensitive
16739 manner, though the actual case is preserved for transmission with the message.
16740 If you want the case of letters to be significant in a router, you must set
16741 this option true. For individual router options that contain address or local
16742 part lists (for example, &%local_parts%&), case-sensitive matching can be
16743 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16744 more details.
16745
16746 .vindex "&$local_part$&"
16747 .vindex "&$original_local_part$&"
16748 .vindex "&$parent_local_part$&"
16749 The value of the &$local_part$& variable is forced to lower case while a
16750 router is running unless &%caseful_local_part%& is set. When a router assigns
16751 an address to a transport, the value of &$local_part$& when the transport runs
16752 is the same as it was in the router. Similarly, when a router generates child
16753 addresses by aliasing or forwarding, the values of &$original_local_part$&
16754 and &$parent_local_part$& are those that were used by the redirecting router.
16755
16756 This option applies to the processing of an address by a router. When a
16757 recipient address is being processed in an ACL, there is a separate &%control%&
16758 modifier that can be used to specify case-sensitive processing within the ACL
16759 (see section &<<SECTcontrols>>&).
16760
16761
16762
16763 .option check_local_user routers&!? boolean false
16764 .cindex "local user, checking in router"
16765 .cindex "router" "checking for local user"
16766 .cindex "&_/etc/passwd_&"
16767 .vindex "&$home$&"
16768 When this option is true, Exim checks that the local part of the recipient
16769 address (with affixes removed if relevant) is the name of an account on the
16770 local system. The check is done by calling the &[getpwnam()]& function rather
16771 than trying to read &_/etc/passwd_& directly. This means that other methods of
16772 holding password data (such as NIS) are supported. If the local part is a local
16773 user, &$home$& is set from the password data, and can be tested in other
16774 preconditions that are evaluated after this one (the order of evaluation is
16775 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16776 overridden by &%router_home_directory%&. If the local part is not a local user,
16777 the router is skipped.
16778
16779 If you want to check that the local part is either the name of a local user
16780 or matches something else, you cannot combine &%check_local_user%& with a
16781 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16782 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16783 setting to achieve this. For example:
16784 .code
16785 local_parts = passwd;$local_part : lsearch;/etc/other/users
16786 .endd
16787 Note, however, that the side effects of &%check_local_user%& (such as setting
16788 up a home directory) do not occur when a &(passwd)& lookup is used in a
16789 &%local_parts%& (or any other) precondition.
16790
16791
16792
16793 .option condition routers&!? string&!! unset
16794 .cindex "router" "customized precondition"
16795 This option specifies a general precondition test that has to succeed for the
16796 router to be called. The &%condition%& option is the last precondition to be
16797 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16798 result is a forced failure, or an empty string, or one of the strings &"0"& or
16799 &"no"& or &"false"& (checked without regard to the case of the letters), the
16800 router is skipped, and the address is offered to the next one.
16801
16802 If the result is any other value, the router is run (as this is the last
16803 precondition to be evaluated, all the other preconditions must be true).
16804
16805 This option is unusual in that multiple &%condition%& options may be present.
16806 All &%condition%& options must succeed.
16807
16808 The &%condition%& option provides a means of applying custom conditions to the
16809 running of routers. Note that in the case of a simple conditional expansion,
16810 the default expansion values are exactly what is wanted. For example:
16811 .code
16812 condition = ${if >{$message_age}{600}}
16813 .endd
16814 Because of the default behaviour of the string expansion, this is equivalent to
16815 .code
16816 condition = ${if >{$message_age}{600}{true}{}}
16817 .endd
16818
16819 A multiple condition example, which succeeds:
16820 .code
16821 condition = ${if >{$message_age}{600}}
16822 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16823 condition = foobar
16824 .endd
16825
16826 If the expansion fails (other than forced failure) delivery is deferred. Some
16827 of the other precondition options are common special cases that could in fact
16828 be specified using &%condition%&.
16829
16830 .new
16831 When originally designed, Exim's ACL system enforced very strict parsing
16832 of the &%condition%& expansion everywhere it was being processed.
16833 Through the 4.7x release cycle, the &%condition%& processing while in a
16834 router became more loose, internally adopting the use of &%bool_lax%&
16835 instead of the more rigid &%bool%&.  This is best illustrated in an
16836 example:
16837 .code
16838 # This used to fail with a syntax error, now it
16839 # treats any extra characters as a string
16840
16841 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16842 true {yes} {no}}
16843
16844 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16845  {yes} {no}}
16846 .endd
16847 In each example above, the &%if%& statement actually ends after
16848 &"{google.com}}"&.  Since no true or false braces were defined, the
16849 default &%if%& behavior is to return a boolean true or a null answer
16850 (which evaluates to false). The rest of the line is then treated as a
16851 string. So the first example resulted in the boolean answer &"true"&
16852 with the string &" {yes} {no}}"& appended to it. The second example
16853 resulted in the null output (indicating false) with the string
16854 &" {yes} {no}}"& appended to it.
16855
16856 In fact you can put excess forward braces in too.  In the router
16857 &%condition%&, Exim's ACL parser only looks for &"{"& symbols when they
16858 mean something, like after a &"$"& or when required as part of a
16859 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16860 string characters.
16861 .wen
16862
16863
16864 .option debug_print routers string&!! unset
16865 .cindex "testing" "variables in drivers"
16866 If this option is set and debugging is enabled (see the &%-d%& command line
16867 option) or in address-testing mode (see the &%-bt%& command line option),
16868 the string is expanded and included in the debugging output.
16869 If expansion of the string fails, the error message is written to the debugging
16870 output, and Exim carries on processing.
16871 This option is provided to help with checking out the values of variables and
16872 so on when debugging router configurations. For example, if a &%condition%&
16873 option appears not to be working, &%debug_print%& can be used to output the
16874 variables it references. The output happens after checks for &%domains%&,
16875 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16876 are tested. A newline is added to the text if it does not end with one.
16877 The variable &$router_name$& contains the name of the router.
16878
16879
16880
16881 .option disable_logging routers boolean false
16882 If this option is set true, nothing is logged for any routing errors
16883 or for any deliveries caused by this router. You should not set this option
16884 unless you really, really know what you are doing. See also the generic
16885 transport option of the same name.
16886
16887
16888 .option domains routers&!? "domain list&!!" unset
16889 .cindex "router" "restricting to specific domains"
16890 .vindex "&$domain_data$&"
16891 If this option is set, the router is skipped unless the current domain matches
16892 the list. If the match is achieved by means of a file lookup, the data that the
16893 lookup returned for the domain is placed in &$domain_data$& for use in string
16894 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16895 a list of the order in which preconditions are evaluated.
16896
16897
16898
16899 .option driver routers string unset
16900 This option must always be set. It specifies which of the available routers is
16901 to be used.
16902
16903
16904
16905 .option errors_to routers string&!! unset
16906 .cindex "envelope sender"
16907 .cindex "router" "changing address for errors"
16908 If a router successfully handles an address, it may assign the address to a
16909 transport for delivery or it may generate child addresses. In both cases, if
16910 there is a delivery problem during later processing, the resulting bounce
16911 message is sent to the address that results from expanding this string,
16912 provided that the address verifies successfully. The &%errors_to%& option is
16913 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16914
16915 The &%errors_to%& setting associated with an address can be overridden if it
16916 subsequently passes through other routers that have their own &%errors_to%&
16917 settings, or if the message is delivered by a transport with a &%return_path%&
16918 setting.
16919
16920 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16921 the expansion fails to verify, the errors address associated with the incoming
16922 address is used. At top level, this is the envelope sender. A non-forced
16923 expansion failure causes delivery to be deferred.
16924
16925 If an address for which &%errors_to%& has been set ends up being delivered over
16926 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16927 any bounces that are generated by other MTAs on the delivery route are also
16928 sent there. You can set &%errors_to%& to the empty string by either of these
16929 settings:
16930 .code
16931 errors_to =
16932 errors_to = ""
16933 .endd
16934 An expansion item that yields an empty string has the same effect. If you do
16935 this, a locally detected delivery error for addresses processed by this router
16936 no longer gives rise to a bounce message; the error is discarded. If the
16937 address is delivered to a remote host, the return path is set to &`<>`&, unless
16938 overridden by the &%return_path%& option on the transport.
16939
16940 .vindex "&$address_data$&"
16941 If for some reason you want to discard local errors, but use a non-empty
16942 MAIL command for remote delivery, you can preserve the original return
16943 path in &$address_data$& in the router, and reinstate it in the transport by
16944 setting &%return_path%&.
16945
16946 The most common use of &%errors_to%& is to direct mailing list bounces to the
16947 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16948 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16949
16950
16951
16952 .option expn routers&!? boolean true
16953 .cindex "address" "testing"
16954 .cindex "testing" "addresses"
16955 .cindex "EXPN" "router skipping"
16956 .cindex "router" "skipping for EXPN"
16957 If this option is turned off, the router is skipped when testing an address
16958 as a result of processing an SMTP EXPN command. You might, for example,
16959 want to turn it off on a router for users' &_.forward_& files, while leaving it
16960 on for the system alias file.
16961 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16962 are evaluated.
16963
16964 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16965 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16966 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16967
16968
16969
16970 .option fail_verify routers boolean false
16971 .cindex "router" "forcing verification failure"
16972 Setting this option has the effect of setting both &%fail_verify_sender%& and
16973 &%fail_verify_recipient%& to the same value.
16974
16975
16976
16977 .option fail_verify_recipient routers boolean false
16978 If this option is true and an address is accepted by this router when
16979 verifying a recipient, verification fails.
16980
16981
16982
16983 .option fail_verify_sender routers boolean false
16984 If this option is true and an address is accepted by this router when
16985 verifying a sender, verification fails.
16986
16987
16988
16989 .option fallback_hosts routers "string list" unset
16990 .cindex "router" "fallback hosts"
16991 .cindex "fallback" "hosts specified on router"
16992 String expansion is not applied to this option. The argument must be a
16993 colon-separated list of host names or IP addresses. The list separator can be
16994 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16995 each name or address. In fact, the format of each item is exactly the same as
16996 defined for the list of hosts in a &(manualroute)& router (see section
16997 &<<SECTformatonehostitem>>&).
16998
16999 If a router queues an address for a remote transport, this host list is
17000 associated with the address, and used instead of the transport's fallback host
17001 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17002 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17003 transport for further details.
17004
17005
17006 .option group routers string&!! "see below"
17007 .cindex "gid (group id)" "local delivery"
17008 .cindex "local transports" "uid and gid"
17009 .cindex "transport" "local"
17010 .cindex "router" "setting group"
17011 When a router queues an address for a transport, and the transport does not
17012 specify a group, the group given here is used when running the delivery
17013 process.
17014 The group may be specified numerically or by name. If expansion fails, the
17015 error is logged and delivery is deferred.
17016 The default is unset, unless &%check_local_user%& is set, when the default
17017 is taken from the password information. See also &%initgroups%& and &%user%&
17018 and the discussion in chapter &<<CHAPenvironment>>&.
17019
17020
17021
17022 .option headers_add routers list&!! unset
17023 .cindex "header lines" "adding"
17024 .cindex "router" "adding header lines"
17025 This option specifies a list of text headers, newline-separated,
17026 that is associated with any addresses that are accepted by the router.
17027 Each item is separately expanded, at routing time.  However, this
17028 option has no effect when an address is just being verified. The way in which
17029 the text is used to add header lines at transport time is described in section
17030 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17031 message is in the process of being transported. This means that references to
17032 header lines in string expansions in the transport's configuration do not
17033 &"see"& the added header lines.
17034
17035 The &%headers_add%& option is expanded after &%errors_to%&, but before
17036 &%headers_remove%& and &%transport%&. If an item is empty, or if
17037 an item expansion is forced to fail, the item has no effect. Other expansion
17038 failures are treated as configuration errors.
17039
17040 Unlike most options, &%headers_add%& can be specified multiple times
17041 for a router; all listed headers are added.
17042
17043 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17044 router that has the &%one_time%& option set.
17045
17046 .cindex "duplicate addresses"
17047 .oindex "&%unseen%&"
17048 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17049 additions are deleted when the address is passed on to subsequent routers.
17050 For a &%redirect%& router, if a generated address is the same as the incoming
17051 address, this can lead to duplicate addresses with different header
17052 modifications. Exim does not do duplicate deliveries (except, in certain
17053 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17054 which of the duplicates is discarded, so this ambiguous situation should be
17055 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17056
17057
17058
17059 .option headers_remove routers list&!! unset
17060 .cindex "header lines" "removing"
17061 .cindex "router" "removing header lines"
17062 This option specifies a list of text headers, colon-separated,
17063 that is associated with any addresses that are accepted by the router.
17064 Each item is separately expanded, at routing time.  However, this
17065 option has no effect when an address is just being verified. The way in which
17066 the text is used to remove header lines at transport time is described in
17067 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17068 the message is in the process of being transported. This means that references
17069 to header lines in string expansions in the transport's configuration still
17070 &"see"& the original header lines.
17071
17072 The &%headers_remove%& option is expanded after &%errors_to%& and
17073 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17074 the item has no effect. Other expansion failures are treated as configuration
17075 errors.
17076
17077 Unlike most options, &%headers_remove%& can be specified multiple times
17078 for a router; all listed headers are removed.
17079
17080 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17081 router that has the &%one_time%& option set.
17082
17083 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17084 removal requests are deleted when the address is passed on to subsequent
17085 routers, and this can lead to problems with duplicates -- see the similar
17086 warning for &%headers_add%& above.
17087
17088
17089 .option ignore_target_hosts routers "host list&!!" unset
17090 .cindex "IP address" "discarding"
17091 .cindex "router" "discarding IP addresses"
17092 Although this option is a host list, it should normally contain IP address
17093 entries rather than names. If any host that is looked up by the router has an
17094 IP address that matches an item in this list, Exim behaves as if that IP
17095 address did not exist. This option allows you to cope with rogue DNS entries
17096 like
17097 .code
17098 remote.domain.example.  A  127.0.0.1
17099 .endd
17100 by setting
17101 .code
17102 ignore_target_hosts = 127.0.0.1
17103 .endd
17104 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17105 discarded in this way, the router declines. In a conventional configuration, an
17106 attempt to mail to such a domain would normally provoke the &"unrouteable
17107 domain"& error, and an attempt to verify an address in the domain would fail.
17108 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17109 router declines if presented with one of the listed addresses.
17110
17111 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17112 means of the first or the second of the following settings, respectively:
17113 .code
17114 ignore_target_hosts = 0.0.0.0/0
17115 ignore_target_hosts = <; 0::0/0
17116 .endd
17117 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17118 in the second line matches all IPv6 addresses.
17119
17120 This option may also be useful for ignoring link-local and site-local IPv6
17121 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17122 is expanded before use as a list, it is possible to make it dependent on the
17123 domain that is being routed.
17124
17125 .vindex "&$host_address$&"
17126 During its expansion, &$host_address$& is set to the IP address that is being
17127 checked.
17128
17129 .option initgroups routers boolean false
17130 .cindex "additional groups"
17131 .cindex "groups" "additional"
17132 .cindex "local transports" "uid and gid"
17133 .cindex "transport" "local"
17134 If the router queues an address for a transport, and this option is true, and
17135 the uid supplied by the router is not overridden by the transport, the
17136 &[initgroups()]& function is called when running the transport to ensure that
17137 any additional groups associated with the uid are set up. See also &%group%&
17138 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17139
17140
17141
17142 .option local_part_prefix routers&!? "string list" unset
17143 .cindex "router" "prefix for local part"
17144 .cindex "prefix" "for local part, used in router"
17145 If this option is set, the router is skipped unless the local part starts with
17146 one of the given strings, or &%local_part_prefix_optional%& is true. See
17147 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17148 evaluated.
17149
17150 The list is scanned from left to right, and the first prefix that matches is
17151 used. A limited form of wildcard is available; if the prefix begins with an
17152 asterisk, it matches the longest possible sequence of arbitrary characters at
17153 the start of the local part. An asterisk should therefore always be followed by
17154 some character that does not occur in normal local parts.
17155 .cindex "multiple mailboxes"
17156 .cindex "mailbox" "multiple"
17157 Wildcarding can be used to set up multiple user mailboxes, as described in
17158 section &<<SECTmulbox>>&.
17159
17160 .vindex "&$local_part$&"
17161 .vindex "&$local_part_prefix$&"
17162 During the testing of the &%local_parts%& option, and while the router is
17163 running, the prefix is removed from the local part, and is available in the
17164 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17165 the router accepts the address, this remains true during subsequent delivery by
17166 a transport. In particular, the local part that is transmitted in the RCPT
17167 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17168 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17169 the relevant transport.
17170
17171 When an address is being verified, &%local_part_prefix%& affects only the
17172 behaviour of the router. If the callout feature of verification is in use, this
17173 means that the full address, including the prefix, will be used during the
17174 callout.
17175
17176 The prefix facility is commonly used to handle local parts of the form
17177 &%owner-something%&. Another common use is to support local parts of the form
17178 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17179 to tell a user their forwarding is broken &-- by placing a router like this one
17180 immediately before the router that handles &_.forward_& files:
17181 .code
17182 real_localuser:
17183   driver = accept
17184   local_part_prefix = real-
17185   check_local_user
17186   transport = local_delivery
17187 .endd
17188 For security, it would probably be a good idea to restrict the use of this
17189 router to locally-generated messages, using a condition such as this:
17190 .code
17191   condition = ${if match {$sender_host_address}\
17192                          {\N^(|127\.0\.0\.1)$\N}}
17193 .endd
17194
17195 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17196 both conditions must be met if not optional. Care must be taken if wildcards
17197 are used in both a prefix and a suffix on the same router. Different
17198 separator characters must be used to avoid ambiguity.
17199
17200
17201 .option local_part_prefix_optional routers boolean false
17202 See &%local_part_prefix%& above.
17203
17204
17205
17206 .option local_part_suffix routers&!? "string list" unset
17207 .cindex "router" "suffix for local part"
17208 .cindex "suffix for local part" "used in router"
17209 This option operates in the same way as &%local_part_prefix%&, except that the
17210 local part must end (rather than start) with the given string, the
17211 &%local_part_suffix_optional%& option determines whether the suffix is
17212 mandatory, and the wildcard * character, if present, must be the last
17213 character of the suffix. This option facility is commonly used to handle local
17214 parts of the form &%something-request%& and multiple user mailboxes of the form
17215 &%username-foo%&.
17216
17217
17218 .option local_part_suffix_optional routers boolean false
17219 See &%local_part_suffix%& above.
17220
17221
17222
17223 .option local_parts routers&!? "local part list&!!" unset
17224 .cindex "router" "restricting to specific local parts"
17225 .cindex "local part" "checking in router"
17226 The router is run only if the local part of the address matches the list.
17227 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17228 are evaluated, and
17229 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17230 string is expanded, it is possible to make it depend on the domain, for
17231 example:
17232 .code
17233 local_parts = dbm;/usr/local/specials/$domain
17234 .endd
17235 .vindex "&$local_part_data$&"
17236 If the match is achieved by a lookup, the data that the lookup returned
17237 for the local part is placed in the variable &$local_part_data$& for use in
17238 expansions of the router's private options. You might use this option, for
17239 example, if you have a large number of local virtual domains, and you want to
17240 send all postmaster mail to the same place without having to set up an alias in
17241 each virtual domain:
17242 .code
17243 postmaster:
17244   driver = redirect
17245   local_parts = postmaster
17246   data = postmaster@real.domain.example
17247 .endd
17248
17249
17250 .option log_as_local routers boolean "see below"
17251 .cindex "log" "delivery line"
17252 .cindex "delivery" "log line format"
17253 Exim has two logging styles for delivery, the idea being to make local
17254 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17255 recipient address is given just as the local part, without a domain. The use of
17256 this style is controlled by this option. It defaults to true for the &(accept)&
17257 router, and false for all the others. This option applies only when a
17258 router assigns an address to a transport. It has no effect on routers that
17259 redirect addresses.
17260
17261
17262
17263 .option more routers boolean&!! true
17264 The result of string expansion for this option must be a valid boolean value,
17265 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17266 result causes an error, and delivery is deferred. If the expansion is forced to
17267 fail, the default value for the option (true) is used. Other failures cause
17268 delivery to be deferred.
17269
17270 If this option is set false, and the router declines to handle the address, no
17271 further routers are tried, routing fails, and the address is bounced.
17272 .oindex "&%self%&"
17273 However, if the router explicitly passes an address to the following router by
17274 means of the setting
17275 .code
17276 self = pass
17277 .endd
17278 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17279 does not affect the behaviour if one of the precondition tests fails. In that
17280 case, the address is always passed to the next router.
17281
17282 Note that &%address_data%& is not considered to be a precondition. If its
17283 expansion is forced to fail, the router declines, and the value of &%more%&
17284 controls what happens next.
17285
17286
17287 .option pass_on_timeout routers boolean false
17288 .cindex "timeout" "of router"
17289 .cindex "router" "timeout"
17290 If a router times out during a host lookup, it normally causes deferral of the
17291 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17292 router, overriding &%no_more%&. This may be helpful for systems that are
17293 intermittently connected to the Internet, or those that want to pass to a smart
17294 host any messages that cannot immediately be delivered.
17295
17296 There are occasional other temporary errors that can occur while doing DNS
17297 lookups. They are treated in the same way as a timeout, and this option
17298 applies to all of them.
17299
17300
17301
17302 .option pass_router routers string unset
17303 .cindex "router" "go to after &""pass""&"
17304 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17305 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17306 routing to continue, and overriding a false setting of &%more%&. When one of
17307 these routers returns &"pass"&, the address is normally handed on to the next
17308 router in sequence. This can be changed by setting &%pass_router%& to the name
17309 of another router. However (unlike &%redirect_router%&) the named router must
17310 be below the current router, to avoid loops. Note that this option applies only
17311 to the special case of &"pass"&. It does not apply when a router returns
17312 &"decline"& because it cannot handle an address.
17313
17314
17315
17316 .option redirect_router routers string unset
17317 .cindex "router" "start at after redirection"
17318 Sometimes an administrator knows that it is pointless to reprocess addresses
17319 generated from alias or forward files with the same router again. For
17320 example, if an alias file translates real names into login ids there is no
17321 point searching the alias file a second time, especially if it is a large file.
17322
17323 The &%redirect_router%& option can be set to the name of any router instance.
17324 It causes the routing of any generated addresses to start at the named router
17325 instead of at the first router. This option has no effect if the router in
17326 which it is set does not generate new addresses.
17327
17328
17329
17330 .option require_files routers&!? "string list&!!" unset
17331 .cindex "file" "requiring for router"
17332 .cindex "router" "requiring file existence"
17333 This option provides a general mechanism for predicating the running of a
17334 router on the existence or non-existence of certain files or directories.
17335 Before running a router, as one of its precondition tests, Exim works its way
17336 through the &%require_files%& list, expanding each item separately.
17337
17338 Because the list is split before expansion, any colons in expansion items must
17339 be doubled, or the facility for using a different list separator must be used.
17340 If any expansion is forced to fail, the item is ignored. Other expansion
17341 failures cause routing of the address to be deferred.
17342
17343 If any expanded string is empty, it is ignored. Otherwise, except as described
17344 below, each string must be a fully qualified file path, optionally preceded by
17345 &"!"&. The paths are passed to the &[stat()]& function to test for the
17346 existence of the files or directories. The router is skipped if any paths not
17347 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17348
17349 .cindex "NFS"
17350 If &[stat()]& cannot determine whether a file exists or not, delivery of
17351 the message is deferred. This can happen when NFS-mounted filesystems are
17352 unavailable.
17353
17354 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17355 options, so you cannot use it to check for the existence of a file in which to
17356 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17357 full list of the order in which preconditions are evaluated.) However, as
17358 these options are all expanded, you can use the &%exists%& expansion condition
17359 to make such tests. The &%require_files%& option is intended for checking files
17360 that the router may be going to use internally, or which are needed by a
17361 transport (for example &_.procmailrc_&).
17362
17363 During delivery, the &[stat()]& function is run as root, but there is a
17364 facility for some checking of the accessibility of a file by another user.
17365 This is not a proper permissions check, but just a &"rough"& check that
17366 operates as follows:
17367
17368 If an item in a &%require_files%& list does not contain any forward slash
17369 characters, it is taken to be the user (and optional group, separated by a
17370 comma) to be checked for subsequent files in the list. If no group is specified
17371 but the user is specified symbolically, the gid associated with the uid is
17372 used. For example:
17373 .code
17374 require_files = mail:/some/file
17375 require_files = $local_part:$home/.procmailrc
17376 .endd
17377 If a user or group name in a &%require_files%& list does not exist, the
17378 &%require_files%& condition fails.
17379
17380 Exim performs the check by scanning along the components of the file path, and
17381 checking the access for the given uid and gid. It checks for &"x"& access on
17382 directories, and &"r"& access on the final file. Note that this means that file
17383 access control lists, if the operating system has them, are ignored.
17384
17385 &*Warning 1*&: When the router is being run to verify addresses for an
17386 incoming SMTP message, Exim is not running as root, but under its own uid. This
17387 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17388 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17389 user is not permitted to read one of the directories on the file's path.
17390
17391 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17392 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17393 without root access. In this case, if a check for access by a particular user
17394 is requested, Exim creates a subprocess that runs as that user, and tries the
17395 check again in that process.
17396
17397 The default action for handling an unresolved EACCES is to consider it to
17398 be caused by a configuration error, and routing is deferred because the
17399 existence or non-existence of the file cannot be determined. However, in some
17400 circumstances it may be desirable to treat this condition as if the file did
17401 not exist. If the file name (or the exclamation mark that precedes the file
17402 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17403 as if the file did not exist. For example:
17404 .code
17405 require_files = +/some/file
17406 .endd
17407 If the router is not an essential part of verification (for example, it
17408 handles users' &_.forward_& files), another solution is to set the &%verify%&
17409 option false so that the router is skipped when verifying.
17410
17411
17412
17413 .option retry_use_local_part routers boolean "see below"
17414 .cindex "hints database" "retry keys"
17415 .cindex "local part" "in retry keys"
17416 When a delivery suffers a temporary routing failure, a retry record is created
17417 in Exim's hints database. For addresses whose routing depends only on the
17418 domain, the key for the retry record should not involve the local part, but for
17419 other addresses, both the domain and the local part should be included.
17420 Usually, remote routing is of the former kind, and local routing is of the
17421 latter kind.
17422
17423 This option controls whether the local part is used to form the key for retry
17424 hints for addresses that suffer temporary errors while being handled by this
17425 router. The default value is true for any router that has &%check_local_user%&
17426 set, and false otherwise. Note that this option does not apply to hints keys
17427 for transport delays; they are controlled by a generic transport option of the
17428 same name.
17429
17430 The setting of &%retry_use_local_part%& applies only to the router on which it
17431 appears. If the router generates child addresses, they are routed
17432 independently; this setting does not become attached to them.
17433
17434
17435
17436 .option router_home_directory routers string&!! unset
17437 .cindex "router" "home directory for"
17438 .cindex "home directory" "for router"
17439 .vindex "&$home$&"
17440 This option sets a home directory for use while the router is running. (Compare
17441 &%transport_home_directory%&, which sets a home directory for later
17442 transporting.) In particular, if used on a &(redirect)& router, this option
17443 sets a value for &$home$& while a filter is running. The value is expanded;
17444 forced expansion failure causes the option to be ignored &-- other failures
17445 cause the router to defer.
17446
17447 Expansion of &%router_home_directory%& happens immediately after the
17448 &%check_local_user%& test (if configured), before any further expansions take
17449 place.
17450 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17451 are evaluated.)
17452 While the router is running, &%router_home_directory%& overrides the value of
17453 &$home$& that came from &%check_local_user%&.
17454
17455 When a router accepts an address and assigns it to a local transport (including
17456 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17457 delivery), the home directory setting for the transport is taken from the first
17458 of these values that is set:
17459
17460 .ilist
17461 The &%home_directory%& option on the transport;
17462 .next
17463 The &%transport_home_directory%& option on the router;
17464 .next
17465 The password data if &%check_local_user%& is set on the router;
17466 .next
17467 The &%router_home_directory%& option on the router.
17468 .endlist
17469
17470 In other words, &%router_home_directory%& overrides the password data for the
17471 router, but not for the transport.
17472
17473
17474
17475 .option self routers string freeze
17476 .cindex "MX record" "pointing to local host"
17477 .cindex "local host" "MX pointing to"
17478 This option applies to those routers that use a recipient address to find a
17479 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17480 and &(manualroute)& routers.
17481 Certain configurations of the &(queryprogram)& router can also specify a list
17482 of remote hosts.
17483 Usually such routers are configured to send the message to a remote host via an
17484 &(smtp)& transport. The &%self%& option specifies what happens when the first
17485 host on the list turns out to be the local host.
17486 The way in which Exim checks for the local host is described in section
17487 &<<SECTreclocipadd>>&.
17488
17489 Normally this situation indicates either an error in Exim's configuration (for
17490 example, the router should be configured not to process this domain), or an
17491 error in the DNS (for example, the MX should not point to this host). For this
17492 reason, the default action is to log the incident, defer the address, and
17493 freeze the message. The following alternatives are provided for use in special
17494 cases:
17495
17496 .vlist
17497 .vitem &%defer%&
17498 Delivery of the message is tried again later, but the message is not frozen.
17499
17500 .vitem "&%reroute%&: <&'domain'&>"
17501 The domain is changed to the given domain, and the address is passed back to
17502 be reprocessed by the routers. No rewriting of headers takes place. This
17503 behaviour is essentially a redirection.
17504
17505 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17506 The domain is changed to the given domain, and the address is passed back to be
17507 reprocessed by the routers. Any headers that contain the original domain are
17508 rewritten.
17509
17510 .vitem &%pass%&
17511 .oindex "&%more%&"
17512 .vindex "&$self_hostname$&"
17513 The router passes the address to the next router, or to the router named in the
17514 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17515 subsequent routing and delivery, the variable &$self_hostname$& contains the
17516 name of the local host that the router encountered. This can be used to
17517 distinguish between different cases for hosts with multiple names. The
17518 combination
17519 .code
17520 self = pass
17521 no_more
17522 .endd
17523 ensures that only those addresses that routed to the local host are passed on.
17524 Without &%no_more%&, addresses that were declined for other reasons would also
17525 be passed to the next router.
17526
17527 .vitem &%fail%&
17528 Delivery fails and an error report is generated.
17529
17530 .vitem &%send%&
17531 .cindex "local host" "sending to"
17532 The anomaly is ignored and the address is queued for the transport. This
17533 setting should be used with extreme caution. For an &(smtp)& transport, it
17534 makes sense only in cases where the program that is listening on the SMTP port
17535 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17536 different configuration file that handles the domain in another way.
17537 .endlist
17538
17539
17540
17541 .option senders routers&!? "address list&!!" unset
17542 .cindex "router" "checking senders"
17543 If this option is set, the router is skipped unless the message's sender
17544 address matches something on the list.
17545 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17546 are evaluated.
17547
17548 There are issues concerning verification when the running of routers is
17549 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17550 setting, it sets the sender to the null string. When using the &%-bt%& option
17551 to check a configuration file, it is necessary also to use the &%-f%& option to
17552 set an appropriate sender. For incoming mail, the sender is unset when
17553 verifying the sender, but is available when verifying any recipients. If the
17554 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17555 matters.
17556
17557
17558 .option translate_ip_address routers string&!! unset
17559 .cindex "IP address" "translating"
17560 .cindex "packet radio"
17561 .cindex "router" "IP address translation"
17562 There exist some rare networking situations (for example, packet radio) where
17563 it is helpful to be able to translate IP addresses generated by normal routing
17564 mechanisms into other IP addresses, thus performing a kind of manual IP
17565 routing. This should be done only if the normal IP routing of the TCP/IP stack
17566 is inadequate or broken. Because this is an extremely uncommon requirement, the
17567 code to support this option is not included in the Exim binary unless
17568 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17569
17570 .vindex "&$host_address$&"
17571 The &%translate_ip_address%& string is expanded for every IP address generated
17572 by the router, with the generated address set in &$host_address$&. If the
17573 expansion is forced to fail, no action is taken.
17574 For any other expansion error, delivery of the message is deferred.
17575 If the result of the expansion is an IP address, that replaces the original
17576 address; otherwise the result is assumed to be a host name &-- this is looked
17577 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17578 produce one or more replacement IP addresses. For example, to subvert all IP
17579 addresses in some specific networks, this could be added to a router:
17580 .code
17581 translate_ip_address = \
17582   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17583     {$value}fail}}
17584 .endd
17585 The file would contain lines like
17586 .code
17587 10.2.3.128/26    some.host
17588 10.8.4.34/26     10.44.8.15
17589 .endd
17590 You should not make use of this facility unless you really understand what you
17591 are doing.
17592
17593
17594
17595 .option transport routers string&!! unset
17596 This option specifies the transport to be used when a router accepts an address
17597 and sets it up for delivery. A transport is never needed if a router is used
17598 only for verification. The value of the option is expanded at routing time,
17599 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17600 and result must be the name of one of the configured transports. If it is not,
17601 delivery is deferred.
17602
17603 The &%transport%& option is not used by the &(redirect)& router, but it does
17604 have some private options that set up transports for pipe and file deliveries
17605 (see chapter &<<CHAPredirect>>&).
17606
17607
17608
17609 .option transport_current_directory routers string&!! unset
17610 .cindex "current directory for local transport"
17611 This option associates a current directory with any address that is routed
17612 to a local transport. This can happen either because a transport is
17613 explicitly configured for the router, or because it generates a delivery to a
17614 file or a pipe. During the delivery process (that is, at transport time), this
17615 option string is expanded and is set as the current directory, unless
17616 overridden by a setting on the transport.
17617 If the expansion fails for any reason, including forced failure, an error is
17618 logged, and delivery is deferred.
17619 See chapter &<<CHAPenvironment>>& for details of the local delivery
17620 environment.
17621
17622
17623
17624
17625 .option transport_home_directory routers string&!! "see below"
17626 .cindex "home directory" "for local transport"
17627 This option associates a home directory with any address that is routed to a
17628 local transport. This can happen either because a transport is explicitly
17629 configured for the router, or because it generates a delivery to a file or a
17630 pipe. During the delivery process (that is, at transport time), the option
17631 string is expanded and is set as the home directory, unless overridden by a
17632 setting of &%home_directory%& on the transport.
17633 If the expansion fails for any reason, including forced failure, an error is
17634 logged, and delivery is deferred.
17635
17636 If the transport does not specify a home directory, and
17637 &%transport_home_directory%& is not set for the router, the home directory for
17638 the transport is taken from the password data if &%check_local_user%& is set for
17639 the router. Otherwise it is taken from &%router_home_directory%& if that option
17640 is set; if not, no home directory is set for the transport.
17641
17642 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17643 environment.
17644
17645
17646
17647
17648 .option unseen routers boolean&!! false
17649 .cindex "router" "carrying on after success"
17650 The result of string expansion for this option must be a valid boolean value,
17651 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17652 result causes an error, and delivery is deferred. If the expansion is forced to
17653 fail, the default value for the option (false) is used. Other failures cause
17654 delivery to be deferred.
17655
17656 When this option is set true, routing does not cease if the router accepts the
17657 address. Instead, a copy of the incoming address is passed to the next router,
17658 overriding a false setting of &%more%&. There is little point in setting
17659 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17660 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17661 sometimes true and sometimes false).
17662
17663 .cindex "copy of message (&%unseen%& option)"
17664 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17665 qualifier in filter files. It can be used to cause copies of messages to be
17666 delivered to some other destination, while also carrying out a normal delivery.
17667 In effect, the current address is made into a &"parent"& that has two children
17668 &-- one that is delivered as specified by this router, and a clone that goes on
17669 to be routed further. For this reason, &%unseen%& may not be combined with the
17670 &%one_time%& option in a &(redirect)& router.
17671
17672 &*Warning*&: Header lines added to the address (or specified for removal) by
17673 this router or by previous routers affect the &"unseen"& copy of the message
17674 only. The clone that continues to be processed by further routers starts with
17675 no added headers and none specified for removal. For a &%redirect%& router, if
17676 a generated address is the same as the incoming address, this can lead to
17677 duplicate addresses with different header modifications. Exim does not do
17678 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17679 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17680 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17681 &%redirect%& router may be of help.
17682
17683 Unlike the handling of header modifications, any data that was set by the
17684 &%address_data%& option in the current or previous routers &'is'& passed on to
17685 subsequent routers.
17686
17687
17688 .option user routers string&!! "see below"
17689 .cindex "uid (user id)" "local delivery"
17690 .cindex "local transports" "uid and gid"
17691 .cindex "transport" "local"
17692 .cindex "router" "user for filter processing"
17693 .cindex "filter" "user for processing"
17694 When a router queues an address for a transport, and the transport does not
17695 specify a user, the user given here is used when running the delivery process.
17696 The user may be specified numerically or by name. If expansion fails, the
17697 error is logged and delivery is deferred.
17698 This user is also used by the &(redirect)& router when running a filter file.
17699 The default is unset, except when &%check_local_user%& is set. In this case,
17700 the default is taken from the password information. If the user is specified as
17701 a name, and &%group%& is not set, the group associated with the user is used.
17702 See also &%initgroups%& and &%group%& and the discussion in chapter
17703 &<<CHAPenvironment>>&.
17704
17705
17706
17707 .option verify routers&!? boolean true
17708 Setting this option has the effect of setting &%verify_sender%& and
17709 &%verify_recipient%& to the same value.
17710
17711
17712 .option verify_only routers&!? boolean false
17713 .cindex "EXPN" "with &%verify_only%&"
17714 .oindex "&%-bv%&"
17715 .cindex "router" "used only when verifying"
17716 If this option is set, the router is used only when verifying an address,
17717 delivering in cutthrough mode or
17718 testing with the &%-bv%& option, not when actually doing a delivery, testing
17719 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17720 restricted to verifying only senders or recipients by means of
17721 &%verify_sender%& and &%verify_recipient%&.
17722
17723 &*Warning*&: When the router is being run to verify addresses for an incoming
17724 SMTP message, Exim is not running as root, but under its own uid. If the router
17725 accesses any files, you need to make sure that they are accessible to the Exim
17726 user or group.
17727
17728
17729 .option verify_recipient routers&!? boolean true
17730 If this option is false, the router is skipped when verifying recipient
17731 addresses,
17732 delivering in cutthrough mode
17733 or testing recipient verification using &%-bv%&.
17734 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17735 are evaluated.
17736
17737
17738 .option verify_sender routers&!? boolean true
17739 If this option is false, the router is skipped when verifying sender addresses
17740 or testing sender verification using &%-bvs%&.
17741 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17742 are evaluated.
17743 .ecindex IIDgenoprou1
17744 .ecindex IIDgenoprou2
17745
17746
17747
17748
17749
17750
17751 . ////////////////////////////////////////////////////////////////////////////
17752 . ////////////////////////////////////////////////////////////////////////////
17753
17754 .chapter "The accept router" "CHID4"
17755 .cindex "&(accept)& router"
17756 .cindex "routers" "&(accept)&"
17757 The &(accept)& router has no private options of its own. Unless it is being
17758 used purely for verification (see &%verify_only%&) a transport is required to
17759 be defined by the generic &%transport%& option. If the preconditions that are
17760 specified by generic options are met, the router accepts the address and queues
17761 it for the given transport. The most common use of this router is for setting
17762 up deliveries to local mailboxes. For example:
17763 .code
17764 localusers:
17765   driver = accept
17766   domains = mydomain.example
17767   check_local_user
17768   transport = local_delivery
17769 .endd
17770 The &%domains%& condition in this example checks the domain of the address, and
17771 &%check_local_user%& checks that the local part is the login of a local user.
17772 When both preconditions are met, the &(accept)& router runs, and queues the
17773 address for the &(local_delivery)& transport.
17774
17775
17776
17777
17778
17779
17780 . ////////////////////////////////////////////////////////////////////////////
17781 . ////////////////////////////////////////////////////////////////////////////
17782
17783 .chapter "The dnslookup router" "CHAPdnslookup"
17784 .scindex IIDdnsrou1 "&(dnslookup)& router"
17785 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17786 The &(dnslookup)& router looks up the hosts that handle mail for the
17787 recipient's domain in the DNS. A transport must always be set for this router,
17788 unless &%verify_only%& is set.
17789
17790 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17791 SRV records. If none are found, or if SRV support is not configured,
17792 MX records are looked up. If no MX records exist, address records are sought.
17793 However, &%mx_domains%& can be set to disable the direct use of address
17794 records.
17795
17796 MX records of equal priority are sorted by Exim into a random order. Exim then
17797 looks for address records for the host names obtained from MX or SRV records.
17798 When a host has more than one IP address, they are sorted into a random order,
17799 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17800 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17801 generic option, the router declines.
17802
17803 Unless they have the highest priority (lowest MX value), MX records that point
17804 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17805 are discarded, together with any other MX records of equal or lower priority.
17806
17807 .cindex "MX record" "pointing to local host"
17808 .cindex "local host" "MX pointing to"
17809 .oindex "&%self%&" "in &(dnslookup)& router"
17810 If the host pointed to by the highest priority MX record, or looked up as an
17811 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17812 happens is controlled by the generic &%self%& option.
17813
17814
17815 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17816 There have been problems with DNS servers when SRV records are looked up.
17817 Some mis-behaving servers return a DNS error or timeout when a non-existent
17818 SRV record is sought. Similar problems have in the past been reported for
17819 MX records. The global &%dns_again_means_nonexist%& option can help with this
17820 problem, but it is heavy-handed because it is a global option.
17821
17822 For this reason, there are two options, &%srv_fail_domains%& and
17823 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17824 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17825 an attempt to look up an SRV or MX record causes one of these results, and the
17826 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17827 such record"&. In the case of an SRV lookup, this means that the router
17828 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17829 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17830 case routing fails.
17831
17832
17833 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17834 .cindex "&(dnslookup)& router" "declines"
17835 There are a few cases where a &(dnslookup)& router will decline to accept
17836 an address; if such a router is expected to handle "all remaining non-local
17837 domains", then it is important to set &%no_more%&.
17838
17839 Reasons for a &(dnslookup)& router to decline currently include:
17840 .ilist
17841 The domain does not exist in DNS
17842 .next
17843 The domain exists but the MX record's host part is just "."; this is a common
17844 convention (borrowed from SRV) used to indicate that there is no such service
17845 for this domain and to not fall back to trying A/AAAA records.
17846 .next
17847 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17848 .next
17849 MX record points to a non-existent host.
17850 .next
17851 MX record points to an IP address and the main section option
17852 &%allow_mx_to_ip%& is not set.
17853 .next
17854 MX records exist and point to valid hosts, but all hosts resolve only to
17855 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17856 .next
17857 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17858 &%dns_check_names_pattern%& for handling one variant of this)
17859 .next
17860 &%check_secondary_mx%& is set on this router but the local host can
17861 not be found in the MX records (see below)
17862 .endlist
17863
17864
17865
17866
17867 .section "Private options for dnslookup" "SECID118"
17868 .cindex "options" "&(dnslookup)& router"
17869 The private options for the &(dnslookup)& router are as follows:
17870
17871 .option check_secondary_mx dnslookup boolean false
17872 .cindex "MX record" "checking for secondary"
17873 If this option is set, the router declines unless the local host is found in
17874 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17875 process domains for which the local host is a secondary mail exchanger
17876 differently to other domains. The way in which Exim decides whether a host is
17877 the local host is described in section &<<SECTreclocipadd>>&.
17878
17879
17880 .option check_srv dnslookup string&!! unset
17881 .cindex "SRV record" "enabling use of"
17882 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17883 addition to MX and address records. The support is disabled by default. To
17884 enable SRV support, set the &%check_srv%& option to the name of the service
17885 required. For example,
17886 .code
17887 check_srv = smtp
17888 .endd
17889 looks for SRV records that refer to the normal smtp service. The option is
17890 expanded, so the service name can vary from message to message or address
17891 to address. This might be helpful if SRV records are being used for a
17892 submission service. If the expansion is forced to fail, the &%check_srv%&
17893 option is ignored, and the router proceeds to look for MX records in the
17894 normal way.
17895
17896 When the expansion succeeds, the router searches first for SRV records for
17897 the given service (it assumes TCP protocol). A single SRV record with a
17898 host name that consists of just a single dot indicates &"no such service for
17899 this domain"&; if this is encountered, the router declines. If other kinds of
17900 SRV record are found, they are used to construct a host list for delivery
17901 according to the rules of RFC 2782. MX records are not sought in this case.
17902
17903 When no SRV records are found, MX records (and address records) are sought in
17904 the traditional way. In other words, SRV records take precedence over MX
17905 records, just as MX records take precedence over address records. Note that
17906 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17907 defined it. It is apparently believed that MX records are sufficient for email
17908 and that SRV records should not be used for this purpose. However, SRV records
17909 have an additional &"weight"& feature which some people might find useful when
17910 trying to split an SMTP load between hosts of different power.
17911
17912 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17913 when there is a DNS lookup error.
17914
17915
17916
17917 .option dnssec_request_domains dnslookup "domain list&!!" unset
17918 .cindex "MX record" "security"
17919 .cindex "DNSSEC" "MX lookup"
17920 .cindex "security" "MX lookup"
17921 .cindex "DNS" "DNSSEC"
17922 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17923 the dnssec request bit set.
17924 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17925
17926
17927
17928 .option dnssec_require_domains dnslookup "domain list&!!" unset
17929 .cindex "MX record" "security"
17930 .cindex "DNSSEC" "MX lookup"
17931 .cindex "security" "MX lookup"
17932 .cindex "DNS" "DNSSEC"
17933 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17934 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17935 (AD bit) set wil be ignored and logged as a host-lookup failure.
17936 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17937
17938
17939
17940 .option mx_domains dnslookup "domain list&!!" unset
17941 .cindex "MX record" "required to exist"
17942 .cindex "SRV record" "required to exist"
17943 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17944 record in order to be recognized. (The name of this option could be improved.)
17945 For example, if all the mail hosts in &'fict.example'& are known to have MX
17946 records, except for those in &'discworld.fict.example'&, you could use this
17947 setting:
17948 .code
17949 mx_domains = ! *.discworld.fict.example : *.fict.example
17950 .endd
17951 This specifies that messages addressed to a domain that matches the list but
17952 has no MX record should be bounced immediately instead of being routed using
17953 the address record.
17954
17955
17956 .option mx_fail_domains dnslookup "domain list&!!" unset
17957 If the DNS lookup for MX records for one of the domains in this list causes a
17958 DNS lookup error, Exim behaves as if no MX records were found. See section
17959 &<<SECTprowitdnsloo>>& for more discussion.
17960
17961
17962
17963
17964 .option qualify_single dnslookup boolean true
17965 .cindex "DNS" "resolver options"
17966 .cindex "DNS" "qualifying single-component names"
17967 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17968 lookups. Typically, but not standardly, this causes the resolver to qualify
17969 single-component names with the default domain. For example, on a machine
17970 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17971 &'thesaurus.ref.example'& inside the resolver. For details of what your
17972 resolver actually does, consult your man pages for &'resolver'& and
17973 &'resolv.conf'&.
17974
17975
17976
17977 .option rewrite_headers dnslookup boolean true
17978 .cindex "rewriting" "header lines"
17979 .cindex "header lines" "rewriting"
17980 If the domain name in the address that is being processed is not fully
17981 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17982 an address is specified as &'dormouse@teaparty'&, the domain might be
17983 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17984 occur as a result of setting the &%widen_domains%& option. If
17985 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17986 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17987 header lines of the message are rewritten with the full domain name.
17988
17989 This option should be turned off only when it is known that no message is
17990 ever going to be sent outside an environment where the abbreviation makes
17991 sense.
17992
17993 When an MX record is looked up in the DNS and matches a wildcard record, name
17994 servers normally return a record containing the name that has been looked up,
17995 making it impossible to detect whether a wildcard was present or not. However,
17996 some name servers have recently been seen to return the wildcard entry. If the
17997 name returned by a DNS lookup begins with an asterisk, it is not used for
17998 header rewriting.
17999
18000
18001 .option same_domain_copy_routing dnslookup boolean false
18002 .cindex "address" "copying routing"
18003 Addresses with the same domain are normally routed by the &(dnslookup)& router
18004 to the same list of hosts. However, this cannot be presumed, because the router
18005 options and preconditions may refer to the local part of the address. By
18006 default, therefore, Exim routes each address in a message independently. DNS
18007 servers run caches, so repeated DNS lookups are not normally expensive, and in
18008 any case, personal messages rarely have more than a few recipients.
18009
18010 If you are running mailing lists with large numbers of subscribers at the same
18011 domain, and you are using a &(dnslookup)& router which is independent of the
18012 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18013 lookups for identical domains in one message. In this case, when &(dnslookup)&
18014 routes an address to a remote transport, any other unrouted addresses in the
18015 message that have the same domain are automatically given the same routing
18016 without processing them independently,
18017 provided the following conditions are met:
18018
18019 .ilist
18020 No router that processed the address specified &%headers_add%& or
18021 &%headers_remove%&.
18022 .next
18023 The router did not change the address in any way, for example, by &"widening"&
18024 the domain.
18025 .endlist
18026
18027
18028
18029
18030 .option search_parents dnslookup boolean false
18031 .cindex "DNS" "resolver options"
18032 When this option is true, the resolver option RES_DNSRCH is set for DNS
18033 lookups. This is different from the &%qualify_single%& option in that it
18034 applies to domains containing dots. Typically, but not standardly, it causes
18035 the resolver to search for the name in the current domain and in parent
18036 domains. For example, on a machine in the &'fict.example'& domain, if looking
18037 up &'teaparty.wonderland'& failed, the resolver would try
18038 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18039 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18040
18041 Setting this option true can cause problems in domains that have a wildcard MX
18042 record, because any domain that does not have its own MX record matches the
18043 local wildcard.
18044
18045
18046
18047 .option srv_fail_domains dnslookup "domain list&!!" unset
18048 If the DNS lookup for SRV records for one of the domains in this list causes a
18049 DNS lookup error, Exim behaves as if no SRV records were found. See section
18050 &<<SECTprowitdnsloo>>& for more discussion.
18051
18052
18053
18054
18055 .option widen_domains dnslookup "string list" unset
18056 .cindex "domain" "partial; widening"
18057 If a DNS lookup fails and this option is set, each of its strings in turn is
18058 added onto the end of the domain, and the lookup is tried again. For example,
18059 if
18060 .code
18061 widen_domains = fict.example:ref.example
18062 .endd
18063 is set and a lookup of &'klingon.dictionary'& fails,
18064 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18065 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18066 and &%search_parents%& options can cause some widening to be undertaken inside
18067 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18068 when verifying, unless &%rewrite_headers%& is false (not the default).
18069
18070
18071 .section "Effect of qualify_single and search_parents" "SECID119"
18072 When a domain from an envelope recipient is changed by the resolver as a result
18073 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18074 corresponding address in the message's header lines unless &%rewrite_headers%&
18075 is set false. Exim then re-routes the address, using the full domain.
18076
18077 These two options affect only the DNS lookup that takes place inside the router
18078 for the domain of the address that is being routed. They do not affect lookups
18079 such as that implied by
18080 .code
18081 domains = @mx_any
18082 .endd
18083 that may happen while processing a router precondition before the router is
18084 entered. No widening ever takes place for these lookups.
18085 .ecindex IIDdnsrou1
18086 .ecindex IIDdnsrou2
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096 . ////////////////////////////////////////////////////////////////////////////
18097 . ////////////////////////////////////////////////////////////////////////////
18098
18099 .chapter "The ipliteral router" "CHID5"
18100 .cindex "&(ipliteral)& router"
18101 .cindex "domain literal" "routing"
18102 .cindex "routers" "&(ipliteral)&"
18103 This router has no private options. Unless it is being used purely for
18104 verification (see &%verify_only%&) a transport is required to be defined by the
18105 generic &%transport%& option. The router accepts the address if its domain part
18106 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18107 router handles the address
18108 .code
18109 root@[192.168.1.1]
18110 .endd
18111 by setting up delivery to the host with that IP address. IPv4 domain literals
18112 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18113 are similar, but the address is preceded by &`ipv6:`&. For example:
18114 .code
18115 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18116 .endd
18117 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18118 grounds that sooner or later somebody will try it.
18119
18120 .oindex "&%self%&" "in &(ipliteral)& router"
18121 If the IP address matches something in &%ignore_target_hosts%&, the router
18122 declines. If an IP literal turns out to refer to the local host, the generic
18123 &%self%& option determines what happens.
18124
18125 The RFCs require support for domain literals; however, their use is
18126 controversial in today's Internet. If you want to use this router, you must
18127 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18128 Exim will not recognize the domain literal syntax in addresses.
18129
18130
18131
18132 . ////////////////////////////////////////////////////////////////////////////
18133 . ////////////////////////////////////////////////////////////////////////////
18134
18135 .chapter "The iplookup router" "CHID6"
18136 .cindex "&(iplookup)& router"
18137 .cindex "routers" "&(iplookup)&"
18138 The &(iplookup)& router was written to fulfil a specific requirement in
18139 Cambridge University (which in fact no longer exists). For this reason, it is
18140 not included in the binary of Exim by default. If you want to include it, you
18141 must set
18142 .code
18143 ROUTER_IPLOOKUP=yes
18144 .endd
18145 in your &_Local/Makefile_& configuration file.
18146
18147 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18148 connection to one or more specific hosts. The host can then return the same or
18149 a different address &-- in effect rewriting the recipient address in the
18150 message's envelope. The new address is then passed on to subsequent routers. If
18151 this process fails, the address can be passed on to other routers, or delivery
18152 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18153 must not be specified for it.
18154
18155 .cindex "options" "&(iplookup)& router"
18156 .option hosts iplookup string unset
18157 This option must be supplied. Its value is a colon-separated list of host
18158 names. The hosts are looked up using &[gethostbyname()]&
18159 (or &[getipnodebyname()]& when available)
18160 and are tried in order until one responds to the query. If none respond, what
18161 happens is controlled by &%optional%&.
18162
18163
18164 .option optional iplookup boolean false
18165 If &%optional%& is true, if no response is obtained from any host, the address
18166 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18167 delivery to the address is deferred.
18168
18169
18170 .option port iplookup integer 0
18171 .cindex "port" "&(iplookup)& router"
18172 This option must be supplied. It specifies the port number for the TCP or UDP
18173 call.
18174
18175
18176 .option protocol iplookup string udp
18177 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18178 protocols is to be used.
18179
18180
18181 .option query iplookup string&!! "see below"
18182 This defines the content of the query that is sent to the remote hosts. The
18183 default value is:
18184 .code
18185 $local_part@$domain $local_part@$domain
18186 .endd
18187 The repetition serves as a way of checking that a response is to the correct
18188 query in the default case (see &%response_pattern%& below).
18189
18190
18191 .option reroute iplookup string&!! unset
18192 If this option is not set, the rerouted address is precisely the byte string
18193 returned by the remote host, up to the first white space, if any. If set, the
18194 string is expanded to form the rerouted address. It can include parts matched
18195 in the response by &%response_pattern%& by means of numeric variables such as
18196 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18197 whether or not a pattern is in use. In all cases, the rerouted address must end
18198 up in the form &'local_part@domain'&.
18199
18200
18201 .option response_pattern iplookup string unset
18202 This option can be set to a regular expression that is applied to the string
18203 returned from the remote host. If the pattern does not match the response, the
18204 router declines. If &%response_pattern%& is not set, no checking of the
18205 response is done, unless the query was defaulted, in which case there is a
18206 check that the text returned after the first white space is the original
18207 address. This checks that the answer that has been received is in response to
18208 the correct question. For example, if the response is just a new domain, the
18209 following could be used:
18210 .code
18211 response_pattern = ^([^@]+)$
18212 reroute = $local_part@$1
18213 .endd
18214
18215 .option timeout iplookup time 5s
18216 This specifies the amount of time to wait for a response from the remote
18217 machine. The same timeout is used for the &[connect()]& function for a TCP
18218 call. It does not apply to UDP.
18219
18220
18221
18222
18223 . ////////////////////////////////////////////////////////////////////////////
18224 . ////////////////////////////////////////////////////////////////////////////
18225
18226 .chapter "The manualroute router" "CHID7"
18227 .scindex IIDmanrou1 "&(manualroute)& router"
18228 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18229 .cindex "domain" "manually routing"
18230 The &(manualroute)& router is so-called because it provides a way of manually
18231 routing an address according to its domain. It is mainly used when you want to
18232 route addresses to remote hosts according to your own rules, bypassing the
18233 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18234 route to local transports, a facility that may be useful if you want to save
18235 messages for dial-in hosts in local files.
18236
18237 The &(manualroute)& router compares a list of domain patterns with the domain
18238 it is trying to route. If there is no match, the router declines. Each pattern
18239 has associated with it a list of hosts and some other optional data, which may
18240 include a transport. The combination of a pattern and its data is called a
18241 &"routing rule"&. For patterns that do not have an associated transport, the
18242 generic &%transport%& option must specify a transport, unless the router is
18243 being used purely for verification (see &%verify_only%&).
18244
18245 .vindex "&$host$&"
18246 In the case of verification, matching the domain pattern is sufficient for the
18247 router to accept the address. When actually routing an address for delivery,
18248 an address that matches a domain pattern is queued for the associated
18249 transport. If the transport is not a local one, a host list must be associated
18250 with the pattern; IP addresses are looked up for the hosts, and these are
18251 passed to the transport along with the mail address. For local transports, a
18252 host list is optional. If it is present, it is passed in &$host$& as a single
18253 text string.
18254
18255 The list of routing rules can be provided as an inline string in
18256 &%route_list%&, or the data can be obtained by looking up the domain in a file
18257 or database by setting &%route_data%&. Only one of these settings may appear in
18258 any one instance of &(manualroute)&. The format of routing rules is described
18259 below, following the list of private options.
18260
18261
18262 .section "Private options for manualroute" "SECTprioptman"
18263
18264 .cindex "options" "&(manualroute)& router"
18265 The private options for the &(manualroute)& router are as follows:
18266
18267 .option host_all_ignored manualroute string defer
18268 See &%host_find_failed%&.
18269
18270 .option host_find_failed manualroute string freeze
18271 This option controls what happens when &(manualroute)& tries to find an IP
18272 address for a host, and the host does not exist. The option can be set to one
18273 of the following values:
18274 .code
18275 decline
18276 defer
18277 fail
18278 freeze
18279 ignore
18280 pass
18281 .endd
18282 The default (&"freeze"&) assumes that this state is a serious configuration
18283 error. The difference between &"pass"& and &"decline"& is that the former
18284 forces the address to be passed to the next router (or the router defined by
18285 &%pass_router%&),
18286 .oindex "&%more%&"
18287 overriding &%no_more%&, whereas the latter passes the address to the next
18288 router only if &%more%& is true.
18289
18290 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18291 cannot be found. If all the hosts in the list are ignored, the behaviour is
18292 controlled by the &%host_all_ignored%& option. This takes the same values
18293 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18294
18295 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18296 state; if a host lookup gets a temporary error, delivery is deferred unless the
18297 generic &%pass_on_timeout%& option is set.
18298
18299
18300 .option hosts_randomize manualroute boolean false
18301 .cindex "randomized host list"
18302 .cindex "host" "list of; randomized"
18303 If this option is set, the order of the items in a host list in a routing rule
18304 is randomized each time the list is used, unless an option in the routing rule
18305 overrides (see below). Randomizing the order of a host list can be used to do
18306 crude load sharing. However, if more than one mail address is routed by the
18307 same router to the same host list, the host lists are considered to be the same
18308 (even though they may be randomized into different orders) for the purpose of
18309 deciding whether to batch the deliveries into a single SMTP transaction.
18310
18311 When &%hosts_randomize%& is true, a host list may be split
18312 into groups whose order is separately randomized. This makes it possible to
18313 set up MX-like behaviour. The boundaries between groups are indicated by an
18314 item that is just &`+`& in the host list. For example:
18315 .code
18316 route_list = * host1:host2:host3:+:host4:host5
18317 .endd
18318 The order of the first three hosts and the order of the last two hosts is
18319 randomized for each use, but the first three always end up before the last two.
18320 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18321 randomized host list is passed to an &(smtp)& transport that also has
18322 &%hosts_randomize set%&, the list is not re-randomized.
18323
18324
18325 .option route_data manualroute string&!! unset
18326 If this option is set, it must expand to yield the data part of a routing rule.
18327 Typically, the expansion string includes a lookup based on the domain. For
18328 example:
18329 .code
18330 route_data = ${lookup{$domain}dbm{/etc/routes}}
18331 .endd
18332 If the expansion is forced to fail, or the result is an empty string, the
18333 router declines. Other kinds of expansion failure cause delivery to be
18334 deferred.
18335
18336
18337 .option route_list manualroute "string list" unset
18338 This string is a list of routing rules, in the form defined below. Note that,
18339 unlike most string lists, the items are separated by semicolons. This is so
18340 that they may contain colon-separated host lists.
18341
18342
18343 .option same_domain_copy_routing manualroute boolean false
18344 .cindex "address" "copying routing"
18345 Addresses with the same domain are normally routed by the &(manualroute)&
18346 router to the same list of hosts. However, this cannot be presumed, because the
18347 router options and preconditions may refer to the local part of the address. By
18348 default, therefore, Exim routes each address in a message independently. DNS
18349 servers run caches, so repeated DNS lookups are not normally expensive, and in
18350 any case, personal messages rarely have more than a few recipients.
18351
18352 If you are running mailing lists with large numbers of subscribers at the same
18353 domain, and you are using a &(manualroute)& router which is independent of the
18354 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18355 lookups for identical domains in one message. In this case, when
18356 &(manualroute)& routes an address to a remote transport, any other unrouted
18357 addresses in the message that have the same domain are automatically given the
18358 same routing without processing them independently. However, this is only done
18359 if &%headers_add%& and &%headers_remove%& are unset.
18360
18361
18362
18363
18364 .section "Routing rules in route_list" "SECID120"
18365 The value of &%route_list%& is a string consisting of a sequence of routing
18366 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18367 entered as two semicolons. Alternatively, the list separator can be changed as
18368 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18369 Empty rules are ignored. The format of each rule is
18370 .display
18371 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18372 .endd
18373 The following example contains two rules, each with a simple domain pattern and
18374 no options:
18375 .code
18376 route_list = \
18377   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18378   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18379 .endd
18380 The three parts of a rule are separated by white space. The pattern and the
18381 list of hosts can be enclosed in quotes if necessary, and if they are, the
18382 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18383 single domain pattern, which is the only mandatory item in the rule. The
18384 pattern is in the same format as one item in a domain list (see section
18385 &<<SECTdomainlist>>&),
18386 except that it may not be the name of an interpolated file.
18387 That is, it may be wildcarded, or a regular expression, or a file or database
18388 lookup (with semicolons doubled, because of the use of semicolon as a separator
18389 in a &%route_list%&).
18390
18391 The rules in &%route_list%& are searched in order until one of the patterns
18392 matches the domain that is being routed. The list of hosts and then options are
18393 then used as described below. If there is no match, the router declines. When
18394 &%route_list%& is set, &%route_data%& must not be set.
18395
18396
18397
18398 .section "Routing rules in route_data" "SECID121"
18399 The use of &%route_list%& is convenient when there are only a small number of
18400 routing rules. For larger numbers, it is easier to use a file or database to
18401 hold the routing information, and use the &%route_data%& option instead.
18402 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18403 Most commonly, &%route_data%& is set as a string that contains an
18404 expansion lookup. For example, suppose we place two routing rules in a file
18405 like this:
18406 .code
18407 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18408 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18409 .endd
18410 This data can be accessed by setting
18411 .code
18412 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18413 .endd
18414 Failure of the lookup results in an empty string, causing the router to
18415 decline. However, you do not have to use a lookup in &%route_data%&. The only
18416 requirement is that the result of expanding the string is a list of hosts,
18417 possibly followed by options, separated by white space. The list of hosts must
18418 be enclosed in quotes if it contains white space.
18419
18420
18421
18422
18423 .section "Format of the list of hosts" "SECID122"
18424 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18425 always separately expanded before use. If the expansion fails, the router
18426 declines. The result of the expansion must be a colon-separated list of names
18427 and/or IP addresses, optionally also including ports. The format of each item
18428 in the list is described in the next section. The list separator can be changed
18429 as described in section &<<SECTlistconstruct>>&.
18430
18431 If the list of hosts was obtained from a &%route_list%& item, the following
18432 variables are set during its expansion:
18433
18434 .ilist
18435 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18436 If the domain was matched against a regular expression, the numeric variables
18437 &$1$&, &$2$&, etc. may be set. For example:
18438 .code
18439 route_list = ^domain(\d+)   host-$1.text.example
18440 .endd
18441 .next
18442 &$0$& is always set to the entire domain.
18443 .next
18444 &$1$& is also set when partial matching is done in a file lookup.
18445
18446 .next
18447 .vindex "&$value$&"
18448 If the pattern that matched the domain was a lookup item, the data that was
18449 looked up is available in the expansion variable &$value$&. For example:
18450 .code
18451 route_list = lsearch;;/some/file.routes  $value
18452 .endd
18453 .endlist
18454
18455 Note the doubling of the semicolon in the pattern that is necessary because
18456 semicolon is the default route list separator.
18457
18458
18459
18460 .section "Format of one host item" "SECTformatonehostitem"
18461 Each item in the list of hosts is either a host name or an IP address,
18462 optionally with an attached port number. When no port is given, an IP address
18463 is not enclosed in brackets. When a port is specified, it overrides the port
18464 specification on the transport. The port is separated from the name or address
18465 by a colon. This leads to some complications:
18466
18467 .ilist
18468 Because colon is the default separator for the list of hosts, either
18469 the colon that specifies a port must be doubled, or the list separator must
18470 be changed. The following two examples have the same effect:
18471 .code
18472 route_list = * "host1.tld::1225 : host2.tld::1226"
18473 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18474 .endd
18475 .next
18476 When IPv6 addresses are involved, it gets worse, because they contain
18477 colons of their own. To make this case easier, it is permitted to
18478 enclose an IP address (either v4 or v6) in square brackets if a port
18479 number follows. For example:
18480 .code
18481 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18482 .endd
18483 .endlist
18484
18485 .section "How the list of hosts is used" "SECThostshowused"
18486 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18487 the hosts is tried, in the order specified, when carrying out the SMTP
18488 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18489 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18490 transport.
18491
18492 Hosts may be listed by name or by IP address. An unadorned name in the list of
18493 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18494 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18495 records in the DNS. For example:
18496 .code
18497 route_list = *  x.y.z:p.q.r/MX:e.f.g
18498 .endd
18499 If this feature is used with a port specifier, the port must come last. For
18500 example:
18501 .code
18502 route_list = *  dom1.tld/mx::1225
18503 .endd
18504 If the &%hosts_randomize%& option is set, the order of the items in the list is
18505 randomized before any lookups are done. Exim then scans the list; for any name
18506 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18507 be an interface on the local host and the item is not the first in the list,
18508 Exim discards it and any subsequent items. If it is the first item, what
18509 happens is controlled by the
18510 .oindex "&%self%&" "in &(manualroute)& router"
18511 &%self%& option of the router.
18512
18513 A name on the list that is followed by &`/MX`& is replaced with the list of
18514 hosts obtained by looking up MX records for the name. This is always a DNS
18515 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18516 below) are not relevant here. The order of these hosts is determined by the
18517 preference values in the MX records, according to the usual rules. Because
18518 randomizing happens before the MX lookup, it does not affect the order that is
18519 defined by MX preferences.
18520
18521 If the local host is present in the sublist obtained from MX records, but is
18522 not the most preferred host in that list, it and any equally or less
18523 preferred hosts are removed before the sublist is inserted into the main list.
18524
18525 If the local host is the most preferred host in the MX list, what happens
18526 depends on where in the original list of hosts the &`/MX`& item appears. If it
18527 is not the first item (that is, there are previous hosts in the main list),
18528 Exim discards this name and any subsequent items in the main list.
18529
18530 If the MX item is first in the list of hosts, and the local host is the
18531 most preferred host, what happens is controlled by the &%self%& option of the
18532 router.
18533
18534 DNS failures when lookup up the MX records are treated in the same way as DNS
18535 failures when looking up IP addresses: &%pass_on_timeout%& and
18536 &%host_find_failed%& are used when relevant.
18537
18538 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18539 whether obtained from an MX lookup or not.
18540
18541
18542
18543 .section "How the options are used" "SECThowoptused"
18544 The options are a sequence of words; in practice no more than three are ever
18545 present. One of the words can be the name of a transport; this overrides the
18546 &%transport%& option on the router for this particular routing rule only. The
18547 other words (if present) control randomization of the list of hosts on a
18548 per-rule basis, and how the IP addresses of the hosts are to be found when
18549 routing to a remote transport. These options are as follows:
18550
18551 .ilist
18552 &%randomize%&: randomize the order of the hosts in this list, overriding the
18553 setting of &%hosts_randomize%& for this routing rule only.
18554 .next
18555 &%no_randomize%&: do not randomize the order of the hosts in this list,
18556 overriding the setting of &%hosts_randomize%& for this routing rule only.
18557 .next
18558 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18559 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18560 also look in &_/etc/hosts_& or other sources of information.
18561 .next
18562 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18563 no address records are found. If there is a temporary DNS error (such as a
18564 timeout), delivery is deferred.
18565 .endlist
18566
18567 For example:
18568 .code
18569 route_list = domain1  host1:host2:host3  randomize bydns;\
18570              domain2  host4:host5
18571 .endd
18572 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18573 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18574 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18575 or &[gethostbyname()]&, and the result of the lookup is the result of that
18576 call.
18577
18578 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18579 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18580 instead of TRY_AGAIN. That is why the default action is to try a DNS
18581 lookup first. Only if that gives a definite &"no such host"& is the local
18582 function called.
18583
18584
18585
18586 If no IP address for a host can be found, what happens is controlled by the
18587 &%host_find_failed%& option.
18588
18589 .vindex "&$host$&"
18590 When an address is routed to a local transport, IP addresses are not looked up.
18591 The host list is passed to the transport in the &$host$& variable.
18592
18593
18594
18595 .section "Manualroute examples" "SECID123"
18596 In some of the examples that follow, the presence of the &%remote_smtp%&
18597 transport, as defined in the default configuration file, is assumed:
18598
18599 .ilist
18600 .cindex "smart host" "example router"
18601 The &(manualroute)& router can be used to forward all external mail to a
18602 &'smart host'&. If you have set up, in the main part of the configuration, a
18603 named domain list that contains your local domains, for example:
18604 .code
18605 domainlist local_domains = my.domain.example
18606 .endd
18607 You can arrange for all other domains to be routed to a smart host by making
18608 your first router something like this:
18609 .code
18610 smart_route:
18611   driver = manualroute
18612   domains = !+local_domains
18613   transport = remote_smtp
18614   route_list = * smarthost.ref.example
18615 .endd
18616 This causes all non-local addresses to be sent to the single host
18617 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18618 they are tried in order
18619 (but you can use &%hosts_randomize%& to vary the order each time).
18620 Another way of configuring the same thing is this:
18621 .code
18622 smart_route:
18623   driver = manualroute
18624   transport = remote_smtp
18625   route_list = !+local_domains  smarthost.ref.example
18626 .endd
18627 There is no difference in behaviour between these two routers as they stand.
18628 However, they behave differently if &%no_more%& is added to them. In the first
18629 example, the router is skipped if the domain does not match the &%domains%&
18630 precondition; the following router is always tried. If the router runs, it
18631 always matches the domain and so can never decline. Therefore, &%no_more%&
18632 would have no effect. In the second case, the router is never skipped; it
18633 always runs. However, if it doesn't match the domain, it declines. In this case
18634 &%no_more%& would prevent subsequent routers from running.
18635
18636 .next
18637 .cindex "mail hub example"
18638 A &'mail hub'& is a host which receives mail for a number of domains via MX
18639 records in the DNS and delivers it via its own private routing mechanism. Often
18640 the final destinations are behind a firewall, with the mail hub being the one
18641 machine that can connect to machines both inside and outside the firewall. The
18642 &(manualroute)& router is usually used on a mail hub to route incoming messages
18643 to the correct hosts. For a small number of domains, the routing can be inline,
18644 using the &%route_list%& option, but for a larger number a file or database
18645 lookup is easier to manage.
18646
18647 If the domain names are in fact the names of the machines to which the mail is
18648 to be sent by the mail hub, the configuration can be quite simple. For
18649 example:
18650 .code
18651 hub_route:
18652   driver = manualroute
18653   transport = remote_smtp
18654   route_list = *.rhodes.tvs.example  $domain
18655 .endd
18656 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18657 whose names are the same as the mail domains. A similar approach can be taken
18658 if the host name can be obtained from the domain name by a string manipulation
18659 that the expansion facilities can handle. Otherwise, a lookup based on the
18660 domain can be used to find the host:
18661 .code
18662 through_firewall:
18663   driver = manualroute
18664   transport = remote_smtp
18665   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18666 .endd
18667 The result of the lookup must be the name or IP address of the host (or
18668 hosts) to which the address is to be routed. If the lookup fails, the route
18669 data is empty, causing the router to decline. The address then passes to the
18670 next router.
18671
18672 .next
18673 .cindex "batched SMTP output example"
18674 .cindex "SMTP" "batched outgoing; example"
18675 You can use &(manualroute)& to deliver messages to pipes or files in batched
18676 SMTP format for onward transportation by some other means. This is one way of
18677 storing mail for a dial-up host when it is not connected. The route list entry
18678 can be as simple as a single domain name in a configuration like this:
18679 .code
18680 save_in_file:
18681   driver = manualroute
18682   transport = batchsmtp_appendfile
18683   route_list = saved.domain.example
18684 .endd
18685 though often a pattern is used to pick up more than one domain. If there are
18686 several domains or groups of domains with different transport requirements,
18687 different transports can be listed in the routing information:
18688 .code
18689 save_in_file:
18690   driver = manualroute
18691   route_list = \
18692     *.saved.domain1.example  $domain  batch_appendfile; \
18693     *.saved.domain2.example  \
18694       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18695       batch_pipe
18696 .endd
18697 .vindex "&$domain$&"
18698 .vindex "&$host$&"
18699 The first of these just passes the domain in the &$host$& variable, which
18700 doesn't achieve much (since it is also in &$domain$&), but the second does a
18701 file lookup to find a value to pass, causing the router to decline to handle
18702 the address if the lookup fails.
18703
18704 .next
18705 .cindex "UUCP" "example of router for"
18706 Routing mail directly to UUCP software is a specific case of the use of
18707 &(manualroute)& in a gateway to another mail environment. This is an example of
18708 one way it can be done:
18709 .code
18710 # Transport
18711 uucp:
18712   driver = pipe
18713   user = nobody
18714   command = /usr/local/bin/uux -r - \
18715     ${substr_-5:$host}!rmail ${local_part}
18716   return_fail_output = true
18717
18718 # Router
18719 uucphost:
18720   transport = uucp
18721   driver = manualroute
18722   route_data = \
18723     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18724 .endd
18725 The file &_/usr/local/exim/uucphosts_& contains entries like
18726 .code
18727 darksite.ethereal.example:           darksite.UUCP
18728 .endd
18729 It can be set up more simply without adding and removing &".UUCP"& but this way
18730 makes clear the distinction between the domain name
18731 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18732 .endlist
18733 .ecindex IIDmanrou1
18734 .ecindex IIDmanrou2
18735
18736
18737
18738
18739
18740
18741
18742
18743 . ////////////////////////////////////////////////////////////////////////////
18744 . ////////////////////////////////////////////////////////////////////////////
18745
18746 .chapter "The queryprogram router" "CHAPdriverlast"
18747 .scindex IIDquerou1 "&(queryprogram)& router"
18748 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18749 .cindex "routing" "by external program"
18750 The &(queryprogram)& router routes an address by running an external command
18751 and acting on its output. This is an expensive way to route, and is intended
18752 mainly for use in lightly-loaded systems, or for performing experiments.
18753 However, if it is possible to use the precondition options (&%domains%&,
18754 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18755 be used in special cases, even on a busy host. There are the following private
18756 options:
18757 .cindex "options" "&(queryprogram)& router"
18758
18759 .option command queryprogram string&!! unset
18760 This option must be set. It specifies the command that is to be run. The
18761 command is split up into a command name and arguments, and then each is
18762 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18763 &<<CHAPpipetransport>>&).
18764
18765
18766 .option command_group queryprogram string unset
18767 .cindex "gid (group id)" "in &(queryprogram)& router"
18768 This option specifies a gid to be set when running the command while routing an
18769 address for deliver. It must be set if &%command_user%& specifies a numerical
18770 uid. If it begins with a digit, it is interpreted as the numerical value of the
18771 gid. Otherwise it is looked up using &[getgrnam()]&.
18772
18773
18774 .option command_user queryprogram string unset
18775 .cindex "uid (user id)" "for &(queryprogram)&"
18776 This option must be set. It specifies the uid which is set when running the
18777 command while routing an address for delivery. If the value begins with a digit,
18778 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18779 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18780 not set, a value for the gid also.
18781
18782 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18783 root, which it does during a normal delivery in a conventional configuration.
18784 However, when an address is being verified during message reception, Exim is
18785 usually running as the Exim user, not as root. If the &(queryprogram)& router
18786 is called from a non-root process, Exim cannot change uid or gid before running
18787 the command. In this circumstance the command runs under the current uid and
18788 gid.
18789
18790
18791 .option current_directory queryprogram string /
18792 This option specifies an absolute path which is made the current directory
18793 before running the command.
18794
18795
18796 .option timeout queryprogram time 1h
18797 If the command does not complete within the timeout period, its process group
18798 is killed and the message is frozen. A value of zero time specifies no
18799 timeout.
18800
18801
18802 The standard output of the command is connected to a pipe, which is read when
18803 the command terminates. It should consist of a single line of output,
18804 containing up to five fields, separated by white space. The maximum length of
18805 the line is 1023 characters. Longer lines are silently truncated. The first
18806 field is one of the following words (case-insensitive):
18807
18808 .ilist
18809 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18810 below).
18811 .next
18812 &'Decline'&: the router declines; pass the address to the next router, unless
18813 &%no_more%& is set.
18814 .next
18815 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18816 subsequent text on the line is an error message. If the router is run as part
18817 of address verification during an incoming SMTP message, the message is
18818 included in the SMTP response.
18819 .next
18820 &'Defer'&: routing could not be completed at this time; try again later. Any
18821 subsequent text on the line is an error message which is logged. It is not
18822 included in any SMTP response.
18823 .next
18824 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18825 .next
18826 &'Pass'&: pass the address to the next router (or the router specified by
18827 &%pass_router%&), overriding &%no_more%&.
18828 .next
18829 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18830 new addresses, which are routed independently, starting with the first router,
18831 or the router specified by &%redirect_router%&, if set.
18832 .endlist
18833
18834 When the first word is &'accept'&, the remainder of the line consists of a
18835 number of keyed data values, as follows (split into two lines here, to fit on
18836 the page):
18837 .code
18838 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18839 LOOKUP=byname|bydns DATA=<text>
18840 .endd
18841 The data items can be given in any order, and all are optional. If no transport
18842 is included, the transport specified by the generic &%transport%& option is
18843 used. The list of hosts and the lookup type are needed only if the transport is
18844 an &(smtp)& transport that does not itself supply a list of hosts.
18845
18846 The format of the list of hosts is the same as for the &(manualroute)& router.
18847 As well as host names and IP addresses with optional port numbers, as described
18848 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18849 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18850 (see section &<<SECThostshowused>>&).
18851
18852 If the lookup type is not specified, Exim behaves as follows when trying to
18853 find an IP address for each host: First, a DNS lookup is done. If this yields
18854 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18855 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18856 result of the lookup is the result of that call.
18857
18858 .vindex "&$address_data$&"
18859 If the DATA field is set, its value is placed in the &$address_data$&
18860 variable. For example, this return line
18861 .code
18862 accept hosts=x1.y.example:x2.y.example data="rule1"
18863 .endd
18864 routes the address to the default transport, passing a list of two hosts. When
18865 the transport runs, the string &"rule1"& is in &$address_data$&.
18866 .ecindex IIDquerou1
18867 .ecindex IIDquerou2
18868
18869
18870
18871
18872 . ////////////////////////////////////////////////////////////////////////////
18873 . ////////////////////////////////////////////////////////////////////////////
18874
18875 .chapter "The redirect router" "CHAPredirect"
18876 .scindex IIDredrou1 "&(redirect)& router"
18877 .scindex IIDredrou2 "routers" "&(redirect)&"
18878 .cindex "alias file" "in a &(redirect)& router"
18879 .cindex "address redirection" "&(redirect)& router"
18880 The &(redirect)& router handles several kinds of address redirection. Its most
18881 common uses are for resolving local part aliases from a central alias file
18882 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18883 files, but it has many other potential uses. The incoming address can be
18884 redirected in several different ways:
18885
18886 .ilist
18887 It can be replaced by one or more new addresses which are themselves routed
18888 independently.
18889 .next
18890 It can be routed to be delivered to a given file or directory.
18891 .next
18892 It can be routed to be delivered to a specified pipe command.
18893 .next
18894 It can cause an automatic reply to be generated.
18895 .next
18896 It can be forced to fail, optionally with a custom error message.
18897 .next
18898 It can be temporarily deferred, optionally with a custom message.
18899 .next
18900 It can be discarded.
18901 .endlist
18902
18903 The generic &%transport%& option must not be set for &(redirect)& routers.
18904 However, there are some private options which define transports for delivery to
18905 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18906 &%pipe_transport%& and &%reply_transport%& descriptions below.
18907
18908
18909
18910 .section "Redirection data" "SECID124"
18911 The router operates by interpreting a text string which it obtains either by
18912 expanding the contents of the &%data%& option, or by reading the entire
18913 contents of a file whose name is given in the &%file%& option. These two
18914 options are mutually exclusive. The first is commonly used for handling system
18915 aliases, in a configuration like this:
18916 .code
18917 system_aliases:
18918   driver = redirect
18919   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18920 .endd
18921 If the lookup fails, the expanded string in this example is empty. When the
18922 expansion of &%data%& results in an empty string, the router declines. A forced
18923 expansion failure also causes the router to decline; other expansion failures
18924 cause delivery to be deferred.
18925
18926 A configuration using &%file%& is commonly used for handling users'
18927 &_.forward_& files, like this:
18928 .code
18929 userforward:
18930   driver = redirect
18931   check_local_user
18932   file = $home/.forward
18933   no_verify
18934 .endd
18935 If the file does not exist, or causes no action to be taken (for example, it is
18936 empty or consists only of comments), the router declines. &*Warning*&: This
18937 is not the case when the file contains syntactically valid items that happen to
18938 yield empty addresses, for example, items containing only RFC 2822 address
18939 comments.
18940
18941
18942
18943 .section "Forward files and address verification" "SECID125"
18944 .cindex "address redirection" "while verifying"
18945 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18946 &_.forward_& files, as in the example above. There are two reasons for this:
18947
18948 .ilist
18949 When Exim is receiving an incoming SMTP message from a remote host, it is
18950 running under the Exim uid, not as root. Exim is unable to change uid to read
18951 the file as the user, and it may not be able to read it as the Exim user. So in
18952 practice the router may not be able to operate.
18953 .next
18954 However, even when the router can operate, the existence of a &_.forward_& file
18955 is unimportant when verifying an address. What should be checked is whether the
18956 local part is a valid user name or not. Cutting out the redirection processing
18957 saves some resources.
18958 .endlist
18959
18960
18961
18962
18963
18964
18965 .section "Interpreting redirection data" "SECID126"
18966 .cindex "Sieve filter" "specifying in redirection data"
18967 .cindex "filter" "specifying in redirection data"
18968 The contents of the data string, whether obtained from &%data%& or &%file%&,
18969 can be interpreted in two different ways:
18970
18971 .ilist
18972 If the &%allow_filter%& option is set true, and the data begins with the text
18973 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18974 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18975 respectively. Details of the syntax and semantics of filter files are described
18976 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18977 document is intended for use by end users.
18978 .next
18979 Otherwise, the data must be a comma-separated list of redirection items, as
18980 described in the next section.
18981 .endlist
18982
18983 When a message is redirected to a file (a &"mail folder"&), the file name given
18984 in a non-filter redirection list must always be an absolute path. A filter may
18985 generate a relative path &-- how this is handled depends on the transport's
18986 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18987 for the &(appendfile)& transport.
18988
18989
18990
18991 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18992 .cindex "address redirection" "non-filter list items"
18993 When the redirection data is not an Exim or Sieve filter, for example, if it
18994 comes from a conventional alias or forward file, it consists of a list of
18995 addresses, file names, pipe commands, or certain special items (see section
18996 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18997 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18998 depending on their default values. The items in the list are separated by
18999 commas or newlines.
19000 If a comma is required in an item, the entire item must be enclosed in double
19001 quotes.
19002
19003 Lines starting with a # character are comments, and are ignored, and # may
19004 also appear following a comma, in which case everything between the # and the
19005 next newline character is ignored.
19006
19007 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19008 double quotes are retained because some forms of mail address require their use
19009 (but never to enclose the entire address). In the following description,
19010 &"item"& refers to what remains after any surrounding double quotes have been
19011 removed.
19012
19013 .vindex "&$local_part$&"
19014 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19015 and the expansion contains a reference to &$local_part$&, you should make use
19016 of the &%quote_local_part%& expansion operator, in case the local part contains
19017 special characters. For example, to redirect all mail for the domain
19018 &'obsolete.example'&, retaining the existing local part, you could use this
19019 setting:
19020 .code
19021 data = ${quote_local_part:$local_part}@newdomain.example
19022 .endd
19023
19024
19025 .section "Redirecting to a local mailbox" "SECTredlocmai"
19026 .cindex "routing" "loops in"
19027 .cindex "loop" "while routing, avoidance of"
19028 .cindex "address redirection" "to local mailbox"
19029 A redirection item may safely be the same as the address currently under
19030 consideration. This does not cause a routing loop, because a router is
19031 automatically skipped if any ancestor of the address that is being processed
19032 is the same as the current address and was processed by the current router.
19033 Such an address is therefore passed to the following routers, so it is handled
19034 as if there were no redirection. When making this loop-avoidance test, the
19035 complete local part, including any prefix or suffix, is used.
19036
19037 .cindex "address redirection" "local part without domain"
19038 Specifying the same local part without a domain is a common usage in personal
19039 filter files when the user wants to have messages delivered to the local
19040 mailbox and also forwarded elsewhere. For example, the user whose login is
19041 &'cleo'& might have a &_.forward_& file containing this:
19042 .code
19043 cleo, cleopatra@egypt.example
19044 .endd
19045 .cindex "backslash in alias file"
19046 .cindex "alias file" "backslash in"
19047 For compatibility with other MTAs, such unqualified local parts may be
19048 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19049 it does make a difference if more than one domain is being handled
19050 synonymously.
19051
19052 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19053 2822 address that does not include a domain, the item is qualified using the
19054 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19055 addresses are qualified using the value in &%qualify_recipient%&, but you can
19056 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19057
19058 Care must be taken if there are alias names for local users.
19059 Consider an MTA handling a single local domain where the system alias file
19060 contains:
19061 .code
19062 Sam.Reman: spqr
19063 .endd
19064 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19065 messages in the local mailbox, and also forward copies elsewhere. He creates
19066 this forward file:
19067 .code
19068 Sam.Reman, spqr@reme.elsewhere.example
19069 .endd
19070 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19071 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19072 second time round, because it has previously routed it,
19073 and the following routers presumably cannot handle the alias. The forward file
19074 should really contain
19075 .code
19076 spqr, spqr@reme.elsewhere.example
19077 .endd
19078 but because this is such a common error, the &%check_ancestor%& option (see
19079 below) exists to provide a way to get round it. This is normally set on a
19080 &(redirect)& router that is handling users' &_.forward_& files.
19081
19082
19083
19084 .section "Special items in redirection lists" "SECTspecitredli"
19085 In addition to addresses, the following types of item may appear in redirection
19086 lists (that is, in non-filter redirection data):
19087
19088 .ilist
19089 .cindex "pipe" "in redirection list"
19090 .cindex "address redirection" "to pipe"
19091 An item is treated as a pipe command if it begins with &"|"& and does not parse
19092 as a valid RFC 2822 address that includes a domain. A transport for running the
19093 command must be specified by the &%pipe_transport%& option.
19094 Normally, either the router or the transport specifies a user and a group under
19095 which to run the delivery. The default is to use the Exim user and group.
19096
19097 Single or double quotes can be used for enclosing the individual arguments of
19098 the pipe command; no interpretation of escapes is done for single quotes. If
19099 the command contains a comma character, it is necessary to put the whole item
19100 in double quotes, for example:
19101 .code
19102 "|/some/command ready,steady,go"
19103 .endd
19104 since items in redirection lists are terminated by commas. Do not, however,
19105 quote just the command. An item such as
19106 .code
19107 |"/some/command ready,steady,go"
19108 .endd
19109 is interpreted as a pipe with a rather strange command name, and no arguments.
19110
19111 Note that the above example assumes that the text comes from a lookup source
19112 of some sort, so that the quotes are part of the data.  If composing a
19113 redirect router with a &%data%& option directly specifying this command, the
19114 quotes will be used by the configuration parser to define the extent of one
19115 string, but will not be passed down into the redirect router itself.  There
19116 are two main approaches to get around this: escape quotes to be part of the
19117 data itself, or avoid using this mechanism and instead create a custom
19118 transport with the &%command%& option set and reference that transport from
19119 an &%accept%& router.
19120
19121 .next
19122 .cindex "file" "in redirection list"
19123 .cindex "address redirection" "to file"
19124 An item is interpreted as a path name if it begins with &"/"& and does not
19125 parse as a valid RFC 2822 address that includes a domain. For example,
19126 .code
19127 /home/world/minbari
19128 .endd
19129 is treated as a file name, but
19130 .code
19131 /s=molari/o=babylon/@x400gate.way
19132 .endd
19133 is treated as an address. For a file name, a transport must be specified using
19134 the &%file_transport%& option. However, if the generated path name ends with a
19135 forward slash character, it is interpreted as a directory name rather than a
19136 file name, and &%directory_transport%& is used instead.
19137
19138 Normally, either the router or the transport specifies a user and a group under
19139 which to run the delivery. The default is to use the Exim user and group.
19140
19141 .cindex "&_/dev/null_&"
19142 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19143 bypassed at a high level, and the log entry shows &"**bypassed**"&
19144 instead of a transport name. In this case the user and group are not used.
19145
19146 .next
19147 .cindex "included address list"
19148 .cindex "address redirection" "included external list"
19149 If an item is of the form
19150 .code
19151 :include:<path name>
19152 .endd
19153 a list of further items is taken from the given file and included at that
19154 point. &*Note*&: Such a file can not be a filter file; it is just an
19155 out-of-line addition to the list. The items in the included list are separated
19156 by commas or newlines and are not subject to expansion. If this is the first
19157 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19158 the alias name. This example is incorrect:
19159 .code
19160 list1    :include:/opt/lists/list1
19161 .endd
19162 It must be given as
19163 .code
19164 list1:   :include:/opt/lists/list1
19165 .endd
19166 .next
19167 .cindex "address redirection" "to black hole"
19168 Sometimes you want to throw away mail to a particular local part. Making the
19169 &%data%& option expand to an empty string does not work, because that causes
19170 the router to decline. Instead, the alias item
19171 .cindex "black hole"
19172 .cindex "abandoning mail"
19173 &':blackhole:'& can be used. It does what its name implies. No delivery is
19174 done, and no error message is generated. This has the same effect as specifing
19175 &_/dev/null_& as a destination, but it can be independently disabled.
19176
19177 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19178 delivery is done for the original local part, even if other redirection items
19179 are present. If you are generating a multi-item list (for example, by reading a
19180 database) and need the ability to provide a no-op item, you must use
19181 &_/dev/null_&.
19182
19183 .next
19184 .cindex "delivery" "forcing failure"
19185 .cindex "delivery" "forcing deferral"
19186 .cindex "failing delivery" "forcing"
19187 .cindex "deferred delivery, forcing"
19188 .cindex "customizing" "failure message"
19189 An attempt to deliver a particular address can be deferred or forced to fail by
19190 redirection items of the form
19191 .code
19192 :defer:
19193 :fail:
19194 .endd
19195 respectively. When a redirection list contains such an item, it applies
19196 to the entire redirection; any other items in the list are ignored. Any
19197 text following &':fail:'& or &':defer:'& is placed in the error text
19198 associated with the failure. For example, an alias file might contain:
19199 .code
19200 X.Employee:  :fail: Gone away, no forwarding address
19201 .endd
19202 In the case of an address that is being verified from an ACL or as the subject
19203 of a
19204 .cindex "VRFY" "error text, display of"
19205 VRFY command, the text is included in the SMTP error response by
19206 default.
19207 .cindex "EXPN" "error text, display of"
19208 The text is not included in the response to an EXPN command. In non-SMTP cases
19209 the text is included in the error message that Exim generates.
19210
19211 .cindex "SMTP" "error codes"
19212 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19213 &':fail:'&. However, if the message starts with three digits followed by a
19214 space, optionally followed by an extended code of the form &'n.n.n'&, also
19215 followed by a space, and the very first digit is the same as the default error
19216 code, the code from the message is used instead. If the very first digit is
19217 incorrect, a panic error is logged, and the default code is used. You can
19218 suppress the use of the supplied code in a redirect router by setting the
19219 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19220 ignored.
19221
19222 .vindex "&$acl_verify_message$&"
19223 In an ACL, an explicitly provided message overrides the default, but the
19224 default message is available in the variable &$acl_verify_message$& and can
19225 therefore be included in a custom message if this is desired.
19226
19227 Normally the error text is the rest of the redirection list &-- a comma does
19228 not terminate it &-- but a newline does act as a terminator. Newlines are not
19229 normally present in alias expansions. In &(lsearch)& lookups they are removed
19230 as part of the continuation process, but they may exist in other kinds of
19231 lookup and in &':include:'& files.
19232
19233 During routing for message delivery (as opposed to verification), a redirection
19234 containing &':fail:'& causes an immediate failure of the incoming address,
19235 whereas &':defer:'& causes the message to remain on the queue so that a
19236 subsequent delivery attempt can happen at a later time. If an address is
19237 deferred for too long, it will ultimately fail, because the normal retry
19238 rules still apply.
19239
19240 .next
19241 .cindex "alias file" "exception to default"
19242 Sometimes it is useful to use a single-key search type with a default (see
19243 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19244 for exceptions to the default. These can be handled by aliasing them to
19245 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19246 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19247 results in an empty redirection list has the same effect.
19248 .endlist
19249
19250
19251 .section "Duplicate addresses" "SECTdupaddr"
19252 .cindex "duplicate addresses"
19253 .cindex "address duplicate, discarding"
19254 .cindex "pipe" "duplicated"
19255 Exim removes duplicate addresses from the list to which it is delivering, so as
19256 to deliver just one copy to each address. This does not apply to deliveries
19257 routed to pipes by different immediate parent addresses, but an indirect
19258 aliasing scheme of the type
19259 .code
19260 pipe:       |/some/command $local_part
19261 localpart1: pipe
19262 localpart2: pipe
19263 .endd
19264 does not work with a message that is addressed to both local parts, because
19265 when the second is aliased to the intermediate local part &"pipe"& it gets
19266 discarded as being the same as a previously handled address. However, a scheme
19267 such as
19268 .code
19269 localpart1: |/some/command $local_part
19270 localpart2: |/some/command $local_part
19271 .endd
19272 does result in two different pipe deliveries, because the immediate parents of
19273 the pipes are distinct.
19274
19275
19276
19277 .section "Repeated redirection expansion" "SECID128"
19278 .cindex "repeated redirection expansion"
19279 .cindex "address redirection" "repeated for each delivery attempt"
19280 When a message cannot be delivered to all of its recipients immediately,
19281 leading to two or more delivery attempts, redirection expansion is carried out
19282 afresh each time for those addresses whose children were not all previously
19283 delivered. If redirection is being used as a mailing list, this can lead to new
19284 members of the list receiving copies of old messages. The &%one_time%& option
19285 can be used to avoid this.
19286
19287
19288 .section "Errors in redirection lists" "SECID129"
19289 .cindex "address redirection" "errors"
19290 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19291 error is skipped, and an entry is written to the main log. This may be useful
19292 for mailing lists that are automatically managed. Otherwise, if an error is
19293 detected while generating the list of new addresses, the original address is
19294 deferred. See also &%syntax_errors_to%&.
19295
19296
19297
19298 .section "Private options for the redirect router" "SECID130"
19299
19300 .cindex "options" "&(redirect)& router"
19301 The private options for the &(redirect)& router are as follows:
19302
19303
19304 .option allow_defer redirect boolean false
19305 Setting this option allows the use of &':defer:'& in non-filter redirection
19306 data, or the &%defer%& command in an Exim filter file.
19307
19308
19309 .option allow_fail redirect boolean false
19310 .cindex "failing delivery" "from filter"
19311 If this option is true, the &':fail:'& item can be used in a redirection list,
19312 and the &%fail%& command may be used in an Exim filter file.
19313
19314
19315 .option allow_filter redirect boolean false
19316 .cindex "filter" "enabling use of"
19317 .cindex "Sieve filter" "enabling use of"
19318 Setting this option allows Exim to interpret redirection data that starts with
19319 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19320 are some features of Exim filter files that some administrators may wish to
19321 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19322
19323 It is also possible to lock out Exim filters or Sieve filters while allowing
19324 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19325
19326
19327 The filter is run using the uid and gid set by the generic &%user%& and
19328 &%group%& options. These take their defaults from the password data if
19329 &%check_local_user%& is set, so in the normal case of users' personal filter
19330 files, the filter is run as the relevant user. When &%allow_filter%& is set
19331 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19332
19333
19334
19335 .option allow_freeze redirect boolean false
19336 .cindex "freezing messages" "allowing in filter"
19337 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19338 This command is more normally encountered in system filters, and is disabled by
19339 default for redirection filters because it isn't something you usually want to
19340 let ordinary users do.
19341
19342
19343
19344 .option check_ancestor redirect boolean false
19345 This option is concerned with handling generated addresses that are the same
19346 as some address in the list of redirection ancestors of the current address.
19347 Although it is turned off by default in the code, it is set in the default
19348 configuration file for handling users' &_.forward_& files. It is recommended
19349 for this use of the &(redirect)& router.
19350
19351 When &%check_ancestor%& is set, if a generated address (including the domain)
19352 is the same as any ancestor of the current address, it is replaced by a copy of
19353 the current address. This helps in the case where local part A is aliased to B,
19354 and B has a &_.forward_& file pointing back to A. For example, within a single
19355 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19356 &_&~jb/.forward_& contains:
19357 .code
19358 \Joe.Bloggs, <other item(s)>
19359 .endd
19360 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19361 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19362 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19363 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19364 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19365 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19366 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19367 original address. See also the &%repeat_use%& option below.
19368
19369
19370 .option check_group redirect boolean "see below"
19371 When the &%file%& option is used, the group owner of the file is checked only
19372 when this option is set. The permitted groups are those listed in the
19373 &%owngroups%& option, together with the user's default group if
19374 &%check_local_user%& is set. If the file has the wrong group, routing is
19375 deferred. The default setting for this option is true if &%check_local_user%&
19376 is set and the &%modemask%& option permits the group write bit, or if the
19377 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19378
19379
19380
19381 .option check_owner redirect boolean "see below"
19382 When the &%file%& option is used, the owner of the file is checked only when
19383 this option is set. If &%check_local_user%& is set, the local user is
19384 permitted; otherwise the owner must be one of those listed in the &%owners%&
19385 option. The default value for this option is true if &%check_local_user%& or
19386 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19387
19388
19389 .option data redirect string&!! unset
19390 This option is mutually exclusive with &%file%&. One or other of them must be
19391 set, but not both. The contents of &%data%& are expanded, and then used as the
19392 list of forwarding items, or as a set of filtering instructions. If the
19393 expansion is forced to fail, or the result is an empty string or a string that
19394 has no effect (consists entirely of comments), the router declines.
19395
19396 When filtering instructions are used, the string must begin with &"#Exim
19397 filter"&, and all comments in the string, including this initial one, must be
19398 terminated with newline characters. For example:
19399 .code
19400 data = #Exim filter\n\
19401        if $h_to: contains Exim then save $home/mail/exim endif
19402 .endd
19403 If you are reading the data from a database where newlines cannot be included,
19404 you can use the &${sg}$& expansion item to turn the escape string of your
19405 choice into a newline.
19406
19407
19408 .option directory_transport redirect string&!! unset
19409 A &(redirect)& router sets up a direct delivery to a directory when a path name
19410 ending with a slash is specified as a new &"address"&. The transport used is
19411 specified by this option, which, after expansion, must be the name of a
19412 configured transport. This should normally be an &(appendfile)& transport.
19413
19414
19415 .option file redirect string&!! unset
19416 This option specifies the name of a file that contains the redirection data. It
19417 is mutually exclusive with the &%data%& option. The string is expanded before
19418 use; if the expansion is forced to fail, the router declines. Other expansion
19419 failures cause delivery to be deferred. The result of a successful expansion
19420 must be an absolute path. The entire file is read and used as the redirection
19421 data. If the data is an empty string or a string that has no effect (consists
19422 entirely of comments), the router declines.
19423
19424 .cindex "NFS" "checking for file existence"
19425 If the attempt to open the file fails with a &"does not exist"& error, Exim
19426 runs a check on the containing directory,
19427 unless &%ignore_enotdir%& is true (see below).
19428 If the directory does not appear to exist, delivery is deferred. This can
19429 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19430 is a mount problem. If the containing directory does exist, but the file does
19431 not, the router declines.
19432
19433
19434 .option file_transport redirect string&!! unset
19435 .vindex "&$address_file$&"
19436 A &(redirect)& router sets up a direct delivery to a file when a path name not
19437 ending in a slash is specified as a new &"address"&. The transport used is
19438 specified by this option, which, after expansion, must be the name of a
19439 configured transport. This should normally be an &(appendfile)& transport. When
19440 it is running, the file name is in &$address_file$&.
19441
19442
19443 .option filter_prepend_home redirect boolean true
19444 When this option is true, if a &(save)& command in an Exim filter specifies a
19445 relative path, and &$home$& is defined, it is automatically prepended to the
19446 relative path. If this option is set false, this action does not happen. The
19447 relative path is then passed to the transport unmodified.
19448
19449
19450 .option forbid_blackhole redirect boolean false
19451 If this option is true, the &':blackhole:'& item may not appear in a
19452 redirection list.
19453
19454
19455 .option forbid_exim_filter redirect boolean false
19456 If this option is set true, only Sieve filters are permitted when
19457 &%allow_filter%& is true.
19458
19459
19460
19461
19462 .option forbid_file redirect boolean false
19463 .cindex "delivery" "to file; forbidding"
19464 .cindex "Sieve filter" "forbidding delivery to a file"
19465 .cindex "Sieve filter" "&""keep""& facility; disabling"
19466 If this option is true, this router may not generate a new address that
19467 specifies delivery to a local file or directory, either from a filter or from a
19468 conventional forward file. This option is forced to be true if &%one_time%& is
19469 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19470 locks out the Sieve's &"keep"& facility.
19471
19472
19473 .option forbid_filter_dlfunc redirect boolean false
19474 .cindex "filter" "locking out certain features"
19475 If this option is true, string expansions in Exim filters are not allowed to
19476 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19477 functions.
19478
19479 .option forbid_filter_existstest redirect boolean false
19480 .cindex "expansion" "statting a file"
19481 If this option is true, string expansions in Exim filters are not allowed to
19482 make use of the &%exists%& condition or the &%stat%& expansion item.
19483
19484 .option forbid_filter_logwrite redirect boolean false
19485 If this option is true, use of the logging facility in Exim filters is not
19486 permitted. Logging is in any case available only if the filter is being run
19487 under some unprivileged uid (which is normally the case for ordinary users'
19488 &_.forward_& files).
19489
19490
19491 .option forbid_filter_lookup redirect boolean false
19492 If this option is true, string expansions in Exim filter files are not allowed
19493 to make use of &%lookup%& items.
19494
19495
19496 .option forbid_filter_perl redirect boolean false
19497 This option has an effect only if Exim is built with embedded Perl support. If
19498 it is true, string expansions in Exim filter files are not allowed to make use
19499 of the embedded Perl support.
19500
19501
19502 .option forbid_filter_readfile redirect boolean false
19503 If this option is true, string expansions in Exim filter files are not allowed
19504 to make use of &%readfile%& items.
19505
19506
19507 .option forbid_filter_readsocket redirect boolean false
19508 If this option is true, string expansions in Exim filter files are not allowed
19509 to make use of &%readsocket%& items.
19510
19511
19512 .option forbid_filter_reply redirect boolean false
19513 If this option is true, this router may not generate an automatic reply
19514 message. Automatic replies can be generated only from Exim or Sieve filter
19515 files, not from traditional forward files. This option is forced to be true if
19516 &%one_time%& is set.
19517
19518
19519 .option forbid_filter_run redirect boolean false
19520 If this option is true, string expansions in Exim filter files are not allowed
19521 to make use of &%run%& items.
19522
19523
19524 .option forbid_include redirect boolean false
19525 If this option is true, items of the form
19526 .code
19527 :include:<path name>
19528 .endd
19529 are not permitted in non-filter redirection lists.
19530
19531
19532 .option forbid_pipe redirect boolean false
19533 .cindex "delivery" "to pipe; forbidding"
19534 If this option is true, this router may not generate a new address which
19535 specifies delivery to a pipe, either from an Exim filter or from a conventional
19536 forward file. This option is forced to be true if &%one_time%& is set.
19537
19538
19539 .option forbid_sieve_filter redirect boolean false
19540 If this option is set true, only Exim filters are permitted when
19541 &%allow_filter%& is true.
19542
19543
19544 .cindex "SMTP" "error codes"
19545 .option forbid_smtp_code redirect boolean false
19546 If this option is set true, any SMTP error codes that are present at the start
19547 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19548 the default codes (451 and 550, respectively) are always used.
19549
19550
19551
19552
19553 .option hide_child_in_errmsg redirect boolean false
19554 .cindex "bounce message" "redirection details; suppressing"
19555 If this option is true, it prevents Exim from quoting a child address if it
19556 generates a bounce or delay message for it. Instead it says &"an address
19557 generated from <&'the top level address'&>"&. Of course, this applies only to
19558 bounces generated locally. If a message is forwarded to another host, &'its'&
19559 bounce may well quote the generated address.
19560
19561
19562 .option ignore_eacces redirect boolean false
19563 .cindex "EACCES"
19564 If this option is set and an attempt to open a redirection file yields the
19565 EACCES error (permission denied), the &(redirect)& router behaves as if the
19566 file did not exist.
19567
19568
19569 .option ignore_enotdir redirect boolean false
19570 .cindex "ENOTDIR"
19571 If this option is set and an attempt to open a redirection file yields the
19572 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19573 router behaves as if the file did not exist.
19574
19575 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19576 router that has the &%file%& option set discovers that the file does not exist
19577 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19578 against unmounted NFS directories. If the parent can not be statted, delivery
19579 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19580 is set, because that option tells Exim to ignore &"something on the path is not
19581 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19582 that some operating systems give ENOENT where others give ENOTDIR.
19583
19584
19585
19586 .option include_directory redirect string unset
19587 If this option is set, the path names of any &':include:'& items in a
19588 redirection list must start with this directory.
19589
19590
19591 .option modemask redirect "octal integer" 022
19592 This specifies mode bits which must not be set for a file specified by the
19593 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19594
19595
19596 .option one_time redirect boolean false
19597 .cindex "one-time aliasing/forwarding expansion"
19598 .cindex "alias file" "one-time expansion"
19599 .cindex "forward file" "one-time expansion"
19600 .cindex "mailing lists" "one-time expansion"
19601 .cindex "address redirection" "one-time expansion"
19602 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19603 files each time it tries to deliver a message causes a problem when one or more
19604 of the generated addresses fails be delivered at the first attempt. The problem
19605 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19606 but of what happens when the redirection list changes during the time that the
19607 message is on Exim's queue. This is particularly true in the case of mailing
19608 lists, where new subscribers might receive copies of messages that were posted
19609 before they subscribed.
19610
19611 If &%one_time%& is set and any addresses generated by the router fail to
19612 deliver at the first attempt, the failing addresses are added to the message as
19613 &"top level"& addresses, and the parent address that generated them is marked
19614 &"delivered"&. Thus, redirection does not happen again at the next delivery
19615 attempt.
19616
19617 &*Warning 1*&: Any header line addition or removal that is specified by this
19618 router would be lost if delivery did not succeed at the first attempt. For this
19619 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19620 permitted when &%one_time%& is set.
19621
19622 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19623 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19624 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19625
19626 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19627 &%one_time%&.
19628
19629 The original top-level address is remembered with each of the generated
19630 addresses, and is output in any log messages. However, any intermediate parent
19631 addresses are not recorded. This makes a difference to the log only if
19632 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19633 typically be used for mailing lists, where there is normally just one level of
19634 expansion.
19635
19636
19637 .option owners redirect "string list" unset
19638 .cindex "ownership" "alias file"
19639 .cindex "ownership" "forward file"
19640 .cindex "alias file" "ownership"
19641 .cindex "forward file" "ownership"
19642 This specifies a list of permitted owners for the file specified by &%file%&.
19643 This list is in addition to the local user when &%check_local_user%& is set.
19644 See &%check_owner%& above.
19645
19646
19647 .option owngroups redirect "string list" unset
19648 This specifies a list of permitted groups for the file specified by &%file%&.
19649 The list is in addition to the local user's primary group when
19650 &%check_local_user%& is set. See &%check_group%& above.
19651
19652
19653 .option pipe_transport redirect string&!! unset
19654 .vindex "&$address_pipe$&"
19655 A &(redirect)& router sets up a direct delivery to a pipe when a string
19656 starting with a vertical bar character is specified as a new &"address"&. The
19657 transport used is specified by this option, which, after expansion, must be the
19658 name of a configured transport. This should normally be a &(pipe)& transport.
19659 When the transport is run, the pipe command is in &$address_pipe$&.
19660
19661
19662 .option qualify_domain redirect string&!! unset
19663 .vindex "&$qualify_recipient$&"
19664 If this option is set, and an unqualified address (one without a domain) is
19665 generated, and that address would normally be qualified by the global setting
19666 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19667 expanding this string. If the expansion fails, the router declines. If you want
19668 to revert to the default, you can have the expansion generate
19669 &$qualify_recipient$&.
19670
19671 This option applies to all unqualified addresses generated by Exim filters,
19672 but for traditional &_.forward_& files, it applies only to addresses that are
19673 not preceded by a backslash. Sieve filters cannot generate unqualified
19674 addresses.
19675
19676 .option qualify_preserve_domain redirect boolean false
19677 .cindex "domain" "in redirection; preserving"
19678 .cindex "preserving domain in redirection"
19679 .cindex "address redirection" "domain; preserving"
19680 If this option is set, the router's local &%qualify_domain%& option must not be
19681 set (a configuration error occurs if it is). If an unqualified address (one
19682 without a domain) is generated, it is qualified with the domain of the parent
19683 address (the immediately preceding ancestor) instead of the global
19684 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19685 this applies whether or not the address is preceded by a backslash.
19686
19687
19688 .option repeat_use redirect boolean true
19689 If this option is set false, the router is skipped for a child address that has
19690 any ancestor that was routed by this router. This test happens before any of
19691 the other preconditions are tested. Exim's default anti-looping rules skip
19692 only when the ancestor is the same as the current address. See also
19693 &%check_ancestor%& above and the generic &%redirect_router%& option.
19694
19695
19696 .option reply_transport redirect string&!! unset
19697 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19698 &%vacation%& command is used in a filter file. The transport used is specified
19699 by this option, which, after expansion, must be the name of a configured
19700 transport. This should normally be an &(autoreply)& transport. Other transports
19701 are unlikely to do anything sensible or useful.
19702
19703
19704 .option rewrite redirect boolean true
19705 .cindex "address redirection" "disabling rewriting"
19706 If this option is set false, addresses generated by the router are not
19707 subject to address rewriting. Otherwise, they are treated like new addresses
19708 and are rewritten according to the global rewriting rules.
19709
19710
19711 .option sieve_subaddress redirect string&!! unset
19712 The value of this option is passed to a Sieve filter to specify the
19713 :subaddress part of an address.
19714
19715 .option sieve_useraddress redirect string&!! unset
19716 The value of this option is passed to a Sieve filter to specify the :user part
19717 of an address. However, if it is unset, the entire original local part
19718 (including any prefix or suffix) is used for :user.
19719
19720
19721 .option sieve_vacation_directory redirect string&!! unset
19722 .cindex "Sieve filter" "vacation directory"
19723 To enable the &"vacation"& extension for Sieve filters, you must set
19724 &%sieve_vacation_directory%& to the directory where vacation databases are held
19725 (do not put anything else in that directory), and ensure that the
19726 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19727 needs their own directory; Exim will create it if necessary.
19728
19729
19730
19731 .option skip_syntax_errors redirect boolean false
19732 .cindex "forward file" "broken"
19733 .cindex "address redirection" "broken files"
19734 .cindex "alias file" "broken"
19735 .cindex "broken alias or forward files"
19736 .cindex "ignoring faulty addresses"
19737 .cindex "skipping faulty addresses"
19738 .cindex "error" "skipping bad syntax"
19739 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19740 non-filter redirection data are skipped, and each failing address is logged. If
19741 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19742 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19743 are expanded and placed at the head of the error message generated by
19744 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19745 be the same address as the generic &%errors_to%& option. The
19746 &%skip_syntax_errors%& option is often used when handling mailing lists.
19747
19748 If all the addresses in a redirection list are skipped because of syntax
19749 errors, the router declines to handle the original address, and it is passed to
19750 the following routers.
19751
19752 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19753 error in the filter causes filtering to be abandoned without any action being
19754 taken. The incident is logged, and the router declines to handle the address,
19755 so it is passed to the following routers.
19756
19757 .cindex "Sieve filter" "syntax errors in"
19758 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19759 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19760 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19761
19762 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19763 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19764 option, used with an address that does not get redirected, can be used to
19765 notify users of these errors, by means of a router like this:
19766 .code
19767 userforward:
19768   driver = redirect
19769   allow_filter
19770   check_local_user
19771   file = $home/.forward
19772   file_transport = address_file
19773   pipe_transport = address_pipe
19774   reply_transport = address_reply
19775   no_verify
19776   skip_syntax_errors
19777   syntax_errors_to = real-$local_part@$domain
19778   syntax_errors_text = \
19779    This is an automatically generated message. An error has\n\
19780    been found in your .forward file. Details of the error are\n\
19781    reported below. While this error persists, you will receive\n\
19782    a copy of this message for every message that is addressed\n\
19783    to you. If your .forward file is a filter file, or if it is\n\
19784    a non-filter file containing no valid forwarding addresses,\n\
19785    a copy of each incoming message will be put in your normal\n\
19786    mailbox. If a non-filter file contains at least one valid\n\
19787    forwarding address, forwarding to the valid addresses will\n\
19788    happen, and those will be the only deliveries that occur.
19789 .endd
19790 You also need a router to ensure that local addresses that are prefixed by
19791 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19792 put this immediately before the &(userforward)& router:
19793 .code
19794 real_localuser:
19795   driver = accept
19796   check_local_user
19797   local_part_prefix = real-
19798   transport = local_delivery
19799 .endd
19800 For security, it would probably be a good idea to restrict the use of this
19801 router to locally-generated messages, using a condition such as this:
19802 .code
19803   condition = ${if match {$sender_host_address}\
19804                          {\N^(|127\.0\.0\.1)$\N}}
19805 .endd
19806
19807
19808 .option syntax_errors_text redirect string&!! unset
19809 See &%skip_syntax_errors%& above.
19810
19811
19812 .option syntax_errors_to redirect string unset
19813 See &%skip_syntax_errors%& above.
19814 .ecindex IIDredrou1
19815 .ecindex IIDredrou2
19816
19817
19818
19819
19820
19821
19822 . ////////////////////////////////////////////////////////////////////////////
19823 . ////////////////////////////////////////////////////////////////////////////
19824
19825 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19826          "Environment for local transports"
19827 .scindex IIDenvlotra1 "local transports" "environment for"
19828 .scindex IIDenvlotra2 "environment for local transports"
19829 .scindex IIDenvlotra3 "transport" "local; environment for"
19830 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19831 transport can be thought of as similar to a pipe.) Exim always runs transports
19832 in subprocesses, under specified uids and gids. Typical deliveries to local
19833 mailboxes run under the uid and gid of the local user.
19834
19835 Exim also sets a specific current directory while running the transport; for
19836 some transports a home directory setting is also relevant. The &(pipe)&
19837 transport is the only one that sets up environment variables; see section
19838 &<<SECTpipeenv>>& for details.
19839
19840 The values used for the uid, gid, and the directories may come from several
19841 different places. In many cases, the router that handles the address associates
19842 settings with that address as a result of its &%check_local_user%&, &%group%&,
19843 or &%user%& options. However, values may also be given in the transport's own
19844 configuration, and these override anything that comes from the router.
19845
19846
19847
19848 .section "Concurrent deliveries" "SECID131"
19849 .cindex "concurrent deliveries"
19850 .cindex "simultaneous deliveries"
19851 If two different messages for the same local recipient arrive more or less
19852 simultaneously, the two delivery processes are likely to run concurrently. When
19853 the &(appendfile)& transport is used to write to a file, Exim applies locking
19854 rules to stop concurrent processes from writing to the same file at the same
19855 time.
19856
19857 However, when you use a &(pipe)& transport, it is up to you to arrange any
19858 locking that is needed. Here is a silly example:
19859 .code
19860 my_transport:
19861   driver = pipe
19862   command = /bin/sh -c 'cat >>/some/file'
19863 .endd
19864 This is supposed to write the message at the end of the file. However, if two
19865 messages arrive at the same time, the file will be scrambled. You can use the
19866 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19867 file using the same algorithm that Exim itself uses.
19868
19869
19870
19871
19872 .section "Uids and gids" "SECTenvuidgid"
19873 .cindex "local transports" "uid and gid"
19874 .cindex "transport" "local; uid and gid"
19875 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19876 overrides any group that the router set in the address, even if &%user%& is not
19877 set for the transport. This makes it possible, for example, to run local mail
19878 delivery under the uid of the recipient (set by the router), but in a special
19879 group (set by the transport). For example:
19880 .code
19881 # Routers ...
19882 # User/group are set by check_local_user in this router
19883 local_users:
19884   driver = accept
19885   check_local_user
19886   transport = group_delivery
19887
19888 # Transports ...
19889 # This transport overrides the group
19890 group_delivery:
19891   driver = appendfile
19892   file = /var/spool/mail/$local_part
19893   group = mail
19894 .endd
19895 If &%user%& is set for a transport, its value overrides what is set in the
19896 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19897 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19898 set.
19899
19900 .oindex "&%initgroups%&"
19901 When the uid is taken from the transport's configuration, the &[initgroups()]&
19902 function is called for the groups associated with that uid if the
19903 &%initgroups%& option is set for the transport. When the uid is not specified
19904 by the transport, but is associated with the address by a router, the option
19905 for calling &[initgroups()]& is taken from the router configuration.
19906
19907 .cindex "&(pipe)& transport" "uid for"
19908 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19909 is set and &%user%& is not set, the uid of the process that called Exim to
19910 receive the message is used, and if &%group%& is not set, the corresponding
19911 original gid is also used.
19912
19913 This is the detailed preference order for obtaining a gid; the first of the
19914 following that is set is used:
19915
19916 .ilist
19917 A &%group%& setting of the transport;
19918 .next
19919 A &%group%& setting of the router;
19920 .next
19921 A gid associated with a user setting of the router, either as a result of
19922 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19923 .next
19924 The group associated with a non-numeric &%user%& setting of the transport;
19925 .next
19926 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19927 the uid is the creator's uid;
19928 .next
19929 The Exim gid if the Exim uid is being used as a default.
19930 .endlist
19931
19932 If, for example, the user is specified numerically on the router and there are
19933 no group settings, no gid is available. In this situation, an error occurs.
19934 This is different for the uid, for which there always is an ultimate default.
19935 The first of the following that is set is used:
19936
19937 .ilist
19938 A &%user%& setting of the transport;
19939 .next
19940 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19941 .next
19942 A &%user%& setting of the router;
19943 .next
19944 A &%check_local_user%& setting of the router;
19945 .next
19946 The Exim uid.
19947 .endlist
19948
19949 Of course, an error will still occur if the uid that is chosen is on the
19950 &%never_users%& list.
19951
19952
19953
19954
19955
19956 .section "Current and home directories" "SECID132"
19957 .cindex "current directory for local transport"
19958 .cindex "home directory" "for local transport"
19959 .cindex "transport" "local; home directory for"
19960 .cindex "transport" "local; current directory for"
19961 Routers may set current and home directories for local transports by means of
19962 the &%transport_current_directory%& and &%transport_home_directory%& options.
19963 However, if the transport's &%current_directory%& or &%home_directory%& options
19964 are set, they override the router's values. In detail, the home directory
19965 for a local transport is taken from the first of these values that is set:
19966
19967 .ilist
19968 The &%home_directory%& option on the transport;
19969 .next
19970 The &%transport_home_directory%& option on the router;
19971 .next
19972 The password data if &%check_local_user%& is set on the router;
19973 .next
19974 The &%router_home_directory%& option on the router.
19975 .endlist
19976
19977 The current directory is taken from the first of these values that is set:
19978
19979 .ilist
19980 The &%current_directory%& option on the transport;
19981 .next
19982 The &%transport_current_directory%& option on the router.
19983 .endlist
19984
19985
19986 If neither the router nor the transport sets a current directory, Exim uses the
19987 value of the home directory, if it is set. Otherwise it sets the current
19988 directory to &_/_& before running a local transport.
19989
19990
19991
19992 .section "Expansion variables derived from the address" "SECID133"
19993 .vindex "&$domain$&"
19994 .vindex "&$local_part$&"
19995 .vindex "&$original_domain$&"
19996 Normally a local delivery is handling a single address, and in that case the
19997 variables such as &$domain$& and &$local_part$& are set during local
19998 deliveries. However, in some circumstances more than one address may be handled
19999 at once (for example, while writing batch SMTP for onward transmission by some
20000 other means). In this case, the variables associated with the local part are
20001 never set, &$domain$& is set only if all the addresses have the same domain,
20002 and &$original_domain$& is never set.
20003 .ecindex IIDenvlotra1
20004 .ecindex IIDenvlotra2
20005 .ecindex IIDenvlotra3
20006
20007
20008
20009
20010
20011
20012
20013 . ////////////////////////////////////////////////////////////////////////////
20014 . ////////////////////////////////////////////////////////////////////////////
20015
20016 .chapter "Generic options for transports" "CHAPtransportgeneric"
20017 .scindex IIDgenoptra1 "generic options" "transport"
20018 .scindex IIDgenoptra2 "options" "generic; for transports"
20019 .scindex IIDgenoptra3 "transport" "generic options for"
20020 The following generic options apply to all transports:
20021
20022
20023 .option body_only transports boolean false
20024 .cindex "transport" "body only"
20025 .cindex "message" "transporting body only"
20026 .cindex "body of message" "transporting"
20027 If this option is set, the message's headers are not transported. It is
20028 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20029 or &(pipe)& transports, the settings of &%message_prefix%& and
20030 &%message_suffix%& should be checked, because this option does not
20031 automatically suppress them.
20032
20033
20034 .option current_directory transports string&!! unset
20035 .cindex "transport" "current directory for"
20036 This specifies the current directory that is to be set while running the
20037 transport, overriding any value that may have been set by the router.
20038 If the expansion fails for any reason, including forced failure, an error is
20039 logged, and delivery is deferred.
20040
20041
20042 .option disable_logging transports boolean false
20043 If this option is set true, nothing is logged for any
20044 deliveries by the transport or for any
20045 transport errors. You should not set this option unless you really, really know
20046 what you are doing.
20047
20048
20049 .option debug_print transports string&!! unset
20050 .cindex "testing" "variables in drivers"
20051 If this option is set and debugging is enabled (see the &%-d%& command line
20052 option), the string is expanded and included in the debugging output when the
20053 transport is run.
20054 If expansion of the string fails, the error message is written to the debugging
20055 output, and Exim carries on processing.
20056 This facility is provided to help with checking out the values of variables and
20057 so on when debugging driver configurations. For example, if a &%headers_add%&
20058 option is not working properly, &%debug_print%& could be used to output the
20059 variables it references. A newline is added to the text if it does not end with
20060 one.
20061 The variables &$transport_name$& and &$router_name$& contain the name of the
20062 transport and the router that called it.
20063
20064 .option delivery_date_add transports boolean false
20065 .cindex "&'Delivery-date:'& header line"
20066 If this option is true, a &'Delivery-date:'& header is added to the message.
20067 This gives the actual time the delivery was made. As this is not a standard
20068 header, Exim has a configuration option (&%delivery_date_remove%&) which
20069 requests its removal from incoming messages, so that delivered messages can
20070 safely be resent to other recipients.
20071
20072
20073 .option driver transports string unset
20074 This specifies which of the available transport drivers is to be used.
20075 There is no default, and this option must be set for every transport.
20076
20077
20078 .option envelope_to_add transports boolean false
20079 .cindex "&'Envelope-to:'& header line"
20080 If this option is true, an &'Envelope-to:'& header is added to the message.
20081 This gives the original address(es) in the incoming envelope that caused this
20082 delivery to happen. More than one address may be present if the transport is
20083 configured to handle several addresses at once, or if more than one original
20084 address was redirected to the same final address. As this is not a standard
20085 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20086 its removal from incoming messages, so that delivered messages can safely be
20087 resent to other recipients.
20088
20089
20090 .option group transports string&!! "Exim group"
20091 .cindex "transport" "group; specifying"
20092 This option specifies a gid for running the transport process, overriding any
20093 value that the router supplies, and also overriding any value associated with
20094 &%user%& (see below).
20095
20096
20097 .option headers_add transports list&!! unset
20098 .cindex "header lines" "adding in transport"
20099 .cindex "transport" "header lines; adding"
20100 This option specifies a list of text headers, newline-separated,
20101 which are (separately) expanded and added to the header
20102 portion of a message as it is transported, as described in section
20103 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20104 routers. If the result of the expansion is an empty string, or if the expansion
20105 is forced to fail, no action is taken. Other expansion failures are treated as
20106 errors and cause the delivery to be deferred.
20107
20108 Unlike most options, &%headers_add%& can be specified multiple times
20109 for a transport; all listed headers are added.
20110
20111
20112 .option headers_only transports boolean false
20113 .cindex "transport" "header lines only"
20114 .cindex "message" "transporting headers only"
20115 .cindex "header lines" "transporting"
20116 If this option is set, the message's body is not transported. It is mutually
20117 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20118 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20119 checked, since this option does not automatically suppress them.
20120
20121
20122 .option headers_remove transports list&!! unset
20123 .cindex "header lines" "removing"
20124 .cindex "transport" "header lines; removing"
20125 This option specifies a list of header names, colon-separated;
20126 these headers are omitted from the message as it is transported, as described
20127 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20128 routers.
20129 Each list item is separately expanded.
20130 If the result of the expansion is an empty string, or if the expansion
20131 is forced to fail, no action is taken. Other expansion failures are treated as
20132 errors and cause the delivery to be deferred.
20133
20134 Unlike most options, &%headers_remove%& can be specified multiple times
20135 for a router; all listed headers are removed.
20136
20137
20138
20139 .option headers_rewrite transports string unset
20140 .cindex "transport" "header lines; rewriting"
20141 .cindex "rewriting" "at transport time"
20142 This option allows addresses in header lines to be rewritten at transport time,
20143 that is, as the message is being copied to its destination. The contents of the
20144 option are a colon-separated list of rewriting rules. Each rule is in exactly
20145 the same form as one of the general rewriting rules that are applied when a
20146 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20147 example,
20148 .code
20149 headers_rewrite = a@b c@d f : \
20150                   x@y w@z
20151 .endd
20152 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20153 &'w@z'& in all address-bearing header lines. The rules are applied to the
20154 header lines just before they are written out at transport time, so they affect
20155 only those copies of the message that pass through the transport. However, only
20156 the message's original header lines, and any that were added by a system
20157 filter, are rewritten. If a router or transport adds header lines, they are not
20158 affected by this option. These rewriting rules are &'not'& applied to the
20159 envelope. You can change the return path using &%return_path%&, but you cannot
20160 change envelope recipients at this time.
20161
20162
20163 .option home_directory transports string&!! unset
20164 .cindex "transport" "home directory for"
20165 .vindex "&$home$&"
20166 This option specifies a home directory setting for a local transport,
20167 overriding any value that may be set by the router. The home directory is
20168 placed in &$home$& while expanding the transport's private options. It is also
20169 used as the current directory if no current directory is set by the
20170 &%current_directory%& option on the transport or the
20171 &%transport_current_directory%& option on the router. If the expansion fails
20172 for any reason, including forced failure, an error is logged, and delivery is
20173 deferred.
20174
20175
20176 .option initgroups transports boolean false
20177 .cindex "additional groups"
20178 .cindex "groups" "additional"
20179 .cindex "transport" "group; additional"
20180 If this option is true and the uid for the delivery process is provided by the
20181 transport, the &[initgroups()]& function is called when running the transport
20182 to ensure that any additional groups associated with the uid are set up.
20183
20184
20185 .option message_size_limit transports string&!! 0
20186 .cindex "limit" "message size per transport"
20187 .cindex "size" "of message, limit"
20188 .cindex "transport" "message size; limiting"
20189 This option controls the size of messages passed through the transport. It is
20190 expanded before use; the result of the expansion must be a sequence of decimal
20191 digits, optionally followed by K or M. If the expansion fails for any reason,
20192 including forced failure, or if the result is not of the required form,
20193 delivery is deferred. If the value is greater than zero and the size of a
20194 message exceeds this limit, the address is failed. If there is any chance that
20195 the resulting bounce message could be routed to the same transport, you should
20196 ensure that &%return_size_limit%& is less than the transport's
20197 &%message_size_limit%&, as otherwise the bounce message will fail to get
20198 delivered.
20199
20200
20201
20202 .option rcpt_include_affixes transports boolean false
20203 .cindex "prefix" "for local part, including in envelope"
20204 .cindex "suffix for local part" "including in envelope"
20205 .cindex "local part" "prefix"
20206 .cindex "local part" "suffix"
20207 When this option is false (the default), and an address that has had any
20208 affixes (prefixes or suffixes) removed from the local part is delivered by any
20209 form of SMTP or LMTP, the affixes are not included. For example, if a router
20210 that contains
20211 .code
20212 local_part_prefix = *-
20213 .endd
20214 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20215 is delivered with
20216 .code
20217 RCPT TO:<xyz@some.domain>
20218 .endd
20219 This is also the case when an ACL-time callout is being used to verify a
20220 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20221 whole local part is included in the RCPT command. This option applies to BSMTP
20222 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20223 &(lmtp)& and &(smtp)& transports.
20224
20225
20226 .option retry_use_local_part transports boolean "see below"
20227 .cindex "hints database" "retry keys"
20228 When a delivery suffers a temporary failure, a retry record is created
20229 in Exim's hints database. For remote deliveries, the key for the retry record
20230 is based on the name and/or IP address of the failing remote host. For local
20231 deliveries, the key is normally the entire address, including both the local
20232 part and the domain. This is suitable for most common cases of local delivery
20233 temporary failure &-- for example, exceeding a mailbox quota should delay only
20234 deliveries to that mailbox, not to the whole domain.
20235
20236 However, in some special cases you may want to treat a temporary local delivery
20237 as a failure associated with the domain, and not with a particular local part.
20238 (For example, if you are storing all mail for some domain in files.) You can do
20239 this by setting &%retry_use_local_part%& false.
20240
20241 For all the local transports, its default value is true. For remote transports,
20242 the default value is false for tidiness, but changing the value has no effect
20243 on a remote transport in the current implementation.
20244
20245
20246 .option return_path transports string&!! unset
20247 .cindex "envelope sender"
20248 .cindex "transport" "return path; changing"
20249 .cindex "return path" "changing in transport"
20250 If this option is set, the string is expanded at transport time and replaces
20251 the existing return path (envelope sender) value in the copy of the message
20252 that is being delivered. An empty return path is permitted. This feature is
20253 designed for remote deliveries, where the value of this option is used in the
20254 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20255 only effect is to change the address that is placed in the &'Return-path:'&
20256 header line, if one is added to the message (see the next option).
20257
20258 &*Note:*& A changed return path is not logged unless you add
20259 &%return_path_on_delivery%& to the log selector.
20260
20261 .vindex "&$return_path$&"
20262 The expansion can refer to the existing value via &$return_path$&. This is
20263 either the message's envelope sender, or an address set by the
20264 &%errors_to%& option on a router. If the expansion is forced to fail, no
20265 replacement occurs; if it fails for another reason, delivery is deferred. This
20266 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20267 section &<<SECTverp>>&.
20268
20269 &*Note*&: If a delivery error is detected locally, including the case when a
20270 remote server rejects a message at SMTP time, the bounce message is not sent to
20271 the value of this option. It is sent to the previously set errors address.
20272 This defaults to the incoming sender address, but can be changed by setting
20273 &%errors_to%& in a router.
20274
20275
20276
20277 .option return_path_add transports boolean false
20278 .cindex "&'Return-path:'& header line"
20279 If this option is true, a &'Return-path:'& header is added to the message.
20280 Although the return path is normally available in the prefix line of BSD
20281 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20282 have easy access to it.
20283
20284 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20285 the delivery SMTP server makes the final delivery"&. This implies that this
20286 header should not be present in incoming messages. Exim has a configuration
20287 option, &%return_path_remove%&, which requests removal of this header from
20288 incoming messages, so that delivered messages can safely be resent to other
20289 recipients.
20290
20291
20292 .option shadow_condition transports string&!! unset
20293 See &%shadow_transport%& below.
20294
20295
20296 .option shadow_transport transports string unset
20297 .cindex "shadow transport"
20298 .cindex "transport" "shadow"
20299 A local transport may set the &%shadow_transport%& option to the name of
20300 another local transport. Shadow remote transports are not supported.
20301
20302 Whenever a delivery to the main transport succeeds, and either
20303 &%shadow_condition%& is unset, or its expansion does not result in the empty
20304 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20305 passed to the shadow transport, with the same delivery address or addresses. If
20306 expansion fails, no action is taken except that non-forced expansion failures
20307 cause a log line to be written.
20308
20309 The result of the shadow transport is discarded and does not affect the
20310 subsequent processing of the message. Only a single level of shadowing is
20311 provided; the &%shadow_transport%& option is ignored on any transport when it
20312 is running as a shadow. Options concerned with output from pipes are also
20313 ignored. The log line for the successful delivery has an item added on the end,
20314 of the form
20315 .code
20316 ST=<shadow transport name>
20317 .endd
20318 If the shadow transport did not succeed, the error message is put in
20319 parentheses afterwards. Shadow transports can be used for a number of different
20320 purposes, including keeping more detailed log information than Exim normally
20321 provides, and implementing automatic acknowledgment policies based on message
20322 headers that some sites insist on.
20323
20324
20325 .option transport_filter transports string&!! unset
20326 .cindex "transport" "filter"
20327 .cindex "filter" "transport filter"
20328 This option sets up a filtering (in the Unix shell sense) process for messages
20329 at transport time. It should not be confused with mail filtering as set up by
20330 individual users or via a system filter.
20331
20332 When the message is about to be written out, the command specified by
20333 &%transport_filter%& is started up in a separate, parallel process, and
20334 the entire message, including the header lines, is passed to it on its standard
20335 input (this in fact is done from a third process, to avoid deadlock). The
20336 command must be specified as an absolute path.
20337
20338 The lines of the message that are written to the transport filter are
20339 terminated by newline (&"\n"&). The message is passed to the filter before any
20340 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20341 lines beginning with a dot, and also before any processing implied by the
20342 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20343 &(pipe)& transports.
20344
20345 The standard error for the filter process is set to the same destination as its
20346 standard output; this is read and written to the message's ultimate
20347 destination. The process that writes the message to the filter, the
20348 filter itself, and the original process that reads the result and delivers it
20349 are all run in parallel, like a shell pipeline.
20350
20351 The filter can perform any transformations it likes, but of course should take
20352 care not to break RFC 2822 syntax. Exim does not check the result, except to
20353 test for a final newline when SMTP is in use. All messages transmitted over
20354 SMTP must end with a newline, so Exim supplies one if it is missing.
20355
20356 .cindex "content scanning" "per user"
20357 A transport filter can be used to provide content-scanning on a per-user basis
20358 at delivery time if the only required effect of the scan is to modify the
20359 message. For example, a content scan could insert a new header line containing
20360 a spam score. This could be interpreted by a filter in the user's MUA. It is
20361 not possible to discard a message at this stage.
20362
20363 .cindex "SMTP" "SIZE"
20364 A problem might arise if the filter increases the size of a message that is
20365 being sent down an SMTP connection. If the receiving SMTP server has indicated
20366 support for the SIZE parameter, Exim will have sent the size of the message
20367 at the start of the SMTP session. If what is actually sent is substantially
20368 more, the server might reject the message. This can be worked round by setting
20369 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20370 additions to the message, or to disable the use of SIZE altogether.
20371
20372 .vindex "&$pipe_addresses$&"
20373 The value of the &%transport_filter%& option is the command string for starting
20374 the filter, which is run directly from Exim, not under a shell. The string is
20375 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20376 Exim breaks it up into arguments and then expands each argument separately (see
20377 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20378 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20379 of arguments, one for each address that applies to this delivery. (This isn't
20380 an ideal name for this feature here, but as it was already implemented for the
20381 &(pipe)& transport, it seemed sensible not to change it.)
20382
20383 .vindex "&$host$&"
20384 .vindex "&$host_address$&"
20385 The expansion variables &$host$& and &$host_address$& are available when the
20386 transport is a remote one. They contain the name and IP address of the host to
20387 which the message is being sent. For example:
20388 .code
20389 transport_filter = /some/directory/transport-filter.pl \
20390   $host $host_address $sender_address $pipe_addresses
20391 .endd
20392
20393 Two problems arise if you want to use more complicated expansion items to
20394 generate transport filter commands, both of which due to the fact that the
20395 command is split up &'before'& expansion.
20396 .ilist
20397 If an expansion item contains white space, you must quote it, so that it is all
20398 part of the same command item. If the entire option setting is one such
20399 expansion item, you have to take care what kind of quoting you use. For
20400 example:
20401 .code
20402 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20403 .endd
20404 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20405 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20406 stripped by Exim when it read the option's value. When the value is used, if
20407 the single quotes were missing, the line would be split into two items,
20408 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20409 Exim tried to expand the first one.
20410 .next
20411 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20412 expansion cannot generate multiple arguments, or a command name followed by
20413 arguments. Consider this example:
20414 .code
20415 transport_filter = ${lookup{$host}lsearch{/a/file}\
20416                     {$value}{/bin/cat}}
20417 .endd
20418 The result of the lookup is interpreted as the name of the command, even
20419 if it contains white space. The simplest way round this is to use a shell:
20420 .code
20421 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20422                                {$value}{/bin/cat}}
20423 .endd
20424 .endlist
20425
20426 The filter process is run under the same uid and gid as the normal delivery.
20427 For remote deliveries this is the Exim uid/gid by default. The command should
20428 normally yield a zero return code. Transport filters are not supposed to fail.
20429 A non-zero code is taken to mean that the transport filter encountered some
20430 serious problem. Delivery of the message is deferred; the message remains on
20431 the queue and is tried again later. It is not possible to cause a message to be
20432 bounced from a transport filter.
20433
20434 If a transport filter is set on an autoreply transport, the original message is
20435 passed through the filter as it is being copied into the newly generated
20436 message, which happens if the &%return_message%& option is set.
20437
20438
20439 .option transport_filter_timeout transports time 5m
20440 .cindex "transport" "filter, timeout"
20441 When Exim is reading the output of a transport filter, it applies a timeout
20442 that can be set by this option. Exceeding the timeout is normally treated as a
20443 temporary delivery failure. However, if a transport filter is used with a
20444 &(pipe)& transport, a timeout in the transport filter is treated in the same
20445 way as a timeout in the pipe command itself. By default, a timeout is a hard
20446 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20447 becomes a temporary error.
20448
20449
20450 .option user transports string&!! "Exim user"
20451 .cindex "uid (user id)" "local delivery"
20452 .cindex "transport" "user, specifying"
20453 This option specifies the user under whose uid the delivery process is to be
20454 run, overriding any uid that may have been set by the router. If the user is
20455 given as a name, the uid is looked up from the password data, and the
20456 associated group is taken as the value of the gid to be used if the &%group%&
20457 option is not set.
20458
20459 For deliveries that use local transports, a user and group are normally
20460 specified explicitly or implicitly (for example, as a result of
20461 &%check_local_user%&) by the router or transport.
20462
20463 .cindex "hints database" "access by remote transport"
20464 For remote transports, you should leave this option unset unless you really are
20465 sure you know what you are doing. When a remote transport is running, it needs
20466 to be able to access Exim's hints databases, because each host may have its own
20467 retry data.
20468 .ecindex IIDgenoptra1
20469 .ecindex IIDgenoptra2
20470 .ecindex IIDgenoptra3
20471
20472
20473
20474
20475
20476
20477 . ////////////////////////////////////////////////////////////////////////////
20478 . ////////////////////////////////////////////////////////////////////////////
20479
20480 .chapter "Address batching in local transports" "CHAPbatching" &&&
20481          "Address batching"
20482 .cindex "transport" "local; address batching in"
20483 The only remote transport (&(smtp)&) is normally configured to handle more than
20484 one address at a time, so that when several addresses are routed to the same
20485 remote host, just one copy of the message is sent. Local transports, however,
20486 normally handle one address at a time. That is, a separate instance of the
20487 transport is run for each address that is routed to the transport. A separate
20488 copy of the message is delivered each time.
20489
20490 .cindex "batched local delivery"
20491 .oindex "&%batch_max%&"
20492 .oindex "&%batch_id%&"
20493 In special cases, it may be desirable to handle several addresses at once in a
20494 local transport, for example:
20495
20496 .ilist
20497 In an &(appendfile)& transport, when storing messages in files for later
20498 delivery by some other means, a single copy of the message with multiple
20499 recipients saves space.
20500 .next
20501 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20502 a single copy saves time, and is the normal way LMTP is expected to work.
20503 .next
20504 In a &(pipe)& transport, when passing the message
20505 to a scanner program or
20506 to some other delivery mechanism such as UUCP, multiple recipients may be
20507 acceptable.
20508 .endlist
20509
20510 These three local transports all have the same options for controlling multiple
20511 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20512 repeating the information for each transport, these options are described here.
20513
20514 The &%batch_max%& option specifies the maximum number of addresses that can be
20515 delivered together in a single run of the transport. Its default value is one
20516 (no batching). When more than one address is routed to a transport that has a
20517 &%batch_max%& value greater than one, the addresses are delivered in a batch
20518 (that is, in a single run of the transport with multiple recipients), subject
20519 to certain conditions:
20520
20521 .ilist
20522 .vindex "&$local_part$&"
20523 If any of the transport's options contain a reference to &$local_part$&, no
20524 batching is possible.
20525 .next
20526 .vindex "&$domain$&"
20527 If any of the transport's options contain a reference to &$domain$&, only
20528 addresses with the same domain are batched.
20529 .next
20530 .cindex "customizing" "batching condition"
20531 If &%batch_id%& is set, it is expanded for each address, and only those
20532 addresses with the same expanded value are batched. This allows you to specify
20533 customized batching conditions. Failure of the expansion for any reason,
20534 including forced failure, disables batching, but it does not stop the delivery
20535 from taking place.
20536 .next
20537 Batched addresses must also have the same errors address (where to send
20538 delivery errors), the same header additions and removals, the same user and
20539 group for the transport, and if a host list is present, the first host must
20540 be the same.
20541 .endlist
20542
20543 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20544 both when the file or pipe command is specified in the transport, and when it
20545 is specified by a &(redirect)& router, but all the batched addresses must of
20546 course be routed to the same file or pipe command. These two transports have an
20547 option called &%use_bsmtp%&, which causes them to deliver the message in
20548 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20549 &%check_string%& and &%escape_string%& options are forced to the values
20550 .code
20551 check_string = "."
20552 escape_string = ".."
20553 .endd
20554 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20555 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20556 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20557
20558 .cindex "&'Envelope-to:'& header line"
20559 If the generic &%envelope_to_add%& option is set for a batching transport, the
20560 &'Envelope-to:'& header that is added to the message contains all the addresses
20561 that are being processed together. If you are using a batching &(appendfile)&
20562 transport without &%use_bsmtp%&, the only way to preserve the recipient
20563 addresses is to set the &%envelope_to_add%& option.
20564
20565 .cindex "&(pipe)& transport" "with multiple addresses"
20566 .vindex "&$pipe_addresses$&"
20567 If you are using a &(pipe)& transport without BSMTP, and setting the
20568 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20569 the command. This is not a true variable; it is a bit of magic that causes each
20570 of the recipient addresses to be inserted into the command as a separate
20571 argument. This provides a way of accessing all the addresses that are being
20572 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20573 are specified by a &(redirect)& router.
20574
20575
20576
20577
20578 . ////////////////////////////////////////////////////////////////////////////
20579 . ////////////////////////////////////////////////////////////////////////////
20580
20581 .chapter "The appendfile transport" "CHAPappendfile"
20582 .scindex IIDapptra1 "&(appendfile)& transport"
20583 .scindex IIDapptra2 "transports" "&(appendfile)&"
20584 .cindex "directory creation"
20585 .cindex "creating directories"
20586 The &(appendfile)& transport delivers a message by appending it to an existing
20587 file, or by creating an entirely new file in a specified directory. Single
20588 files to which messages are appended can be in the traditional Unix mailbox
20589 format, or optionally in the MBX format supported by the Pine MUA and
20590 University of Washington IMAP daemon, &'inter alia'&. When each message is
20591 being delivered as a separate file, &"maildir"& format can optionally be used
20592 to give added protection against failures that happen part-way through the
20593 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20594 supported. For all file formats, Exim attempts to create as many levels of
20595 directory as necessary, provided that &%create_directory%& is set.
20596
20597 The code for the optional formats is not included in the Exim binary by
20598 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20599 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20600 included.
20601
20602 .cindex "quota" "system"
20603 Exim recognizes system quota errors, and generates an appropriate message. Exim
20604 also supports its own quota control within the transport, for use when the
20605 system facility is unavailable or cannot be used for some reason.
20606
20607 If there is an error while appending to a file (for example, quota exceeded or
20608 partition filled), Exim attempts to reset the file's length and last
20609 modification time back to what they were before. If there is an error while
20610 creating an entirely new file, the new file is removed.
20611
20612 Before appending to a file, a number of security checks are made, and the
20613 file is locked. A detailed description is given below, after the list of
20614 private options.
20615
20616 The &(appendfile)& transport is most commonly used for local deliveries to
20617 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20618 putting messages into files for remote delivery by some means other than Exim.
20619 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20620 option).
20621
20622
20623
20624 .section "The file and directory options" "SECTfildiropt"
20625 The &%file%& option specifies a single file, to which the message is appended;
20626 the &%directory%& option specifies a directory, in which a new file containing
20627 the message is created. Only one of these two options can be set, and for
20628 normal deliveries to mailboxes, one of them &'must'& be set.
20629
20630 .vindex "&$address_file$&"
20631 .vindex "&$local_part$&"
20632 However, &(appendfile)& is also used for delivering messages to files or
20633 directories whose names (or parts of names) are obtained from alias,
20634 forwarding, or filtering operations (for example, a &%save%& command in a
20635 user's Exim filter). When such a transport is running, &$local_part$& contains
20636 the local part that was aliased or forwarded, and &$address_file$& contains the
20637 name (or partial name) of the file or directory generated by the redirection
20638 operation. There are two cases:
20639
20640 .ilist
20641 If neither &%file%& nor &%directory%& is set, the redirection operation
20642 must specify an absolute path (one that begins with &`/`&). This is the most
20643 common case when users with local accounts use filtering to sort mail into
20644 different folders. See for example, the &(address_file)& transport in the
20645 default configuration. If the path ends with a slash, it is assumed to be the
20646 name of a directory. A delivery to a directory can also be forced by setting
20647 &%maildir_format%& or &%mailstore_format%&.
20648 .next
20649 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20650 used to determine the file or directory name for the delivery. Normally, the
20651 contents of &$address_file$& are used in some way in the string expansion.
20652 .endlist
20653
20654
20655 .cindex "Sieve filter" "configuring &(appendfile)&"
20656 .cindex "Sieve filter" "relative mailbox path handling"
20657 As an example of the second case, consider an environment where users do not
20658 have home directories. They may be permitted to use Exim filter commands of the
20659 form:
20660 .code
20661 save folder23
20662 .endd
20663 or Sieve filter commands of the form:
20664 .code
20665 require "fileinto";
20666 fileinto "folder23";
20667 .endd
20668 In this situation, the expansion of &%file%& or &%directory%& in the transport
20669 must transform the relative path into an appropriate absolute file name. In the
20670 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20671 is used as a result of a &"keep"& action in the filter. This example shows one
20672 way of handling this requirement:
20673 .code
20674 file = ${if eq{$address_file}{inbox} \
20675             {/var/mail/$local_part} \
20676             {${if eq{${substr_0_1:$address_file}}{/} \
20677                   {$address_file} \
20678                   {$home/mail/$address_file} \
20679             }} \
20680        }
20681 .endd
20682 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20683 location, absolute paths are used without change, and other folders are in the
20684 &_mail_& directory within the home directory.
20685
20686 &*Note 1*&: While processing an Exim filter, a relative path such as
20687 &_folder23_& is turned into an absolute path if a home directory is known to
20688 the router. In particular, this is the case if &%check_local_user%& is set. If
20689 you want to prevent this happening at routing time, you can set
20690 &%router_home_directory%& empty. This forces the router to pass the relative
20691 path to the transport.
20692
20693 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20694 the &%file%& or &%directory%& option is still used if it is set.
20695
20696
20697
20698
20699 .section "Private options for appendfile" "SECID134"
20700 .cindex "options" "&(appendfile)& transport"
20701
20702
20703
20704 .option allow_fifo appendfile boolean false
20705 .cindex "fifo (named pipe)"
20706 .cindex "named pipe (fifo)"
20707 .cindex "pipe" "named (fifo)"
20708 Setting this option permits delivery to named pipes (FIFOs) as well as to
20709 regular files. If no process is reading the named pipe at delivery time, the
20710 delivery is deferred.
20711
20712
20713 .option allow_symlink appendfile boolean false
20714 .cindex "symbolic link" "to mailbox"
20715 .cindex "mailbox" "symbolic link"
20716 By default, &(appendfile)& will not deliver if the path name for the file is
20717 that of a symbolic link. Setting this option relaxes that constraint, but there
20718 are security issues involved in the use of symbolic links. Be sure you know
20719 what you are doing if you set this. Details of exactly what this option affects
20720 are included in the discussion which follows this list of options.
20721
20722
20723 .option batch_id appendfile string&!! unset
20724 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20725 However, batching is automatically disabled for &(appendfile)& deliveries that
20726 happen as a result of forwarding or aliasing or other redirection directly to a
20727 file.
20728
20729
20730 .option batch_max appendfile integer 1
20731 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20732
20733
20734 .option check_group appendfile boolean false
20735 When this option is set, the group owner of the file defined by the &%file%&
20736 option is checked to see that it is the same as the group under which the
20737 delivery process is running. The default setting is false because the default
20738 file mode is 0600, which means that the group is irrelevant.
20739
20740
20741 .option check_owner appendfile boolean true
20742 When this option is set, the owner of the file defined by the &%file%& option
20743 is checked to ensure that it is the same as the user under which the delivery
20744 process is running.
20745
20746
20747 .option check_string appendfile string "see below"
20748 .cindex "&""From""& line"
20749 As &(appendfile)& writes the message, the start of each line is tested for
20750 matching &%check_string%&, and if it does, the initial matching characters are
20751 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20752 a literal string, not a regular expression, and the case of any letters it
20753 contains is significant.
20754
20755 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20756 are forced to &"."& and &".."& respectively, and any settings in the
20757 configuration are ignored. Otherwise, they default to &"From&~"& and
20758 &">From&~"& when the &%file%& option is set, and unset when any of the
20759 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20760
20761 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20762 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20763 &"From&~"& indicates the start of a new message. All four options need changing
20764 if another format is used. For example, to deliver to mailboxes in MMDF format:
20765 .cindex "MMDF format mailbox"
20766 .cindex "mailbox" "MMDF format"
20767 .code
20768 check_string = "\1\1\1\1\n"
20769 escape_string = "\1\1\1\1 \n"
20770 message_prefix = "\1\1\1\1\n"
20771 message_suffix = "\1\1\1\1\n"
20772 .endd
20773 .option create_directory appendfile boolean true
20774 .cindex "directory creation"
20775 When this option is true, Exim attempts to create any missing superior
20776 directories for the file that it is about to write. A created directory's mode
20777 is given by the &%directory_mode%& option.
20778
20779 The group ownership of a newly created directory is highly dependent on the
20780 operating system (and possibly the file system) that is being used. For
20781 example, in Solaris, if the parent directory has the setgid bit set, its group
20782 is propagated to the child; if not, the currently set group is used. However,
20783 in FreeBSD, the parent's group is always used.
20784
20785
20786
20787 .option create_file appendfile string anywhere
20788 This option constrains the location of files and directories that are created
20789 by this transport. It applies to files defined by the &%file%& option and
20790 directories defined by the &%directory%& option. In the case of maildir
20791 delivery, it applies to the top level directory, not the maildir directories
20792 beneath.
20793
20794 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20795 &"belowhome"&. In the second and third cases, a home directory must have been
20796 set for the transport. This option is not useful when an explicit file name is
20797 given for normal mailbox deliveries. It is intended for the case when file
20798 names are generated from users' &_.forward_& files. These are usually handled
20799 by an &(appendfile)& transport called &%address_file%&. See also
20800 &%file_must_exist%&.
20801
20802
20803 .option directory appendfile string&!! unset
20804 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20805 or &%directory%& must be set, unless the delivery is the direct result of a
20806 redirection (see section &<<SECTfildiropt>>&).
20807
20808 When &%directory%& is set, the string is expanded, and the message is delivered
20809 into a new file or files in or below the given directory, instead of being
20810 appended to a single mailbox file. A number of different formats are provided
20811 (see &%maildir_format%& and &%mailstore_format%&), and see section
20812 &<<SECTopdir>>& for further details of this form of delivery.
20813
20814
20815 .option directory_file appendfile string&!! "see below"
20816 .cindex "base62"
20817 .vindex "&$inode$&"
20818 When &%directory%& is set, but neither &%maildir_format%& nor
20819 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20820 whose name is obtained by expanding this string. The default value is:
20821 .code
20822 q${base62:$tod_epoch}-$inode
20823 .endd
20824 This generates a unique name from the current time, in base 62 form, and the
20825 inode of the file. The variable &$inode$& is available only when expanding this
20826 option.
20827
20828
20829 .option directory_mode appendfile "octal integer" 0700
20830 If &(appendfile)& creates any directories as a result of the
20831 &%create_directory%& option, their mode is specified by this option.
20832
20833
20834 .option escape_string appendfile string "see description"
20835 See &%check_string%& above.
20836
20837
20838 .option file appendfile string&!! unset
20839 This option is mutually exclusive with the &%directory%& option, but one of
20840 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20841 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20842 specifies a single file, to which the message is appended. One or more of
20843 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20844 &%file%&.
20845
20846 .cindex "NFS" "lock file"
20847 .cindex "locking files"
20848 .cindex "lock files"
20849 If you are using more than one host to deliver over NFS into the same
20850 mailboxes, you should always use lock files.
20851
20852 The string value is expanded for each delivery, and must yield an absolute
20853 path. The most common settings of this option are variations on one of these
20854 examples:
20855 .code
20856 file = /var/spool/mail/$local_part
20857 file = /home/$local_part/inbox
20858 file = $home/inbox
20859 .endd
20860 .cindex "&""sticky""& bit"
20861 In the first example, all deliveries are done into the same directory. If Exim
20862 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20863 create a file in the directory, so the &"sticky"& bit must be turned on for
20864 deliveries to be possible, or alternatively the &%group%& option can be used to
20865 run the delivery under a group id which has write access to the directory.
20866
20867
20868
20869 .option file_format appendfile string unset
20870 .cindex "file" "mailbox; checking existing format"
20871 This option requests the transport to check the format of an existing file
20872 before adding to it. The check consists of matching a specific string at the
20873 start of the file. The value of the option consists of an even number of
20874 colon-separated strings. The first of each pair is the test string, and the
20875 second is the name of a transport. If the transport associated with a matched
20876 string is not the current transport, control is passed over to the other
20877 transport. For example, suppose the standard &(local_delivery)& transport has
20878 this added to it:
20879 .code
20880 file_format = "From       : local_delivery :\
20881                \1\1\1\1\n : local_mmdf_delivery"
20882 .endd
20883 Mailboxes that begin with &"From"& are still handled by this transport, but if
20884 a mailbox begins with four binary ones followed by a newline, control is passed
20885 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20886 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20887 is assumed to match the current transport. If the start of a mailbox doesn't
20888 match any string, or if the transport named for a given string is not defined,
20889 delivery is deferred.
20890
20891
20892 .option file_must_exist appendfile boolean false
20893 If this option is true, the file specified by the &%file%& option must exist.
20894 A temporary error occurs if it does not, causing delivery to be deferred.
20895 If this option is false, the file is created if it does not exist.
20896
20897
20898 .option lock_fcntl_timeout appendfile time 0s
20899 .cindex "timeout" "mailbox locking"
20900 .cindex "mailbox" "locking, blocking and non-blocking"
20901 .cindex "locking files"
20902 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20903 when locking an open mailbox file. If the call fails, the delivery process
20904 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20905 Non-blocking calls are used so that the file is not kept open during the wait
20906 for the lock; the reason for this is to make it as safe as possible for
20907 deliveries over NFS in the case when processes might be accessing an NFS
20908 mailbox without using a lock file. This should not be done, but
20909 misunderstandings and hence misconfigurations are not unknown.
20910
20911 On a busy system, however, the performance of a non-blocking lock approach is
20912 not as good as using a blocking lock with a timeout. In this case, the waiting
20913 is done inside the system call, and Exim's delivery process acquires the lock
20914 and can proceed as soon as the previous lock holder releases it.
20915
20916 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20917 timeout, are used. There may still be some retrying: the maximum number of
20918 retries is
20919 .code
20920 (lock_retries * lock_interval) / lock_fcntl_timeout
20921 .endd
20922 rounded up to the next whole number. In other words, the total time during
20923 which &(appendfile)& is trying to get a lock is roughly the same, unless
20924 &%lock_fcntl_timeout%& is set very large.
20925
20926 You should consider setting this option if you are getting a lot of delayed
20927 local deliveries because of errors of the form
20928 .code
20929 failed to lock mailbox /some/file (fcntl)
20930 .endd
20931
20932 .option lock_flock_timeout appendfile time 0s
20933 This timeout applies to file locking when using &[flock()]& (see
20934 &%use_flock%&); the timeout operates in a similar manner to
20935 &%lock_fcntl_timeout%&.
20936
20937
20938 .option lock_interval appendfile time 3s
20939 This specifies the time to wait between attempts to lock the file. See below
20940 for details of locking.
20941
20942
20943 .option lock_retries appendfile integer 10
20944 This specifies the maximum number of attempts to lock the file. A value of zero
20945 is treated as 1. See below for details of locking.
20946
20947
20948 .option lockfile_mode appendfile "octal integer" 0600
20949 This specifies the mode of the created lock file, when a lock file is being
20950 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20951
20952
20953 .option lockfile_timeout appendfile time 30m
20954 .cindex "timeout" "mailbox locking"
20955 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20956 exists and is older than this value, it is assumed to have been left behind by
20957 accident, and Exim attempts to remove it.
20958
20959
20960 .option mailbox_filecount appendfile string&!! unset
20961 .cindex "mailbox" "specifying size of"
20962 .cindex "size" "of mailbox"
20963 If this option is set, it is expanded, and the result is taken as the current
20964 number of files in the mailbox. It must be a decimal number, optionally
20965 followed by K or M. This provides a way of obtaining this information from an
20966 external source that maintains the data.
20967
20968
20969 .option mailbox_size appendfile string&!! unset
20970 .cindex "mailbox" "specifying size of"
20971 .cindex "size" "of mailbox"
20972 If this option is set, it is expanded, and the result is taken as the current
20973 size the mailbox. It must be a decimal number, optionally followed by K or M.
20974 This provides a way of obtaining this information from an external source that
20975 maintains the data. This is likely to be helpful for maildir deliveries where
20976 it is computationally expensive to compute the size of a mailbox.
20977
20978
20979
20980 .option maildir_format appendfile boolean false
20981 .cindex "maildir format" "specifying"
20982 If this option is set with the &%directory%& option, the delivery is into a new
20983 file, in the &"maildir"& format that is used by other mail software. When the
20984 transport is activated directly from a &(redirect)& router (for example, the
20985 &(address_file)& transport in the default configuration), setting
20986 &%maildir_format%& causes the path received from the router to be treated as a
20987 directory, whether or not it ends with &`/`&. This option is available only if
20988 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20989 &<<SECTmaildirdelivery>>& below for further details.
20990
20991
20992 .option maildir_quota_directory_regex appendfile string "See below"
20993 .cindex "maildir format" "quota; directories included in"
20994 .cindex "quota" "maildir; directories included in"
20995 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20996 a regular expression for specifying directories, relative to the quota
20997 directory (see &%quota_directory%&), that should be included in the quota
20998 calculation. The default value is:
20999 .code
21000 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21001 .endd
21002 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21003 (directories whose names begin with a dot). If you want to exclude the
21004 &_Trash_&
21005 folder from the count (as some sites do), you need to change this setting to
21006 .code
21007 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21008 .endd
21009 This uses a negative lookahead in the regular expression to exclude the
21010 directory whose name is &_.Trash_&. When a directory is excluded from quota
21011 calculations, quota processing is bypassed for any messages that are delivered
21012 directly into that directory.
21013
21014
21015 .option maildir_retries appendfile integer 10
21016 This option specifies the number of times to retry when writing a file in
21017 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21018
21019
21020 .option maildir_tag appendfile string&!! unset
21021 This option applies only to deliveries in maildir format, and is described in
21022 section &<<SECTmaildirdelivery>>& below.
21023
21024
21025 .option maildir_use_size_file appendfile&!! boolean false
21026 .cindex "maildir format" "&_maildirsize_& file"
21027 The result of string expansion for this option must be a valid boolean value.
21028 If it is true, it enables support for &_maildirsize_& files. Exim
21029 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21030 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21031 value is zero. See &%maildir_quota_directory_regex%& above and section
21032 &<<SECTmaildirdelivery>>& below for further details.
21033
21034 .option maildirfolder_create_regex appendfile string unset
21035 .cindex "maildir format" "&_maildirfolder_& file"
21036 .cindex "&_maildirfolder_&, creating"
21037 The value of this option is a regular expression. If it is unset, it has no
21038 effect. Otherwise, before a maildir delivery takes place, the pattern is
21039 matched against the name of the maildir directory, that is, the directory
21040 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21041 delivery. If there is a match, Exim checks for the existence of a file called
21042 &_maildirfolder_& in the directory, and creates it if it does not exist.
21043 See section &<<SECTmaildirdelivery>>& for more details.
21044
21045
21046 .option mailstore_format appendfile boolean false
21047 .cindex "mailstore format" "specifying"
21048 If this option is set with the &%directory%& option, the delivery is into two
21049 new files in  &"mailstore"& format. The option is available only if
21050 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21051 below for further details.
21052
21053
21054 .option mailstore_prefix appendfile string&!! unset
21055 This option applies only to deliveries in mailstore format, and is described in
21056 section &<<SECTopdir>>& below.
21057
21058
21059 .option mailstore_suffix appendfile string&!! unset
21060 This option applies only to deliveries in mailstore format, and is described in
21061 section &<<SECTopdir>>& below.
21062
21063
21064 .option mbx_format appendfile boolean false
21065 .cindex "locking files"
21066 .cindex "file" "locking"
21067 .cindex "file" "MBX format"
21068 .cindex "MBX format, specifying"
21069 This option is available only if Exim has been compiled with SUPPORT_MBX
21070 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21071 the message is appended to the mailbox file in MBX format instead of
21072 traditional Unix format. This format is supported by Pine4 and its associated
21073 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21074
21075 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21076 automatically changed by the use of &%mbx_format%&. They should normally be set
21077 empty when using MBX format, so this option almost always appears in this
21078 combination:
21079 .code
21080 mbx_format = true
21081 message_prefix =
21082 message_suffix =
21083 .endd
21084 If none of the locking options are mentioned in the configuration,
21085 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21086 is possible to specify the other kinds of locking with &%mbx_format%&, but
21087 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21088 interworks with &'c-client'&, providing for shared access to the mailbox. It
21089 should not be used if any program that does not use this form of locking is
21090 going to access the mailbox, nor should it be used if the mailbox file is NFS
21091 mounted, because it works only when the mailbox is accessed from a single host.
21092
21093 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21094 the standard version of &'c-client'&, because as long as it has a mailbox open
21095 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21096 append messages to it.
21097
21098
21099 .option message_prefix appendfile string&!! "see below"
21100 .cindex "&""From""& line"
21101 The string specified here is expanded and output at the start of every message.
21102 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21103 in which case it is:
21104 .code
21105 message_prefix = "From ${if def:return_path{$return_path}\
21106   {MAILER-DAEMON}} $tod_bsdinbox\n"
21107 .endd
21108 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21109 &`\n`& to &`\r\n`& in &%message_prefix%&.
21110
21111 .option message_suffix appendfile string&!! "see below"
21112 The string specified here is expanded and output at the end of every message.
21113 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21114 in which case it is a single newline character. The suffix can be suppressed by
21115 setting
21116 .code
21117 message_suffix =
21118 .endd
21119 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21120 &`\n`& to &`\r\n`& in &%message_suffix%&.
21121
21122 .option mode appendfile "octal integer" 0600
21123 If the output file is created, it is given this mode. If it already exists and
21124 has wider permissions, they are reduced to this mode. If it has narrower
21125 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21126 if the delivery is the result of a &%save%& command in a filter file specifying
21127 a particular mode, the mode of the output file is always forced to take that
21128 value, and this option is ignored.
21129
21130
21131 .option mode_fail_narrower appendfile boolean true
21132 This option applies in the case when an existing mailbox file has a narrower
21133 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21134 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21135 continues with the delivery attempt, using the existing mode of the file.
21136
21137
21138 .option notify_comsat appendfile boolean false
21139 If this option is true, the &'comsat'& daemon is notified after every
21140 successful delivery to a user mailbox. This is the daemon that notifies logged
21141 on users about incoming mail.
21142
21143
21144 .option quota appendfile string&!! unset
21145 .cindex "quota" "imposed by Exim"
21146 This option imposes a limit on the size of the file to which Exim is appending,
21147 or to the total space used in the directory tree when the &%directory%& option
21148 is set. In the latter case, computation of the space used is expensive, because
21149 all the files in the directory (and any sub-directories) have to be
21150 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21151 &%maildir_use_size_file%& for ways to avoid this in environments where users
21152 have no shell access to their mailboxes).
21153
21154 As there is no interlock against two simultaneous deliveries into a
21155 multi-file mailbox, it is possible for the quota to be overrun in this case.
21156 For single-file mailboxes, of course, an interlock is a necessity.
21157
21158 A file's size is taken as its &'used'& value. Because of blocking effects, this
21159 may be a lot less than the actual amount of disk space allocated to the file.
21160 If the sizes of a number of files are being added up, the rounding effect can
21161 become quite noticeable, especially on systems that have large block sizes.
21162 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21163 the obvious value which users understand most easily.
21164
21165 The value of the option is expanded, and must then be a numerical value
21166 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21167 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21168 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21169 be handled.
21170
21171 &*Note*&: A value of zero is interpreted as &"no quota"&.
21172
21173 The expansion happens while Exim is running as root, before it changes uid for
21174 the delivery. This means that files that are inaccessible to the end user can
21175 be used to hold quota values that are looked up in the expansion. When delivery
21176 fails because this quota is exceeded, the handling of the error is as for
21177 system quota failures.
21178
21179 By default, Exim's quota checking mimics system quotas, and restricts the
21180 mailbox to the specified maximum size, though the value is not accurate to the
21181 last byte, owing to separator lines and additional headers that may get added
21182 during message delivery. When a mailbox is nearly full, large messages may get
21183 refused even though small ones are accepted, because the size of the current
21184 message is added to the quota when the check is made. This behaviour can be
21185 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21186 for exceeding the quota does not include the current message. Thus, deliveries
21187 continue until the quota has been exceeded; thereafter, no further messages are
21188 delivered. See also &%quota_warn_threshold%&.
21189
21190
21191 .option quota_directory appendfile string&!! unset
21192 This option defines the directory to check for quota purposes when delivering
21193 into individual files. The default is the delivery directory, or, if a file
21194 called &_maildirfolder_& exists in a maildir directory, the parent of the
21195 delivery directory.
21196
21197
21198 .option quota_filecount appendfile string&!! 0
21199 This option applies when the &%directory%& option is set. It limits the total
21200 number of files in the directory (compare the inode limit in system quotas). It
21201 can only be used if &%quota%& is also set. The value is expanded; an expansion
21202 failure causes delivery to be deferred. A value of zero is interpreted as
21203 &"no quota"&.
21204
21205
21206 .option quota_is_inclusive appendfile boolean true
21207 See &%quota%& above.
21208
21209
21210 .option quota_size_regex appendfile string unset
21211 This option applies when one of the delivery modes that writes a separate file
21212 for each message is being used. When Exim wants to find the size of one of
21213 these files in order to test the quota, it first checks &%quota_size_regex%&.
21214 If this is set to a regular expression that matches the file name, and it
21215 captures one string, that string is interpreted as a representation of the
21216 file's size. The value of &%quota_size_regex%& is not expanded.
21217
21218 This feature is useful only when users have no shell access to their mailboxes
21219 &-- otherwise they could defeat the quota simply by renaming the files. This
21220 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21221 the file length to the file name. For example:
21222 .code
21223 maildir_tag = ,S=$message_size
21224 quota_size_regex = ,S=(\d+)
21225 .endd
21226 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21227 number of lines in the message.
21228
21229 The regular expression should not assume that the length is at the end of the
21230 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21231 sometimes add other information onto the ends of message file names.
21232
21233 Section &<<SECID136>>& contains further information.
21234
21235
21236 .option quota_warn_message appendfile string&!! "see below"
21237 See below for the use of this option. If it is not set when
21238 &%quota_warn_threshold%& is set, it defaults to
21239 .code
21240 quota_warn_message = "\
21241   To: $local_part@$domain\n\
21242   Subject: Your mailbox\n\n\
21243   This message is automatically created \
21244   by mail delivery software.\n\n\
21245   The size of your mailbox has exceeded \
21246   a warning threshold that is\n\
21247   set by the system administrator.\n"
21248 .endd
21249
21250
21251 .option quota_warn_threshold appendfile string&!! 0
21252 .cindex "quota" "warning threshold"
21253 .cindex "mailbox" "size warning"
21254 .cindex "size" "of mailbox"
21255 This option is expanded in the same way as &%quota%& (see above). If the
21256 resulting value is greater than zero, and delivery of the message causes the
21257 size of the file or total space in the directory tree to cross the given
21258 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21259 may be specified as a percentage of it by following the value with a percent
21260 sign. For example:
21261 .code
21262 quota = 10M
21263 quota_warn_threshold = 75%
21264 .endd
21265 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21266 percent sign is ignored.
21267
21268 The warning message itself is specified by the &%quota_warn_message%& option,
21269 and it must start with a &'To:'& header line containing the recipient(s) of the
21270 warning message. These do not necessarily have to include the recipient(s) of
21271 the original message. A &'Subject:'& line should also normally be supplied. You
21272 can include any other header lines that you want. If you do not include a
21273 &'From:'& line, the default is:
21274 .code
21275 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21276 .endd
21277 .oindex &%errors_reply_to%&
21278 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21279 option.
21280
21281 The &%quota%& option does not have to be set in order to use this option; they
21282 are independent of one another except when the threshold is specified as a
21283 percentage.
21284
21285
21286 .option use_bsmtp appendfile boolean false
21287 .cindex "envelope sender"
21288 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21289 format, with the envelope sender and recipient(s) included as SMTP commands. If
21290 you want to include a leading HELO command with such messages, you can do
21291 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21292 for details of batch SMTP.
21293
21294
21295 .option use_crlf appendfile boolean false
21296 .cindex "carriage return"
21297 .cindex "linefeed"
21298 This option causes lines to be terminated with the two-character CRLF sequence
21299 (carriage return, linefeed) instead of just a linefeed character. In the case
21300 of batched SMTP, the byte sequence written to the file is then an exact image
21301 of what would be sent down a real SMTP connection.
21302
21303 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21304 (which are used to supply the traditional &"From&~"& and blank line separators
21305 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21306 carriage return characters if these are needed. In cases where these options
21307 have non-empty defaults, the values end with a single linefeed, so they must be
21308 changed to end with &`\r\n`& if &%use_crlf%& is set.
21309
21310
21311 .option use_fcntl_lock appendfile boolean "see below"
21312 This option controls the use of the &[fcntl()]& function to lock a file for
21313 exclusive use when a message is being appended. It is set by default unless
21314 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21315 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21316 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21317
21318
21319 .option use_flock_lock appendfile boolean false
21320 This option is provided to support the use of &[flock()]& for file locking, for
21321 the few situations where it is needed. Most modern operating systems support
21322 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21323 each other. Exim uses &[fcntl()]& locking by default.
21324
21325 This option is required only if you are using an operating system where
21326 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21327 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21328 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21329
21330 .cindex "Solaris" "&[flock()]& support"
21331 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21332 have it (and some, I think, provide a not quite right version built on top of
21333 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21334 the ability to use it, and any attempt to do so will cause a configuration
21335 error.
21336
21337 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21338 is just being mapped onto &[fcntl()]& by the OS).
21339
21340
21341 .option use_lockfile appendfile boolean "see below"
21342 If this option is turned off, Exim does not attempt to create a lock file when
21343 appending to a mailbox file. In this situation, the only locking is by
21344 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21345 sure that every MUA that is ever going to look at your users' mailboxes uses
21346 &[fcntl()]& rather than a lock file, and even then only when you are not
21347 delivering over NFS from more than one host.
21348
21349 .cindex "NFS" "lock file"
21350 In order to append to an NFS file safely from more than one host, it is
21351 necessary to take out a lock &'before'& opening the file, and the lock file
21352 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21353 file corruption.
21354
21355 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21356 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21357 except when &%mbx_format%& is set.
21358
21359
21360 .option use_mbx_lock appendfile boolean "see below"
21361 This option is available only if Exim has been compiled with SUPPORT_MBX
21362 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21363 locking rules be used. It is set by default if &%mbx_format%& is set and none
21364 of the locking options are mentioned in the configuration. The locking rules
21365 are the same as are used by the &'c-client'& library that underlies Pine and
21366 the IMAP4 and POP daemons that come with it (see the discussion below). The
21367 rules allow for shared access to the mailbox. However, this kind of locking
21368 does not work when the mailbox is NFS mounted.
21369
21370 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21371 &%use_flock_lock%& to control what kind of locking is used in implementing the
21372 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21373 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21374
21375
21376
21377
21378 .section "Operational details for appending" "SECTopappend"
21379 .cindex "appending to a file"
21380 .cindex "file" "appending"
21381 Before appending to a file, the following preparations are made:
21382
21383 .ilist
21384 If the name of the file is &_/dev/null_&, no action is taken, and a success
21385 return is given.
21386
21387 .next
21388 .cindex "directory creation"
21389 If any directories on the file's path are missing, Exim creates them if the
21390 &%create_directory%& option is set. A created directory's mode is given by the
21391 &%directory_mode%& option.
21392
21393 .next
21394 If &%file_format%& is set, the format of an existing file is checked. If this
21395 indicates that a different transport should be used, control is passed to that
21396 transport.
21397
21398 .next
21399 .cindex "file" "locking"
21400 .cindex "locking files"
21401 .cindex "NFS" "lock file"
21402 If &%use_lockfile%& is set, a lock file is built in a way that will work
21403 reliably over NFS, as follows:
21404
21405 .olist
21406 Create a &"hitching post"& file whose name is that of the lock file with the
21407 current time, primary host name, and process id added, by opening for writing
21408 as a new file. If this fails with an access error, delivery is deferred.
21409 .next
21410 Close the hitching post file, and hard link it to the lock file name.
21411 .next
21412 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21413 Unlink the hitching post name.
21414 .next
21415 Otherwise, use &[stat()]& to get information about the hitching post file, and
21416 then unlink hitching post name. If the number of links is exactly two, creation
21417 of the lock file succeeded but something (for example, an NFS server crash and
21418 restart) caused this fact not to be communicated to the &[link()]& call.
21419 .next
21420 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21421 up to &%lock_retries%& times. However, since any program that writes to a
21422 mailbox should complete its task very quickly, it is reasonable to time out old
21423 lock files that are normally the result of user agent and system crashes. If an
21424 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21425 it before trying again.
21426 .endlist olist
21427
21428 .next
21429 A call is made to &[lstat()]& to discover whether the main file exists, and if
21430 so, what its characteristics are. If &[lstat()]& fails for any reason other
21431 than non-existence, delivery is deferred.
21432
21433 .next
21434 .cindex "symbolic link" "to mailbox"
21435 .cindex "mailbox" "symbolic link"
21436 If the file does exist and is a symbolic link, delivery is deferred, unless the
21437 &%allow_symlink%& option is set, in which case the ownership of the link is
21438 checked, and then &[stat()]& is called to find out about the real file, which
21439 is then subjected to the checks below. The check on the top-level link
21440 ownership prevents one user creating a link for another's mailbox in a sticky
21441 directory, though allowing symbolic links in this case is definitely not a good
21442 idea. If there is a chain of symbolic links, the intermediate ones are not
21443 checked.
21444
21445 .next
21446 If the file already exists but is not a regular file, or if the file's owner
21447 and group (if the group is being checked &-- see &%check_group%& above) are
21448 different from the user and group under which the delivery is running,
21449 delivery is deferred.
21450
21451 .next
21452 If the file's permissions are more generous than specified, they are reduced.
21453 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21454 is set false, in which case the delivery is tried using the existing
21455 permissions.
21456
21457 .next
21458 The file's inode number is saved, and the file is then opened for appending.
21459 If this fails because the file has vanished, &(appendfile)& behaves as if it
21460 hadn't existed (see below). For any other failures, delivery is deferred.
21461
21462 .next
21463 If the file is opened successfully, check that the inode number hasn't
21464 changed, that it is still a regular file, and that the owner and permissions
21465 have not changed. If anything is wrong, defer delivery and freeze the message.
21466
21467 .next
21468 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21469 option is set. Otherwise, check that the file is being created in a permitted
21470 directory if the &%create_file%& option is set (deferring on failure), and then
21471 open for writing as a new file, with the O_EXCL and O_CREAT options,
21472 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21473 set). In this case, which can happen if the link points to a non-existent file,
21474 the file is opened for writing using O_CREAT but not O_EXCL, because
21475 that prevents link following.
21476
21477 .next
21478 .cindex "loop" "while file testing"
21479 If opening fails because the file exists, obey the tests given above for
21480 existing files. However, to avoid looping in a situation where the file is
21481 being continuously created and destroyed, the exists/not-exists loop is broken
21482 after 10 repetitions, and the message is then frozen.
21483
21484 .next
21485 If opening fails with any other error, defer delivery.
21486
21487 .next
21488 .cindex "file" "locking"
21489 .cindex "locking files"
21490 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21491 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21492 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21493 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21494 file, and an exclusive lock on the file whose name is
21495 .code
21496 /tmp/.<device-number>.<inode-number>
21497 .endd
21498 using the device and inode numbers of the open mailbox file, in accordance with
21499 the MBX locking rules. This file is created with a mode that is specified by
21500 the &%lockfile_mode%& option.
21501
21502 If Exim fails to lock the file, there are two possible courses of action,
21503 depending on the value of the locking timeout. This is obtained from
21504 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21505
21506 If the timeout value is zero, the file is closed, Exim waits for
21507 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21508 to lock it again. This happens up to &%lock_retries%& times, after which the
21509 delivery is deferred.
21510
21511 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21512 &[flock()]& are used (with the given timeout), so there has already been some
21513 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21514 immediately. It retries up to
21515 .code
21516 (lock_retries * lock_interval) / <timeout>
21517 .endd
21518 times (rounded up).
21519 .endlist
21520
21521 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21522 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21523
21524
21525 .section "Operational details for delivery to a new file" "SECTopdir"
21526 .cindex "delivery" "to single file"
21527 .cindex "&""From""& line"
21528 When the &%directory%& option is set instead of &%file%&, each message is
21529 delivered into a newly-created file or set of files. When &(appendfile)& is
21530 activated directly from a &(redirect)& router, neither &%file%& nor
21531 &%directory%& is normally set, because the path for delivery is supplied by the
21532 router. (See for example, the &(address_file)& transport in the default
21533 configuration.) In this case, delivery is to a new file if either the path name
21534 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21535
21536 No locking is required while writing the message to a new file, so the various
21537 locking options of the transport are ignored. The &"From"& line that by default
21538 separates messages in a single file is not normally needed, nor is the escaping
21539 of message lines that start with &"From"&, and there is no need to ensure a
21540 newline at the end of each message. Consequently, the default values for
21541 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21542 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21543
21544 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21545 the files in the delivery directory by default. However, you can specify a
21546 different directory by setting &%quota_directory%&. Also, for maildir
21547 deliveries (see below) the &_maildirfolder_& convention is honoured.
21548
21549
21550 .cindex "maildir format"
21551 .cindex "mailstore format"
21552 There are three different ways in which delivery to individual files can be
21553 done, controlled by the settings of the &%maildir_format%& and
21554 &%mailstore_format%& options. Note that code to support maildir or mailstore
21555 formats is not included in the binary unless SUPPORT_MAILDIR or
21556 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21557
21558 .cindex "directory creation"
21559 In all three cases an attempt is made to create the directory and any necessary
21560 sub-directories if they do not exist, provided that the &%create_directory%&
21561 option is set (the default). The location of a created directory can be
21562 constrained by setting &%create_file%&. A created directory's mode is given by
21563 the &%directory_mode%& option. If creation fails, or if the
21564 &%create_directory%& option is not set when creation is required, delivery is
21565 deferred.
21566
21567
21568
21569 .section "Maildir delivery" "SECTmaildirdelivery"
21570 .cindex "maildir format" "description of"
21571 If the &%maildir_format%& option is true, Exim delivers each message by writing
21572 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21573 directory that is defined by the &%directory%& option (the &"delivery
21574 directory"&). If the delivery is successful, the file is renamed into the
21575 &_new_& subdirectory.
21576
21577 In the file name, <&'stime'&> is the current time of day in seconds, and
21578 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21579 Exim checks that the time-of-day clock has moved on by at least one microsecond
21580 before terminating the delivery process. This guarantees uniqueness for the
21581 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21582 opening it. If any response other than ENOENT (does not exist) is given,
21583 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21584
21585 Before Exim carries out a maildir delivery, it ensures that subdirectories
21586 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21587 do not exist, Exim tries to create them and any superior directories in their
21588 path, subject to the &%create_directory%& and &%create_file%& options. If the
21589 &%maildirfolder_create_regex%& option is set, and the regular expression it
21590 contains matches the delivery directory, Exim also ensures that a file called
21591 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21592 &_maildirfolder_& file cannot be created, delivery is deferred.
21593
21594 These features make it possible to use Exim to create all the necessary files
21595 and directories in a maildir mailbox, including subdirectories for maildir++
21596 folders. Consider this example:
21597 .code
21598 maildir_format = true
21599 directory = /var/mail/$local_part\
21600            ${if eq{$local_part_suffix}{}{}\
21601            {/.${substr_1:$local_part_suffix}}}
21602 maildirfolder_create_regex = /\.[^/]+$
21603 .endd
21604 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21605 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21606 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21607 not match this name, so Exim will not look for or create the file
21608 &_/var/mail/pimbo/maildirfolder_&, though it will create
21609 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21610
21611 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21612 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21613 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21614 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21615 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21616
21617 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21618 not inadvertently match the toplevel maildir directory, because a
21619 &_maildirfolder_& file at top level would completely break quota calculations.
21620
21621 .cindex "quota" "in maildir delivery"
21622 .cindex "maildir++"
21623 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21624 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21625 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21626 Exim assumes the directory is a maildir++ folder directory, which is one level
21627 down from the user's top level mailbox directory. This causes it to start at
21628 the parent directory instead of the current directory when calculating the
21629 amount of space used.
21630
21631 One problem with delivering into a multi-file mailbox is that it is
21632 computationally expensive to compute the size of the mailbox for quota
21633 checking. Various approaches have been taken to reduce the amount of work
21634 needed. The next two sections describe two of them. A third alternative is to
21635 use some external process for maintaining the size data, and use the expansion
21636 of the &%mailbox_size%& option as a way of importing it into Exim.
21637
21638
21639
21640
21641 .section "Using tags to record message sizes" "SECID135"
21642 If &%maildir_tag%& is set, the string is expanded for each delivery.
21643 When the maildir file is renamed into the &_new_& sub-directory, the
21644 tag is added to its name. However, if adding the tag takes the length of the
21645 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21646 the tag is dropped and the maildir file is created with no tag.
21647
21648
21649 .vindex "&$message_size$&"
21650 Tags can be used to encode the size of files in their names; see
21651 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21652 happens after the message has been written. The value of the &$message_size$&
21653 variable is set to the number of bytes actually written. If the expansion is
21654 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21655 be deferred. The expanded tag may contain any printing characters except &"/"&.
21656 Non-printing characters in the string are ignored; if the resulting string is
21657 empty, it is ignored. If it starts with an alphanumeric character, a leading
21658 colon is inserted; this default has not proven to be the path that popular
21659 maildir implementations have chosen (but changing it in Exim would break
21660 backwards compatibility).
21661
21662 For one common implementation, you might set:
21663 .code
21664 maildir_tag = ,S=${message_size}
21665 .endd
21666 but you should check the documentation of the other software to be sure.
21667
21668 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21669 as this allows Exim to extract the size from your tag, instead of having to
21670 &[stat()]& each message file.
21671
21672
21673 .section "Using a maildirsize file" "SECID136"
21674 .cindex "quota" "in maildir delivery"
21675 .cindex "maildir format" "&_maildirsize_& file"
21676 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21677 storing quota and message size information in a file called &_maildirsize_&
21678 within the toplevel maildir directory. If this file does not exist, Exim
21679 creates it, setting the quota from the &%quota%& option of the transport. If
21680 the maildir directory itself does not exist, it is created before any attempt
21681 to write a &_maildirsize_& file.
21682
21683 The &_maildirsize_& file is used to hold information about the sizes of
21684 messages in the maildir, thus speeding up quota calculations. The quota value
21685 in the file is just a cache; if the quota is changed in the transport, the new
21686 value overrides the cached value when the next message is delivered. The cache
21687 is maintained for the benefit of other programs that access the maildir and
21688 need to know the quota.
21689
21690 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21691 file is maintained (with a zero quota setting), but no quota is imposed.
21692
21693 A regular expression is available for controlling which directories in the
21694 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21695 See the description of the &%maildir_quota_directory_regex%& option above for
21696 details.
21697
21698
21699 .section "Mailstore delivery" "SECID137"
21700 .cindex "mailstore format" "description of"
21701 If the &%mailstore_format%& option is true, each message is written as two
21702 files in the given directory. A unique base name is constructed from the
21703 message id and the current delivery process, and the files that are written use
21704 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21705 contains the message's envelope, and the &_.msg_& file contains the message
21706 itself. The base name is placed in the variable &$mailstore_basename$&.
21707
21708 During delivery, the envelope is first written to a file with the suffix
21709 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21710 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21711 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21712 file before accessing either of them. An alternative approach is to wait for
21713 the absence of a &_.tmp_& file.
21714
21715 The envelope file starts with any text defined by the &%mailstore_prefix%&
21716 option, expanded and terminated by a newline if there isn't one. Then follows
21717 the sender address on one line, then all the recipient addresses, one per line.
21718 There can be more than one recipient only if the &%batch_max%& option is set
21719 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21720 appended to the file, followed by a newline if it does not end with one.
21721
21722 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21723 failure, it is ignored. Other expansion errors are treated as serious
21724 configuration errors, and delivery is deferred. The variable
21725 &$mailstore_basename$& is available for use during these expansions.
21726
21727
21728 .section "Non-special new file delivery" "SECID138"
21729 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21730 file is created directly in the named directory. For example, when delivering
21731 messages into files in batched SMTP format for later delivery to some host (see
21732 section &<<SECTbatchSMTP>>&), a setting such as
21733 .code
21734 directory = /var/bsmtp/$host
21735 .endd
21736 might be used. A message is written to a file with a temporary name, which is
21737 then renamed when the delivery is complete. The final name is obtained by
21738 expanding the contents of the &%directory_file%& option.
21739 .ecindex IIDapptra1
21740 .ecindex IIDapptra2
21741
21742
21743
21744
21745
21746
21747 . ////////////////////////////////////////////////////////////////////////////
21748 . ////////////////////////////////////////////////////////////////////////////
21749
21750 .chapter "The autoreply transport" "CHID8"
21751 .scindex IIDauttra1 "transports" "&(autoreply)&"
21752 .scindex IIDauttra2 "&(autoreply)& transport"
21753 The &(autoreply)& transport is not a true transport in that it does not cause
21754 the message to be transmitted. Instead, it generates a new mail message as an
21755 automatic reply to the incoming message. &'References:'& and
21756 &'Auto-Submitted:'& header lines are included. These are constructed according
21757 to the rules in RFCs 2822 and 3834, respectively.
21758
21759 If the router that passes the message to this transport does not have the
21760 &%unseen%& option set, the original message (for the current recipient) is not
21761 delivered anywhere. However, when the &%unseen%& option is set on the router
21762 that passes the message to this transport, routing of the address continues, so
21763 another router can set up a normal message delivery.
21764
21765
21766 The &(autoreply)& transport is usually run as the result of mail filtering, a
21767 &"vacation"& message being the standard example. However, it can also be run
21768 directly from a router like any other transport. To reduce the possibility of
21769 message cascades, messages created by the &(autoreply)& transport always have
21770 empty envelope sender addresses, like bounce messages.
21771
21772 The parameters of the message to be sent can be specified in the configuration
21773 by options described below. However, these are used only when the address
21774 passed to the transport does not contain its own reply information. When the
21775 transport is run as a consequence of a
21776 &%mail%&
21777 or &%vacation%& command in a filter file, the parameters of the message are
21778 supplied by the filter, and passed with the address. The transport's options
21779 that define the message are then ignored (so they are not usually set in this
21780 case). The message is specified entirely by the filter or by the transport; it
21781 is never built from a mixture of options. However, the &%file_optional%&,
21782 &%mode%&, and &%return_message%& options apply in all cases.
21783
21784 &(Autoreply)& is implemented as a local transport. When used as a result of a
21785 command in a user's filter file, &(autoreply)& normally runs under the uid and
21786 gid of the user, and with appropriate current and home directories (see chapter
21787 &<<CHAPenvironment>>&).
21788
21789 There is a subtle difference between routing a message to a &(pipe)& transport
21790 that generates some text to be returned to the sender, and routing it to an
21791 &(autoreply)& transport. This difference is noticeable only if more than one
21792 address from the same message is so handled. In the case of a pipe, the
21793 separate outputs from the different addresses are gathered up and returned to
21794 the sender in a single message, whereas if &(autoreply)& is used, a separate
21795 message is generated for each address that is passed to it.
21796
21797 Non-printing characters are not permitted in the header lines generated for the
21798 message that &(autoreply)& creates, with the exception of newlines that are
21799 immediately followed by white space. If any non-printing characters are found,
21800 the transport defers.
21801 Whether characters with the top bit set count as printing characters or not is
21802 controlled by the &%print_topbitchars%& global option.
21803
21804 If any of the generic options for manipulating headers (for example,
21805 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21806 of the original message that is included in the generated message when
21807 &%return_message%& is set. They do not apply to the generated message itself.
21808
21809 .vindex "&$sender_address$&"
21810 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21811 the message, indicating that there were no recipients, it does not treat this
21812 as an error. This means that autoreplies sent to &$sender_address$& when this
21813 is empty (because the incoming message is a bounce message) do not cause
21814 problems. They are just discarded.
21815
21816
21817
21818 .section "Private options for autoreply" "SECID139"
21819 .cindex "options" "&(autoreply)& transport"
21820
21821 .option bcc autoreply string&!! unset
21822 This specifies the addresses that are to receive &"blind carbon copies"& of the
21823 message when the message is specified by the transport.
21824
21825
21826 .option cc autoreply string&!! unset
21827 This specifies recipients of the message and the contents of the &'Cc:'& header
21828 when the message is specified by the transport.
21829
21830
21831 .option file autoreply string&!! unset
21832 The contents of the file are sent as the body of the message when the message
21833 is specified by the transport. If both &%file%& and &%text%& are set, the text
21834 string comes first.
21835
21836
21837 .option file_expand autoreply boolean false
21838 If this is set, the contents of the file named by the &%file%& option are
21839 subjected to string expansion as they are added to the message.
21840
21841
21842 .option file_optional autoreply boolean false
21843 If this option is true, no error is generated if the file named by the &%file%&
21844 option or passed with the address does not exist or cannot be read.
21845
21846
21847 .option from autoreply string&!! unset
21848 This specifies the contents of the &'From:'& header when the message is
21849 specified by the transport.
21850
21851
21852 .option headers autoreply string&!! unset
21853 This specifies additional RFC 2822 headers that are to be added to the message
21854 when the message is specified by the transport. Several can be given by using
21855 &"\n"& to separate them. There is no check on the format.
21856
21857
21858 .option log autoreply string&!! unset
21859 This option names a file in which a record of every message sent is logged when
21860 the message is specified by the transport.
21861
21862
21863 .option mode autoreply "octal integer" 0600
21864 If either the log file or the &"once"& file has to be created, this mode is
21865 used.
21866
21867
21868 .option never_mail autoreply "address list&!!" unset
21869 If any run of the transport creates a message with a recipient that matches any
21870 item in the list, that recipient is quietly discarded. If all recipients are
21871 discarded, no message is created. This applies both when the recipients are
21872 generated by a filter and when they are specified in the transport.
21873
21874
21875
21876 .option once autoreply string&!! unset
21877 This option names a file or DBM database in which a record of each &'To:'&
21878 recipient is kept when the message is specified by the transport. &*Note*&:
21879 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21880
21881 If &%once%& is unset, or is set to an empty string, the message is always sent.
21882 By default, if &%once%& is set to a non-empty file name, the message
21883 is not sent if a potential recipient is already listed in the database.
21884 However, if the &%once_repeat%& option specifies a time greater than zero, the
21885 message is sent if that much time has elapsed since a message was last sent to
21886 this recipient. A setting of zero time for &%once_repeat%& (the default)
21887 prevents a message from being sent a second time &-- in this case, zero means
21888 infinity.
21889
21890 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21891 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21892 greater than zero, it changes the way Exim implements the &%once%& option.
21893 Instead of using a DBM file to record every recipient it sends to, it uses a
21894 regular file, whose size will never get larger than the given value.
21895
21896 In the file, Exim keeps a linear list of recipient addresses and the times at
21897 which they were sent messages. If the file is full when a new address needs to
21898 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21899 means that a given recipient may receive multiple messages, but at
21900 unpredictable intervals that depend on the rate of turnover of addresses in the
21901 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21902
21903
21904 .option once_file_size autoreply integer 0
21905 See &%once%& above.
21906
21907
21908 .option once_repeat autoreply time&!! 0s
21909 See &%once%& above.
21910 After expansion, the value of this option must be a valid time value.
21911
21912
21913 .option reply_to autoreply string&!! unset
21914 This specifies the contents of the &'Reply-To:'& header when the message is
21915 specified by the transport.
21916
21917
21918 .option return_message autoreply boolean false
21919 If this is set, a copy of the original message is returned with the new
21920 message, subject to the maximum size set in the &%return_size_limit%& global
21921 configuration option.
21922
21923
21924 .option subject autoreply string&!! unset
21925 This specifies the contents of the &'Subject:'& header when the message is
21926 specified by the transport. It is tempting to quote the original subject in
21927 automatic responses. For example:
21928 .code
21929 subject = Re: $h_subject:
21930 .endd
21931 There is a danger in doing this, however. It may allow a third party to
21932 subscribe your users to an opt-in mailing list, provided that the list accepts
21933 bounce messages as subscription confirmations. Well-managed lists require a
21934 non-bounce message to confirm a subscription, so the danger is relatively
21935 small.
21936
21937
21938
21939 .option text autoreply string&!! unset
21940 This specifies a single string to be used as the body of the message when the
21941 message is specified by the transport. If both &%text%& and &%file%& are set,
21942 the text comes first.
21943
21944
21945 .option to autoreply string&!! unset
21946 This specifies recipients of the message and the contents of the &'To:'& header
21947 when the message is specified by the transport.
21948 .ecindex IIDauttra1
21949 .ecindex IIDauttra2
21950
21951
21952
21953
21954 . ////////////////////////////////////////////////////////////////////////////
21955 . ////////////////////////////////////////////////////////////////////////////
21956
21957 .chapter "The lmtp transport" "CHAPLMTP"
21958 .cindex "transports" "&(lmtp)&"
21959 .cindex "&(lmtp)& transport"
21960 .cindex "LMTP" "over a pipe"
21961 .cindex "LMTP" "over a socket"
21962 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21963 specified command
21964 or by interacting with a Unix domain socket.
21965 This transport is something of a cross between the &(pipe)& and &(smtp)&
21966 transports. Exim also has support for using LMTP over TCP/IP; this is
21967 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21968 to be of minority interest, the default build-time configure in &_src/EDITME_&
21969 has it commented out. You need to ensure that
21970 .code
21971 TRANSPORT_LMTP=yes
21972 .endd
21973 .cindex "options" "&(lmtp)& transport"
21974 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21975 included in the Exim binary. The private options of the &(lmtp)& transport are
21976 as follows:
21977
21978 .option batch_id lmtp string&!! unset
21979 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21980
21981
21982 .option batch_max lmtp integer 1
21983 This limits the number of addresses that can be handled in a single delivery.
21984 Most LMTP servers can handle several addresses at once, so it is normally a
21985 good idea to increase this value. See the description of local delivery
21986 batching in chapter &<<CHAPbatching>>&.
21987
21988
21989 .option command lmtp string&!! unset
21990 This option must be set if &%socket%& is not set. The string is a command which
21991 is run in a separate process. It is split up into a command name and list of
21992 arguments, each of which is separately expanded (so expansion cannot change the
21993 number of arguments). The command is run directly, not via a shell. The message
21994 is passed to the new process using the standard input and output to operate the
21995 LMTP protocol.
21996
21997 .option ignore_quota lmtp boolean false
21998 .cindex "LMTP" "ignoring quota errors"
21999 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22000 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22001 in its response to the LHLO command.
22002
22003 .option socket lmtp string&!! unset
22004 This option must be set if &%command%& is not set. The result of expansion must
22005 be the name of a Unix domain socket. The transport connects to the socket and
22006 delivers the message to it using the LMTP protocol.
22007
22008
22009 .option timeout lmtp time 5m
22010 The transport is aborted if the created process or Unix domain socket does not
22011 respond to LMTP commands or message input within this timeout. Delivery
22012 is deferred, and will be tried again later. Here is an example of a typical
22013 LMTP transport:
22014 .code
22015 lmtp:
22016   driver = lmtp
22017   command = /some/local/lmtp/delivery/program
22018   batch_max = 20
22019   user = exim
22020 .endd
22021 This delivers up to 20 addresses at a time, in a mixture of domains if
22022 necessary, running as the user &'exim'&.
22023
22024
22025
22026 . ////////////////////////////////////////////////////////////////////////////
22027 . ////////////////////////////////////////////////////////////////////////////
22028
22029 .chapter "The pipe transport" "CHAPpipetransport"
22030 .scindex IIDpiptra1 "transports" "&(pipe)&"
22031 .scindex IIDpiptra2 "&(pipe)& transport"
22032 The &(pipe)& transport is used to deliver messages via a pipe to a command
22033 running in another process. One example is the use of &(pipe)& as a
22034 pseudo-remote transport for passing messages to some other delivery mechanism
22035 (such as UUCP). Another is the use by individual users to automatically process
22036 their incoming messages. The &(pipe)& transport can be used in one of the
22037 following ways:
22038
22039 .ilist
22040 .vindex "&$local_part$&"
22041 A router routes one address to a transport in the normal way, and the
22042 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22043 contains the local part of the address (as usual), and the command that is run
22044 is specified by the &%command%& option on the transport.
22045 .next
22046 .vindex "&$pipe_addresses$&"
22047 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22048 transport can handle more than one address in a single run. In this case, when
22049 more than one address is routed to the transport, &$local_part$& is not set
22050 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22051 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22052 that are routed to the transport.
22053 .next
22054 .vindex "&$address_pipe$&"
22055 A router redirects an address directly to a pipe command (for example, from an
22056 alias or forward file). In this case, &$address_pipe$& contains the text of the
22057 pipe command, and the &%command%& option on the transport is ignored unless
22058 &%force_command%& is set. If only one address is being transported
22059 (&%batch_max%& is not greater than one, or only one address was redirected to
22060 this pipe command), &$local_part$& contains the local part that was redirected.
22061 .endlist
22062
22063
22064 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22065 deliver messages over pipes using the LMTP interactive protocol. This is
22066 implemented by the &(lmtp)& transport.
22067
22068 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22069 &_.forward_& file, the command runs under the uid and gid of that user. In
22070 other cases, the uid and gid have to be specified explicitly, either on the
22071 transport or on the router that handles the address. Current and &"home"&
22072 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22073 details of the local delivery environment and chapter &<<CHAPbatching>>&
22074 for a discussion of local delivery batching.
22075
22076
22077 .section "Concurrent delivery" "SECID140"
22078 If two messages arrive at almost the same time, and both are routed to a pipe
22079 delivery, the two pipe transports may be run concurrently. You must ensure that
22080 any pipe commands you set up are robust against this happening. If the commands
22081 write to a file, the &%exim_lock%& utility might be of use.
22082
22083
22084
22085
22086 .section "Returned status and data" "SECID141"
22087 .cindex "&(pipe)& transport" "returned data"
22088 If the command exits with a non-zero return code, the delivery is deemed to
22089 have failed, unless either the &%ignore_status%& option is set (in which case
22090 the return code is treated as zero), or the return code is one of those listed
22091 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22092 later"&. In this case, delivery is deferred. Details of a permanent failure are
22093 logged, but are not included in the bounce message, which merely contains
22094 &"local delivery failed"&.
22095
22096 If the command exits on a signal and the &%freeze_signal%& option is set then
22097 the message will be frozen in the queue. If that option is not set, a bounce
22098 will be sent as normal.
22099
22100 If the return code is greater than 128 and the command being run is a shell
22101 script, it normally means that the script was terminated by a signal whose
22102 value is the return code minus 128. The &%freeze_signal%& option does not
22103 apply in this case.
22104
22105 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22106 return code is set to 127. This is the value that a shell returns if it is
22107 asked to run a non-existent command. The wording for the log line suggests that
22108 a non-existent command may be the problem.
22109
22110 The &%return_output%& option can affect the result of a pipe delivery. If it is
22111 set and the command produces any output on its standard output or standard
22112 error streams, the command is considered to have failed, even if it gave a zero
22113 return code or if &%ignore_status%& is set. The output from the command is
22114 included as part of the bounce message. The &%return_fail_output%& option is
22115 similar, except that output is returned only when the command exits with a
22116 failure return code, that is, a value other than zero or a code that matches
22117 &%temp_errors%&.
22118
22119
22120
22121 .section "How the command is run" "SECThowcommandrun"
22122 .cindex "&(pipe)& transport" "path for command"
22123 The command line is (by default) broken down into a command name and arguments
22124 by the &(pipe)& transport itself. The &%allow_commands%& and
22125 &%restrict_to_path%& options can be used to restrict the commands that may be
22126 run.
22127
22128 .cindex "quoting" "in pipe command"
22129 Unquoted arguments are delimited by white space. If an argument appears in
22130 double quotes, backslash is interpreted as an escape character in the usual
22131 way. If an argument appears in single quotes, no escaping is done.
22132
22133 String expansion is applied to the command line except when it comes from a
22134 traditional &_.forward_& file (commands from a filter file are expanded). The
22135 expansion is applied to each argument in turn rather than to the whole line.
22136 For this reason, any string expansion item that contains white space must be
22137 quoted so as to be contained within a single argument. A setting such as
22138 .code
22139 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22140 .endd
22141 will not work, because the expansion item gets split between several
22142 arguments. You have to write
22143 .code
22144 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22145 .endd
22146 to ensure that it is all in one argument. The expansion is done in this way,
22147 argument by argument, so that the number of arguments cannot be changed as a
22148 result of expansion, and quotes or backslashes in inserted variables do not
22149 interact with external quoting. However, this leads to problems if you want to
22150 generate multiple arguments (or the command name plus arguments) from a single
22151 expansion. In this situation, the simplest solution is to use a shell. For
22152 example:
22153 .code
22154 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22155 .endd
22156
22157 .cindex "transport" "filter"
22158 .cindex "filter" "transport filter"
22159 .vindex "&$pipe_addresses$&"
22160 Special handling takes place when an argument consists of precisely the text
22161 &`$pipe_addresses`&. This is not a general expansion variable; the only
22162 place this string is recognized is when it appears as an argument for a pipe or
22163 transport filter command. It causes each address that is being handled to be
22164 inserted in the argument list at that point &'as a separate argument'&. This
22165 avoids any problems with spaces or shell metacharacters, and is of use when a
22166 &(pipe)& transport is handling groups of addresses in a batch.
22167
22168 If &%force_command%& is enabled on the transport, Special handling takes place
22169 for an argument that consists of precisely the text &`$address_pipe`&.  It
22170 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22171 argument is inserted in the argument list at that point
22172 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22173 the only item in the argument; in fact, if it were then &%force_command%&
22174 should behave as a no-op.  Rather, it should be used to adjust the command
22175 run while preserving the argument vector separation.
22176
22177 After splitting up into arguments and expansion, the resulting command is run
22178 in a subprocess directly from the transport, &'not'& under a shell. The
22179 message that is being delivered is supplied on the standard input, and the
22180 standard output and standard error are both connected to a single pipe that is
22181 read by Exim. The &%max_output%& option controls how much output the command
22182 may produce, and the &%return_output%& and &%return_fail_output%& options
22183 control what is done with it.
22184
22185 Not running the command under a shell (by default) lessens the security risks
22186 in cases when a command from a user's filter file is built out of data that was
22187 taken from an incoming message. If a shell is required, it can of course be
22188 explicitly specified as the command to be run. However, there are circumstances
22189 where existing commands (for example, in &_.forward_& files) expect to be run
22190 under a shell and cannot easily be modified. To allow for these cases, there is
22191 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22192 works. Instead of breaking up the command line as just described, it expands it
22193 as a single string and passes the result to &_/bin/sh_&. The
22194 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22195 with &%use_shell%&, and the whole mechanism is inherently less secure.
22196
22197
22198
22199 .section "Environment variables" "SECTpipeenv"
22200 .cindex "&(pipe)& transport" "environment for command"
22201 .cindex "environment for pipe transport"
22202 The environment variables listed below are set up when the command is invoked.
22203 This list is a compromise for maximum compatibility with other MTAs. Note that
22204 the &%environment%& option can be used to add additional variables to this
22205 environment.
22206 .display
22207 &`DOMAIN            `&   the domain of the address
22208 &`HOME              `&   the home directory, if set
22209 &`HOST              `&   the host name when called from a router (see below)
22210 &`LOCAL_PART        `&   see below
22211 &`LOCAL_PART_PREFIX `&   see below
22212 &`LOCAL_PART_SUFFIX `&   see below
22213 &`LOGNAME           `&   see below
22214 &`MESSAGE_ID        `&   Exim's local ID for the message
22215 &`PATH              `&   as specified by the &%path%& option below
22216 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22217 &`RECIPIENT         `&   the complete recipient address
22218 &`SENDER            `&   the sender of the message (empty if a bounce)
22219 &`SHELL             `&   &`/bin/sh`&
22220 &`TZ                `&   the value of the &%timezone%& option, if set
22221 &`USER              `&   see below
22222 .endd
22223 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22224 router, LOCAL_PART is set to the local part of the address. When it is
22225 called as a result of a forward or alias expansion, LOCAL_PART is set to
22226 the local part of the address that was expanded. In both cases, any affixes are
22227 removed from the local part, and made available in LOCAL_PART_PREFIX and
22228 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22229 same value as LOCAL_PART for compatibility with other MTAs.
22230
22231 .cindex "HOST"
22232 HOST is set only when a &(pipe)& transport is called from a router that
22233 associates hosts with an address, typically when using &(pipe)& as a
22234 pseudo-remote transport. HOST is set to the first host name specified by
22235 the router.
22236
22237 .cindex "HOME"
22238 If the transport's generic &%home_directory%& option is set, its value is used
22239 for the HOME environment variable. Otherwise, a home directory may be set
22240 by the router's &%transport_home_directory%& option, which defaults to the
22241 user's home directory if &%check_local_user%& is set.
22242
22243
22244 .section "Private options for pipe" "SECID142"
22245 .cindex "options" "&(pipe)& transport"
22246
22247
22248
22249 .option allow_commands pipe "string list&!!" unset
22250 .cindex "&(pipe)& transport" "permitted commands"
22251 The string is expanded, and is then interpreted as a colon-separated list of
22252 permitted commands. If &%restrict_to_path%& is not set, the only commands
22253 permitted are those in the &%allow_commands%& list. They need not be absolute
22254 paths; the &%path%& option is still used for relative paths. If
22255 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22256 in the &%allow_commands%& list, or a name without any slashes that is found on
22257 the path. In other words, if neither &%allow_commands%& nor
22258 &%restrict_to_path%& is set, there is no restriction on the command, but
22259 otherwise only commands that are permitted by one or the other are allowed. For
22260 example, if
22261 .code
22262 allow_commands = /usr/bin/vacation
22263 .endd
22264 and &%restrict_to_path%& is not set, the only permitted command is
22265 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22266 &%use_shell%& is set.
22267
22268
22269 .option batch_id pipe string&!! unset
22270 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22271
22272
22273 .option batch_max pipe integer 1
22274 This limits the number of addresses that can be handled in a single delivery.
22275 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22276
22277
22278 .option check_string pipe string unset
22279 As &(pipe)& writes the message, the start of each line is tested for matching
22280 &%check_string%&, and if it does, the initial matching characters are replaced
22281 by the contents of &%escape_string%&, provided both are set. The value of
22282 &%check_string%& is a literal string, not a regular expression, and the case of
22283 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22284 of &%check_string%& and &%escape_string%& are forced to values that implement
22285 the SMTP escaping protocol. Any settings made in the configuration file are
22286 ignored.
22287
22288
22289 .option command pipe string&!! unset
22290 This option need not be set when &(pipe)& is being used to deliver to pipes
22291 obtained directly from address redirections. In other cases, the option must be
22292 set, to provide a command to be run. It need not yield an absolute path (see
22293 the &%path%& option below). The command is split up into separate arguments by
22294 Exim, and each argument is separately expanded, as described in section
22295 &<<SECThowcommandrun>>& above.
22296
22297
22298 .option environment pipe string&!! unset
22299 .cindex "&(pipe)& transport" "environment for command"
22300 .cindex "environment for &(pipe)& transport"
22301 This option is used to add additional variables to the environment in which the
22302 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22303 a string which is expanded, and then interpreted as a colon-separated list of
22304 environment settings of the form <&'name'&>=<&'value'&>.
22305
22306
22307 .option escape_string pipe string unset
22308 See &%check_string%& above.
22309
22310
22311 .option freeze_exec_fail pipe boolean false
22312 .cindex "exec failure"
22313 .cindex "failure of exec"
22314 .cindex "&(pipe)& transport" "failure of exec"
22315 Failure to exec the command in a pipe transport is by default treated like
22316 any other failure while running the command. However, if &%freeze_exec_fail%&
22317 is set, failure to exec is treated specially, and causes the message to be
22318 frozen, whatever the setting of &%ignore_status%&.
22319
22320
22321 .option freeze_signal pipe boolean false
22322 .cindex "signal exit"
22323 .cindex "&(pipe)& transport", "signal exit"
22324 Normally if the process run by a command in a pipe transport exits on a signal,
22325 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22326 frozen in Exim's queue instead.
22327
22328
22329 .option force_command pipe boolean false
22330 .cindex "force command"
22331 .cindex "&(pipe)& transport", "force command"
22332 Normally when a router redirects an address directly to a pipe command
22333 the &%command%& option on the transport is ignored.  If &%force_command%&
22334 is set, the &%command%& option will used. This is especially
22335 useful for forcing a wrapper or additional argument to be added to the
22336 command. For example:
22337 .code
22338 command = /usr/bin/remote_exec myhost -- $address_pipe
22339 force_command
22340 .endd
22341
22342 Note that &$address_pipe$& is handled specially in &%command%& when
22343 &%force_command%& is set, expanding out to the original argument vector as
22344 separate items, similarly to a Unix shell &`"$@"`& construct.
22345
22346 .option ignore_status pipe boolean false
22347 If this option is true, the status returned by the subprocess that is set up to
22348 run the command is ignored, and Exim behaves as if zero had been returned.
22349 Otherwise, a non-zero status or termination by signal causes an error return
22350 from the transport unless the status value is one of those listed in
22351 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22352
22353 &*Note*&: This option does not apply to timeouts, which do not return a status.
22354 See the &%timeout_defer%& option for how timeouts are handled.
22355
22356 .option log_defer_output pipe boolean false
22357 .cindex "&(pipe)& transport" "logging output"
22358 If this option is set, and the status returned by the command is
22359 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22360 and any output was produced, the first line of it is written to the main log.
22361
22362
22363 .option log_fail_output pipe boolean false
22364 If this option is set, and the command returns any output, and also ends with a
22365 return code that is neither zero nor one of the return codes listed in
22366 &%temp_errors%& (that is, the delivery failed), the first line of output is
22367 written to the main log. This option and &%log_output%& are mutually exclusive.
22368 Only one of them may be set.
22369
22370
22371
22372 .option log_output pipe boolean false
22373 If this option is set and the command returns any output, the first line of
22374 output is written to the main log, whatever the return code. This option and
22375 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22376
22377
22378
22379 .option max_output pipe integer 20K
22380 This specifies the maximum amount of output that the command may produce on its
22381 standard output and standard error file combined. If the limit is exceeded, the
22382 process running the command is killed. This is intended as a safety measure to
22383 catch runaway processes. The limit is applied independently of the settings of
22384 the options that control what is done with such output (for example,
22385 &%return_output%&). Because of buffering effects, the amount of output may
22386 exceed the limit by a small amount before Exim notices.
22387
22388
22389 .option message_prefix pipe string&!! "see below"
22390 The string specified here is expanded and output at the start of every message.
22391 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22392 .code
22393 message_prefix = \
22394   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22395   ${tod_bsdinbox}\n
22396 .endd
22397 .cindex "Cyrus"
22398 .cindex "&%tmail%&"
22399 .cindex "&""From""& line"
22400 This is required by the commonly used &_/usr/bin/vacation_& program.
22401 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22402 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22403 setting
22404 .code
22405 message_prefix =
22406 .endd
22407 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22408 &`\n`& to &`\r\n`& in &%message_prefix%&.
22409
22410
22411 .option message_suffix pipe string&!! "see below"
22412 The string specified here is expanded and output at the end of every message.
22413 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22414 The suffix can be suppressed by setting
22415 .code
22416 message_suffix =
22417 .endd
22418 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22419 &`\n`& to &`\r\n`& in &%message_suffix%&.
22420
22421
22422 .option path pipe string "see below"
22423 This option specifies the string that is set up in the PATH environment
22424 variable of the subprocess. The default is:
22425 .code
22426 /bin:/usr/bin
22427 .endd
22428 If the &%command%& option does not yield an absolute path name, the command is
22429 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22430 apply to a command specified as a transport filter.
22431
22432
22433 .option permit_coredump pipe boolean false
22434 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22435 a core-dump of a pipe command, enable this command.  This enables core-dumps
22436 during delivery and affects both the Exim binary and the pipe command run.
22437 It is recommended that this option remain off unless and until you have a need
22438 for it and that this only be enabled when needed, as the risk of excessive
22439 resource consumption can be quite high.  Note also that Exim is typically
22440 installed as a setuid binary and most operating systems will inhibit coredumps
22441 of these by default, so further OS-specific action may be required.
22442
22443
22444 .option pipe_as_creator pipe boolean false
22445 .cindex "uid (user id)" "local delivery"
22446 If the generic &%user%& option is not set and this option is true, the delivery
22447 process is run under the uid that was in force when Exim was originally called
22448 to accept the message. If the group id is not otherwise set (via the generic
22449 &%group%& option), the gid that was in force when Exim was originally called to
22450 accept the message is used.
22451
22452
22453 .option restrict_to_path pipe boolean false
22454 When this option is set, any command name not listed in &%allow_commands%& must
22455 contain no slashes. The command is searched for only in the directories listed
22456 in the &%path%& option. This option is intended for use in the case when a pipe
22457 command has been generated from a user's &_.forward_& file. This is usually
22458 handled by a &(pipe)& transport called &%address_pipe%&.
22459
22460
22461 .option return_fail_output pipe boolean false
22462 If this option is true, and the command produced any output and ended with a
22463 return code other than zero or one of the codes listed in &%temp_errors%& (that
22464 is, the delivery failed), the output is returned in the bounce message.
22465 However, if the message has a null sender (that is, it is itself a bounce
22466 message), output from the command is discarded. This option and
22467 &%return_output%& are mutually exclusive. Only one of them may be set.
22468
22469
22470
22471 .option return_output pipe boolean false
22472 If this option is true, and the command produced any output, the delivery is
22473 deemed to have failed whatever the return code from the command, and the output
22474 is returned in the bounce message. Otherwise, the output is just discarded.
22475 However, if the message has a null sender (that is, it is a bounce message),
22476 output from the command is always discarded, whatever the setting of this
22477 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22478 of them may be set.
22479
22480
22481
22482 .option temp_errors pipe "string list" "see below"
22483 .cindex "&(pipe)& transport" "temporary failure"
22484 This option contains either a colon-separated list of numbers, or a single
22485 asterisk. If &%ignore_status%& is false
22486 and &%return_output%& is not set,
22487 and the command exits with a non-zero return code, the failure is treated as
22488 temporary and the delivery is deferred if the return code matches one of the
22489 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22490 codes are treated as permanent errors. The default setting contains the codes
22491 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22492 compiled on a system that does not define these macros, it assumes values of 75
22493 and 73, respectively.
22494
22495
22496 .option timeout pipe time 1h
22497 If the command fails to complete within this time, it is killed. This normally
22498 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22499 specifies no timeout. In order to ensure that any subprocesses created by the
22500 command are also killed, Exim makes the initial process a process group leader,
22501 and kills the whole process group on a timeout. However, this can be defeated
22502 if one of the processes starts a new process group.
22503
22504 .option timeout_defer pipe boolean false
22505 A timeout in a &(pipe)& transport, either in the command that the transport
22506 runs, or in a transport filter that is associated with it, is by default
22507 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22508 is set true, both kinds of timeout become temporary errors, causing the
22509 delivery to be deferred.
22510
22511 .option umask pipe "octal integer" 022
22512 This specifies the umask setting for the subprocess that runs the command.
22513
22514
22515 .option use_bsmtp pipe boolean false
22516 .cindex "envelope sender"
22517 If this option is set true, the &(pipe)& transport writes messages in &"batch
22518 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22519 commands. If you want to include a leading HELO command with such messages,
22520 you can do so by setting the &%message_prefix%& option. See section
22521 &<<SECTbatchSMTP>>& for details of batch SMTP.
22522
22523 .option use_classresources pipe boolean false
22524 .cindex "class resources (BSD)"
22525 This option is available only when Exim is running on FreeBSD, NetBSD, or
22526 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22527 resource limits when a &(pipe)& transport is run to perform a delivery. The
22528 limits for the uid under which the pipe is to run are obtained from the login
22529 class database.
22530
22531
22532 .option use_crlf pipe boolean false
22533 .cindex "carriage return"
22534 .cindex "linefeed"
22535 This option causes lines to be terminated with the two-character CRLF sequence
22536 (carriage return, linefeed) instead of just a linefeed character. In the case
22537 of batched SMTP, the byte sequence written to the pipe is then an exact image
22538 of what would be sent down a real SMTP connection.
22539
22540 The contents of the &%message_prefix%& and &%message_suffix%& options are
22541 written verbatim, so must contain their own carriage return characters if these
22542 are needed. When &%use_bsmtp%& is not set, the default values for both
22543 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22544 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22545
22546
22547 .option use_shell pipe boolean false
22548 .vindex "&$pipe_addresses$&"
22549 If this option is set, it causes the command to be passed to &_/bin/sh_&
22550 instead of being run directly from the transport, as described in section
22551 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22552 where the command is expected to be run under a shell and cannot easily be
22553 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22554 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22555 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22556 its &%-c%& option.
22557
22558
22559
22560 .section "Using an external local delivery agent" "SECID143"
22561 .cindex "local delivery" "using an external agent"
22562 .cindex "&'procmail'&"
22563 .cindex "external local delivery"
22564 .cindex "delivery" "&'procmail'&"
22565 .cindex "delivery" "by external agent"
22566 The &(pipe)& transport can be used to pass all messages that require local
22567 delivery to a separate local delivery agent such as &%procmail%&. When doing
22568 this, care must be taken to ensure that the pipe is run under an appropriate
22569 uid and gid. In some configurations one wants this to be a uid that is trusted
22570 by the delivery agent to supply the correct sender of the message. It may be
22571 necessary to recompile or reconfigure the delivery agent so that it trusts an
22572 appropriate user. The following is an example transport and router
22573 configuration for &%procmail%&:
22574 .code
22575 # transport
22576 procmail_pipe:
22577   driver = pipe
22578   command = /usr/local/bin/procmail -d $local_part
22579   return_path_add
22580   delivery_date_add
22581   envelope_to_add
22582   check_string = "From "
22583   escape_string = ">From "
22584   umask = 077
22585   user = $local_part
22586   group = mail
22587
22588 # router
22589 procmail:
22590   driver = accept
22591   check_local_user
22592   transport = procmail_pipe
22593 .endd
22594 In this example, the pipe is run as the local user, but with the group set to
22595 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22596 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22597 user to supply a correct sender address. If you do not specify either a
22598 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22599 home directory is the user's home directory by default.
22600
22601 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22602 .code
22603 IFS=" "
22604 .endd
22605 as shown in some &%procmail%& documentation, because Exim does not by default
22606 use a shell to run pipe commands.
22607
22608 .cindex "Cyrus"
22609 The next example shows a transport and a router for a system where local
22610 deliveries are handled by the Cyrus IMAP server.
22611 .code
22612 # transport
22613 local_delivery_cyrus:
22614   driver = pipe
22615   command = /usr/cyrus/bin/deliver \
22616             -m ${substr_1:$local_part_suffix} -- $local_part
22617   user = cyrus
22618   group = mail
22619   return_output
22620   log_output
22621   message_prefix =
22622   message_suffix =
22623
22624 # router
22625 local_user_cyrus:
22626   driver = accept
22627   check_local_user
22628   local_part_suffix = .*
22629   transport = local_delivery_cyrus
22630 .endd
22631 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22632 &%return_output%& to cause any text written by Cyrus to be returned to the
22633 sender.
22634 .ecindex IIDpiptra1
22635 .ecindex IIDpiptra2
22636
22637
22638 . ////////////////////////////////////////////////////////////////////////////
22639 . ////////////////////////////////////////////////////////////////////////////
22640
22641 .chapter "The smtp transport" "CHAPsmtptrans"
22642 .scindex IIDsmttra1 "transports" "&(smtp)&"
22643 .scindex IIDsmttra2 "&(smtp)& transport"
22644 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22645 or LMTP protocol. The list of hosts to try can either be taken from the address
22646 that is being processed (having been set up by the router), or specified
22647 explicitly for the transport. Timeout and retry processing (see chapter
22648 &<<CHAPretry>>&) is applied to each IP address independently.
22649
22650
22651 .section "Multiple messages on a single connection" "SECID144"
22652 The sending of multiple messages over a single TCP/IP connection can arise in
22653 two ways:
22654
22655 .ilist
22656 If a message contains more than &%max_rcpt%& (see below) addresses that are
22657 routed to the same host, more than one copy of the message has to be sent to
22658 that host. In this situation, multiple copies may be sent in a single run of
22659 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22660 does when it has too many addresses to send in one message also depends on the
22661 value of the global &%remote_max_parallel%& option. Details are given in
22662 section &<<SECToutSMTPTCP>>&.)
22663 .next
22664 .cindex "hints database" "remembering routing"
22665 When a message has been successfully delivered over a TCP/IP connection, Exim
22666 looks in its hints database to see if there are any other messages awaiting a
22667 connection to the same host. If there are, a new delivery process is started
22668 for one of them, and the current TCP/IP connection is passed on to it. The new
22669 process may in turn send multiple copies and possibly create yet another
22670 process.
22671 .endlist
22672
22673
22674 For each copy sent over the same TCP/IP connection, a sequence counter is
22675 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22676 no further messages are sent over that connection.
22677
22678
22679
22680 .section "Use of the $host and $host_address variables" "SECID145"
22681 .vindex "&$host$&"
22682 .vindex "&$host_address$&"
22683 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22684 &$host_address$& are the name and IP address of the first host on the host list
22685 passed by the router. However, when the transport is about to connect to a
22686 specific host, and while it is connected to that host, &$host$& and
22687 &$host_address$& are set to the values for that host. These are the values
22688 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22689 &%serialize_hosts%&, and the various TLS options are expanded.
22690
22691
22692 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22693 .vindex &$tls_bits$&
22694 .vindex &$tls_cipher$&
22695 .vindex &$tls_peerdn$&
22696 .vindex &$tls_sni$&
22697 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22698 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22699 are the values that were set when the message was received.
22700 These are the values that are used for options that are expanded before any
22701 SMTP connections are made. Just before each connection is made, these four
22702 variables are emptied. If TLS is subsequently started, they are set to the
22703 appropriate values for the outgoing connection, and these are the values that
22704 are in force when any authenticators are run and when the
22705 &%authenticated_sender%& option is expanded.
22706
22707 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22708 and will be removed in a future release.
22709
22710
22711 .section "Private options for smtp" "SECID146"
22712 .cindex "options" "&(smtp)& transport"
22713 The private options of the &(smtp)& transport are as follows:
22714
22715
22716 .option address_retry_include_sender smtp boolean true
22717 .cindex "4&'xx'& responses" "retrying after"
22718 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22719 is the combination of sender and recipient that is delayed in subsequent queue
22720 runs until the retry time is reached. You can delay the recipient without
22721 reference to the sender (which is what earlier versions of Exim did), by
22722 setting &%address_retry_include_sender%& false. However, this can lead to
22723 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22724
22725 .option allow_localhost smtp boolean false
22726 .cindex "local host" "sending to"
22727 .cindex "fallback" "hosts specified on transport"
22728 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22729 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22730 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22731 the delivery anyway. This should be used only in special cases when the
22732 configuration ensures that no looping will result (for example, a differently
22733 configured Exim is listening on the port to which the message is sent).
22734
22735
22736 .option authenticated_sender smtp string&!! unset
22737 .cindex "Cyrus"
22738 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22739 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22740 overriding any existing authenticated sender value. If the string expansion is
22741 forced to fail, the option is ignored. Other expansion failures cause delivery
22742 to be deferred. If the result of expansion is an empty string, that is also
22743 ignored.
22744
22745 The expansion happens after the outgoing connection has been made and TLS
22746 started, if required. This means that the &$host$&, &$host_address$&,
22747 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22748 particular connection.
22749
22750 If the SMTP session is not authenticated, the expansion of
22751 &%authenticated_sender%& still happens (and can cause the delivery to be
22752 deferred if it fails), but no AUTH= item is added to MAIL commands
22753 unless &%authenticated_sender_force%& is true.
22754
22755 This option allows you to use the &(smtp)& transport in LMTP mode to
22756 deliver mail to Cyrus IMAP and provide the proper local part as the
22757 &"authenticated sender"&, via a setting such as:
22758 .code
22759 authenticated_sender = $local_part
22760 .endd
22761 This removes the need for IMAP subfolders to be assigned special ACLs to
22762 allow direct delivery to those subfolders.
22763
22764 Because of expected uses such as that just described for Cyrus (when no
22765 domain is involved), there is no checking on the syntax of the provided
22766 value.
22767
22768
22769 .option authenticated_sender_force smtp boolean false
22770 If this option is set true, the &%authenticated_sender%& option's value
22771 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22772 authenticated as a client.
22773
22774
22775 .option command_timeout smtp time 5m
22776 This sets a timeout for receiving a response to an SMTP command that has been
22777 sent out. It is also used when waiting for the initial banner line from the
22778 remote host. Its value must not be zero.
22779
22780
22781 .option connect_timeout smtp time 5m
22782 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22783 to a remote host. A setting of zero allows the system timeout (typically
22784 several minutes) to act. To have any effect, the value of this option must be
22785 less than the system timeout. However, it has been observed that on some
22786 systems there is no system timeout, which is why the default value for this
22787 option is 5 minutes, a value recommended by RFC 1123.
22788
22789
22790 .option connection_max_messages smtp integer 500
22791 .cindex "SMTP" "passed connection"
22792 .cindex "SMTP" "multiple deliveries"
22793 .cindex "multiple SMTP deliveries"
22794 This controls the maximum number of separate message deliveries that are sent
22795 over a single TCP/IP connection. If the value is zero, there is no limit.
22796 For testing purposes, this value can be overridden by the &%-oB%& command line
22797 option.
22798
22799
22800 .option data_timeout smtp time 5m
22801 This sets a timeout for the transmission of each block in the data portion of
22802 the message. As a result, the overall timeout for a message depends on the size
22803 of the message. Its value must not be zero. See also &%final_timeout%&.
22804
22805
22806 .option delay_after_cutoff smtp boolean true
22807 This option controls what happens when all remote IP addresses for a given
22808 domain have been inaccessible for so long that they have passed their retry
22809 cutoff times.
22810
22811 In the default state, if the next retry time has not been reached for any of
22812 them, the address is bounced without trying any deliveries. In other words,
22813 Exim delays retrying an IP address after the final cutoff time until a new
22814 retry time is reached, and can therefore bounce an address without ever trying
22815 a delivery, when machines have been down for a long time. Some people are
22816 unhappy at this prospect, so...
22817
22818 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22819 addresses are past their final cutoff time, Exim tries to deliver to those
22820 IP addresses that have not been tried since the message arrived. If there are
22821 none, of if they all fail, the address is bounced. In other words, it does not
22822 delay when a new message arrives, but immediately tries those expired IP
22823 addresses that haven't been tried since the message arrived. If there is a
22824 continuous stream of messages for the dead hosts, unsetting
22825 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22826 to them.
22827
22828
22829 .option dns_qualify_single smtp boolean true
22830 If the &%hosts%& or &%fallback_hosts%& option is being used,
22831 and the &%gethostbyname%& option is false,
22832 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22833 in chapter &<<CHAPdnslookup>>& for more details.
22834
22835
22836 .option dns_search_parents smtp boolean false
22837 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22838 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22839 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22840 details.
22841
22842
22843 .option dnssec_request_domains smtp "domain list&!!" unset
22844 .cindex "MX record" "security"
22845 .cindex "DNSSEC" "MX lookup"
22846 .cindex "security" "MX lookup"
22847 .cindex "DNS" "DNSSEC"
22848 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22849 the dnssec request bit set.
22850 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22851
22852
22853
22854 .option dnssec_require_domains smtp "domain list&!!" unset
22855 .cindex "MX record" "security"
22856 .cindex "DNSSEC" "MX lookup"
22857 .cindex "security" "MX lookup"
22858 .cindex "DNS" "DNSSEC"
22859 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22860 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22861 (AD bit) set wil be ignored and logged as a host-lookup failure.
22862 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22863
22864
22865
22866 .option dscp smtp string&!! unset
22867 .cindex "DCSP" "outbound"
22868 This option causes the DSCP value associated with a socket to be set to one
22869 of a number of fixed strings or to numeric value.
22870 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22871 Common values include &`throughput`&, &`mincost`&, and on newer systems
22872 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22873
22874 The outbound packets from Exim will be marked with this value in the header
22875 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22876 that these values will have any effect, not be stripped by networking
22877 equipment, or do much of anything without cooperation with your Network
22878 Engineer and those of all network operators between the source and destination.
22879
22880
22881 .option fallback_hosts smtp "string list" unset
22882 .cindex "fallback" "hosts specified on transport"
22883 String expansion is not applied to this option. The argument must be a
22884 colon-separated list of host names or IP addresses, optionally also including
22885 port numbers, though the separator can be changed, as described in section
22886 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22887 item in a &%route_list%& setting for the &(manualroute)& router, as described
22888 in section &<<SECTformatonehostitem>>&.
22889
22890 Fallback hosts can also be specified on routers, which associate them with the
22891 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22892 &%fallback_hosts%& specified on the transport is used only if the address does
22893 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22894 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22895 However, &%hosts_randomize%& does apply to fallback host lists.
22896
22897 If Exim is unable to deliver to any of the hosts for a particular address, and
22898 the errors are not permanent rejections, the address is put on a separate
22899 transport queue with its host list replaced by the fallback hosts, unless the
22900 address was routed via MX records and the current host was in the original MX
22901 list. In that situation, the fallback host list is not used.
22902
22903 Once normal deliveries are complete, the fallback queue is delivered by
22904 re-running the same transports with the new host lists. If several failing
22905 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22906 copy of the message is sent.
22907
22908 The resolution of the host names on the fallback list is controlled by the
22909 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22910 both to cases when the host list comes with the address and when it is taken
22911 from &%hosts%&. This option provides a &"use a smart host only if delivery
22912 fails"& facility.
22913
22914
22915 .option final_timeout smtp time 10m
22916 This is the timeout that applies while waiting for the response to the final
22917 line containing just &"."& that terminates a message. Its value must not be
22918 zero.
22919
22920 .option gethostbyname smtp boolean false
22921 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22922 being used, names are looked up using &[gethostbyname()]&
22923 (or &[getipnodebyname()]& when available)
22924 instead of using the DNS. Of course, that function may in fact use the DNS, but
22925 it may also consult other sources of information such as &_/etc/hosts_&.
22926
22927 .option gnutls_compat_mode smtp boolean unset
22928 This option controls whether GnuTLS is used in compatibility mode in an Exim
22929 server. This reduces security slightly, but improves interworking with older
22930 implementations of TLS.
22931
22932 .option helo_data smtp string&!! "see below"
22933 .cindex "HELO" "argument, setting"
22934 .cindex "EHLO" "argument, setting"
22935 .cindex "LHLO argument setting"
22936 The value of this option is expanded after a connection to a another host has
22937 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22938 command that starts the outgoing SMTP or LMTP session. The default value of the
22939 option is:
22940 .code
22941 $primary_hostname
22942 .endd
22943 During the expansion, the variables &$host$& and &$host_address$& are set to
22944 the identity of the remote host, and the variables &$sending_ip_address$& and
22945 &$sending_port$& are set to the local IP address and port number that are being
22946 used. These variables can be used to generate different values for different
22947 servers or different local IP addresses. For example, if you want the string
22948 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22949 interface address, you could use this:
22950 .code
22951 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22952   {$primary_hostname}}
22953 .endd
22954 The use of &%helo_data%& applies both to sending messages and when doing
22955 callouts.
22956
22957 .option hosts smtp "string list&!!" unset
22958 Hosts are associated with an address by a router such as &(dnslookup)&, which
22959 finds the hosts by looking up the address domain in the DNS, or by
22960 &(manualroute)&, which has lists of hosts in its configuration. However,
22961 email addresses can be passed to the &(smtp)& transport by any router, and not
22962 all of them can provide an associated list of hosts.
22963
22964 The &%hosts%& option specifies a list of hosts to be used if the address being
22965 processed does not have any hosts associated with it. The hosts specified by
22966 &%hosts%& are also used, whether or not the address has its own hosts, if
22967 &%hosts_override%& is set.
22968
22969 The string is first expanded, before being interpreted as a colon-separated
22970 list of host names or IP addresses, possibly including port numbers. The
22971 separator may be changed to something other than colon, as described in section
22972 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22973 item in a &%route_list%& setting for the &(manualroute)& router, as described
22974 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22975 of the &(manualroute)& router is not available here.
22976
22977 If the expansion fails, delivery is deferred. Unless the failure was caused by
22978 the inability to complete a lookup, the error is logged to the panic log as
22979 well as the main log. Host names are looked up either by searching directly for
22980 address records in the DNS or by calling &[gethostbyname()]& (or
22981 &[getipnodebyname()]& when available), depending on the setting of the
22982 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22983 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22984 address are used.
22985
22986 During delivery, the hosts are tried in order, subject to their retry status,
22987 unless &%hosts_randomize%& is set.
22988
22989
22990 .option hosts_avoid_esmtp smtp "host list&!!" unset
22991 .cindex "ESMTP, avoiding use of"
22992 .cindex "HELO" "forcing use of"
22993 .cindex "EHLO" "avoiding use of"
22994 .cindex "PIPELINING" "avoiding the use of"
22995 This option is for use with broken hosts that announce ESMTP facilities (for
22996 example, PIPELINING) and then fail to implement them properly. When a host
22997 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22998 start of the SMTP session. This means that it cannot use any of the ESMTP
22999 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23000
23001
23002 .option hosts_avoid_pipelining smtp "host list&!!" unset
23003 .cindex "PIPELINING" "avoiding the use of"
23004 Exim will not use the SMTP PIPELINING extension when delivering to any host
23005 that matches this list, even if the server host advertises PIPELINING support.
23006
23007
23008 .option hosts_avoid_tls smtp "host list&!!" unset
23009 .cindex "TLS" "avoiding for certain hosts"
23010 Exim will not try to start a TLS session when delivering to any host that
23011 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23012
23013 .option hosts_verify_avoid_tls smtp "host list&!!" *
23014 .cindex "TLS" "avoiding for certain hosts"
23015 Exim will not try to start a TLS session for a verify callout,
23016 or when delivering in cutthrough mode,
23017 to any host that matches this list.
23018 Note that the default is to not use TLS.
23019
23020
23021 .option hosts_max_try smtp integer 5
23022 .cindex "host" "maximum number to try"
23023 .cindex "limit" "number of hosts tried"
23024 .cindex "limit" "number of MX tried"
23025 .cindex "MX record" "maximum tried"
23026 This option limits the number of IP addresses that are tried for any one
23027 delivery in cases where there are temporary delivery errors. Section
23028 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23029
23030
23031 .option hosts_max_try_hardlimit smtp integer 50
23032 This is an additional check on the maximum number of IP addresses that Exim
23033 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23034 why it exists.
23035
23036
23037
23038 .option hosts_nopass_tls smtp "host list&!!" unset
23039 .cindex "TLS" "passing connection"
23040 .cindex "multiple SMTP deliveries"
23041 .cindex "TLS" "multiple message deliveries"
23042 For any host that matches this list, a connection on which a TLS session has
23043 been started will not be passed to a new delivery process for sending another
23044 message on the same connection. See section &<<SECTmulmessam>>& for an
23045 explanation of when this might be needed.
23046
23047
23048 .option hosts_override smtp boolean false
23049 If this option is set and the &%hosts%& option is also set, any hosts that are
23050 attached to the address are ignored, and instead the hosts specified by the
23051 &%hosts%& option are always used. This option does not apply to
23052 &%fallback_hosts%&.
23053
23054
23055 .option hosts_randomize smtp boolean false
23056 .cindex "randomized host list"
23057 .cindex "host" "list of; randomized"
23058 .cindex "fallback" "randomized hosts"
23059 If this option is set, and either the list of hosts is taken from the
23060 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23061 were not obtained from MX records (this includes fallback hosts from the
23062 router), and were not randomized by the router, the order of trying the hosts
23063 is randomized each time the transport runs. Randomizing the order of a host
23064 list can be used to do crude load sharing.
23065
23066 When &%hosts_randomize%& is true, a host list may be split into groups whose
23067 order is separately randomized. This makes it possible to set up MX-like
23068 behaviour. The boundaries between groups are indicated by an item that is just
23069 &`+`& in the host list. For example:
23070 .code
23071 hosts = host1:host2:host3:+:host4:host5
23072 .endd
23073 The order of the first three hosts and the order of the last two hosts is
23074 randomized for each use, but the first three always end up before the last two.
23075 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23076
23077 .option hosts_require_auth smtp "host list&!!" unset
23078 .cindex "authentication" "required by client"
23079 This option provides a list of servers for which authentication must succeed
23080 before Exim will try to transfer a message. If authentication fails for
23081 servers which are not in this list, Exim tries to send unauthenticated. If
23082 authentication fails for one of these servers, delivery is deferred. This
23083 temporary error is detectable in the retry rules, so it can be turned into a
23084 hard failure if required. See also &%hosts_try_auth%&, and chapter
23085 &<<CHAPSMTPAUTH>>& for details of authentication.
23086
23087
23088 .option hosts_request_ocsp smtp "host list&!!" *
23089 .cindex "TLS" "requiring for certain servers"
23090 Exim will request a Certificate Status on a
23091 TLS session for any host that matches this list.
23092 &%tls_verify_certificates%& should also be set for the transport.
23093
23094 .option hosts_require_ocsp smtp "host list&!!" unset
23095 .cindex "TLS" "requiring for certain servers"
23096 Exim will request, and check for a valid Certificate Status being given, on a
23097 TLS session for any host that matches this list.
23098 &%tls_verify_certificates%& should also be set for the transport.
23099
23100 .option hosts_require_tls smtp "host list&!!" unset
23101 .cindex "TLS" "requiring for certain servers"
23102 Exim will insist on using a TLS session when delivering to any host that
23103 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23104 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23105 incoming messages, use an appropriate ACL.
23106
23107 .option hosts_try_auth smtp "host list&!!" unset
23108 .cindex "authentication" "optional in client"
23109 This option provides a list of servers to which, provided they announce
23110 authentication support, Exim will attempt to authenticate as a client when it
23111 connects. If authentication fails, Exim will try to transfer the message
23112 unauthenticated. See also &%hosts_require_auth%&, and chapter
23113 &<<CHAPSMTPAUTH>>& for details of authentication.
23114
23115 .option hosts_try_prdr smtp "host list&!!" unset
23116 .cindex "PRDR" "enabling, optional in client"
23117 This option provides a list of servers to which, provided they announce
23118 PRDR support, Exim will attempt to negotiate PRDR
23119 for multi-recipient messages.
23120
23121 .option interface smtp "string list&!!" unset
23122 .cindex "bind IP address"
23123 .cindex "IP address" "binding"
23124 .vindex "&$host$&"
23125 .vindex "&$host_address$&"
23126 This option specifies which interface to bind to when making an outgoing SMTP
23127 call. The value is an IP address, not an interface name such as
23128 &`eth0`&. Do not confuse this with the interface address that was used when a
23129 message was received, which is in &$received_ip_address$&, formerly known as
23130 &$interface_address$&. The name was changed to minimize confusion with the
23131 outgoing interface address. There is no variable that contains an outgoing
23132 interface address because, unless it is set by this option, its value is
23133 unknown.
23134
23135 During the expansion of the &%interface%& option the variables &$host$& and
23136 &$host_address$& refer to the host to which a connection is about to be made
23137 during the expansion of the string. Forced expansion failure, or an empty
23138 string result causes the option to be ignored. Otherwise, after expansion, the
23139 string must be a list of IP addresses, colon-separated by default, but the
23140 separator can be changed in the usual way. For example:
23141 .code
23142 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23143 .endd
23144 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23145 connection. If none of them are the correct type, the option is ignored. If
23146 &%interface%& is not set, or is ignored, the system's IP functions choose which
23147 interface to use if the host has more than one.
23148
23149
23150 .option keepalive smtp boolean true
23151 .cindex "keepalive" "on outgoing connection"
23152 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23153 connections. When set, it causes the kernel to probe idle connections
23154 periodically, by sending packets with &"old"& sequence numbers. The other end
23155 of the connection should send a acknowledgment if the connection is still okay
23156 or a reset if the connection has been aborted. The reason for doing this is
23157 that it has the beneficial effect of freeing up certain types of connection
23158 that can get stuck when the remote host is disconnected without tidying up the
23159 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23160 unreachable hosts.
23161
23162
23163 .option lmtp_ignore_quota smtp boolean false
23164 .cindex "LMTP" "ignoring quota errors"
23165 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23166 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23167 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23168
23169 .option max_rcpt smtp integer 100
23170 .cindex "RCPT" "maximum number of outgoing"
23171 This option limits the number of RCPT commands that are sent in a single
23172 SMTP message transaction. Each set of addresses is treated independently, and
23173 so can cause parallel connections to the same host if &%remote_max_parallel%&
23174 permits this.
23175
23176
23177 .option multi_domain smtp boolean true
23178 .vindex "&$domain$&"
23179 When this option is set, the &(smtp)& transport can handle a number of
23180 addresses containing a mixture of different domains provided they all resolve
23181 to the same list of hosts. Turning the option off restricts the transport to
23182 handling only one domain at a time. This is useful if you want to use
23183 &$domain$& in an expansion for the transport, because it is set only when there
23184 is a single domain involved in a remote delivery.
23185
23186
23187 .option port smtp string&!! "see below"
23188 .cindex "port" "sending TCP/IP"
23189 .cindex "TCP/IP" "setting outgoing port"
23190 This option specifies the TCP/IP port on the server to which Exim connects.
23191 &*Note:*& Do not confuse this with the port that was used when a message was
23192 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23193 The name was changed to minimize confusion with the outgoing port. There is no
23194 variable that contains an outgoing port.
23195
23196 If the value of this option begins with a digit it is taken as a port number;
23197 otherwise it is looked up using &[getservbyname()]&. The default value is
23198 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23199 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23200 is deferred.
23201
23202
23203
23204 .option protocol smtp string smtp
23205 .cindex "LMTP" "over TCP/IP"
23206 .cindex "ssmtp protocol" "outbound"
23207 .cindex "TLS" "SSL-on-connect outbound"
23208 .vindex "&$port$&"
23209 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23210 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23211 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23212 deliveries into closed message stores. Exim also has support for running LMTP
23213 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23214
23215 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23216 changes to &"smtps"&, and the transport initiates TLS immediately after
23217 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23218 The Internet standards bodies strongly discourage use of this mode.
23219
23220
23221 .option retry_include_ip_address smtp boolean true
23222 Exim normally includes both the host name and the IP address in the key it
23223 constructs for indexing retry data after a temporary delivery failure. This
23224 means that when one of several IP addresses for a host is failing, it gets
23225 tried periodically (controlled by the retry rules), but use of the other IP
23226 addresses is not affected.
23227
23228 However, in some dialup environments hosts are assigned a different IP address
23229 each time they connect. In this situation the use of the IP address as part of
23230 the retry key leads to undesirable behaviour. Setting this option false causes
23231 Exim to use only the host name. This should normally be done on a separate
23232 instance of the &(smtp)& transport, set up specially to handle the dialup
23233 hosts.
23234
23235
23236 .option serialize_hosts smtp "host list&!!" unset
23237 .cindex "serializing connections"
23238 .cindex "host" "serializing connections"
23239 Because Exim operates in a distributed manner, if several messages for the same
23240 host arrive at around the same time, more than one simultaneous connection to
23241 the remote host can occur. This is not usually a problem except when there is a
23242 slow link between the hosts. In that situation it may be helpful to restrict
23243 Exim to one connection at a time. This can be done by setting
23244 &%serialize_hosts%& to match the relevant hosts.
23245
23246 .cindex "hints database" "serializing deliveries to a host"
23247 Exim implements serialization by means of a hints database in which a record is
23248 written whenever a process connects to one of the restricted hosts. The record
23249 is deleted when the connection is completed. Obviously there is scope for
23250 records to get left lying around if there is a system or program crash. To
23251 guard against this, Exim ignores any records that are more than six hours old.
23252
23253 If you set up this kind of serialization, you should also arrange to delete the
23254 relevant hints database whenever your system reboots. The names of the files
23255 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23256 may be one or two files, depending on the type of DBM in use. The same files
23257 are used for ETRN serialization.
23258
23259
23260 .option size_addition smtp integer 1024
23261 .cindex "SMTP" "SIZE"
23262 .cindex "message" "size issue for transport filter"
23263 .cindex "size" "of message"
23264 .cindex "transport" "filter"
23265 .cindex "filter" "transport filter"
23266 If a remote SMTP server indicates that it supports the SIZE option of the
23267 MAIL command, Exim uses this to pass over the message size at the start of
23268 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23269 sends, to allow for headers and other text that may be added during delivery by
23270 configuration options or in a transport filter. It may be necessary to increase
23271 this if a lot of text is added to messages.
23272
23273 Alternatively, if the value of &%size_addition%& is set negative, it disables
23274 the use of the SIZE option altogether.
23275
23276
23277 .option tls_certificate smtp string&!! unset
23278 .cindex "TLS" "client certificate, location of"
23279 .cindex "certificate" "client, location of"
23280 .vindex "&$host$&"
23281 .vindex "&$host_address$&"
23282 The value of this option must be the absolute path to a file which contains the
23283 client's certificate, for possible use when sending a message over an encrypted
23284 connection. The values of &$host$& and &$host_address$& are set to the name and
23285 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23286 details of TLS.
23287
23288 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23289 certificate when sending messages as a client. The global option of the same
23290 name specifies the certificate for Exim as a server; it is not automatically
23291 assumed that the same certificate should be used when Exim is operating as a
23292 client.
23293
23294
23295 .option tls_crl smtp string&!! unset
23296 .cindex "TLS" "client certificate revocation list"
23297 .cindex "certificate" "revocation list for client"
23298 This option specifies a certificate revocation list. The expanded value must
23299 be the name of a file that contains a CRL in PEM format.
23300
23301
23302 .option tls_dh_min_bits smtp integer 1024
23303 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23304 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23305 key agreement is negotiated, the server will provide a large prime number
23306 for use.  This option establishes the minimum acceptable size of that number.
23307 If the parameter offered by the server is too small, then the TLS handshake
23308 will fail.
23309
23310 Only supported when using GnuTLS.
23311
23312
23313 .option tls_privatekey smtp string&!! unset
23314 .cindex "TLS" "client private key, location of"
23315 .vindex "&$host$&"
23316 .vindex "&$host_address$&"
23317 The value of this option must be the absolute path to a file which contains the
23318 client's private key. This is used when sending a message over an encrypted
23319 connection using a client certificate. The values of &$host$& and
23320 &$host_address$& are set to the name and address of the server during the
23321 expansion. If this option is unset, or the expansion is forced to fail, or the
23322 result is an empty string, the private key is assumed to be in the same file as
23323 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23324
23325
23326 .option tls_require_ciphers smtp string&!! unset
23327 .cindex "TLS" "requiring specific ciphers"
23328 .cindex "cipher" "requiring specific"
23329 .vindex "&$host$&"
23330 .vindex "&$host_address$&"
23331 The value of this option must be a list of permitted cipher suites, for use
23332 when setting up an outgoing encrypted connection. (There is a global option of
23333 the same name for controlling incoming connections.) The values of &$host$& and
23334 &$host_address$& are set to the name and address of the server during the
23335 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23336 is used in different ways by OpenSSL and GnuTLS (see sections
23337 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23338 ciphers is a preference order.
23339
23340
23341
23342 .option tls_sni smtp string&!! unset
23343 .cindex "TLS" "Server Name Indication"
23344 .vindex "&$tls_sni$&"
23345 If this option is set then it sets the $tls_out_sni variable and causes any
23346 TLS session to pass this value as the Server Name Indication extension to
23347 the remote side, which can be used by the remote side to select an appropriate
23348 certificate and private key for the session.
23349
23350 See &<<SECTtlssni>>& for more information.
23351
23352 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23353 TLS extensions.
23354
23355
23356
23357
23358 .option tls_tempfail_tryclear smtp boolean true
23359 .cindex "4&'xx'& responses" "to STARTTLS"
23360 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23361 setting up a TLS session, this option determines whether or not Exim should try
23362 to deliver the message unencrypted. If it is set false, delivery to the
23363 current host is deferred; if there are other hosts, they are tried. If this
23364 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23365 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23366 TLS negotiation fails, Exim closes the current connection (because it is in an
23367 unknown state), opens a new one to the same host, and then tries the delivery
23368 in clear.
23369
23370
23371 .option tls_try_verify_hosts smtp "host list&!! unset
23372 .cindex "TLS" "server certificate verification"
23373 .cindex "certificate" "verification of server"
23374 This option gives a list of hosts for which, on encrypted connections,
23375 certificate verification will be tried but need not succeed.
23376 The &%tls_verify_certificates%& option must also be set.
23377 Note that unless the host is in this list
23378 TLS connections will be denied to hosts using self-signed certificates
23379 when &%tls_verify_certificates%& is set.
23380 The &$tls_out_certificate_verified$& variable is set when
23381 certificate verification succeeds.
23382
23383
23384 .option tls_verify_certificates smtp string&!! unset
23385 .cindex "TLS" "server certificate verification"
23386 .cindex "certificate" "verification of server"
23387 .vindex "&$host$&"
23388 .vindex "&$host_address$&"
23389 The value of this option must be the absolute path to a file containing
23390 permitted server certificates, for use when setting up an encrypted connection.
23391 Alternatively, if you are using OpenSSL, you can set
23392 &%tls_verify_certificates%& to the name of a directory containing certificate
23393 files. This does not work with GnuTLS; the option must be set to the name of a
23394 single file if you are using GnuTLS. The values of &$host$& and
23395 &$host_address$& are set to the name and address of the server during the
23396 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23397
23398 For back-compatability,
23399 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23400 and certificate verification fails the TLS connection is closed.
23401
23402
23403 .option tls_verify_hosts smtp "host list&!! unset
23404 .cindex "TLS" "server certificate verification"
23405 .cindex "certificate" "verification of server"
23406 This option gives a list of hosts for which. on encrypted connections,
23407 certificate verification must succeed.
23408 The &%tls_verify_certificates%& option must also be set.
23409 If both this option and &%tls_try_verify_hosts%& are unset
23410 operation is as if this option selected all hosts.
23411
23412
23413
23414
23415 .section "How the limits for the number of hosts to try are used" &&&
23416          "SECTvalhosmax"
23417 .cindex "host" "maximum number to try"
23418 .cindex "limit" "hosts; maximum number tried"
23419 There are two options that are concerned with the number of hosts that are
23420 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23421 &%hosts_max_try_hardlimit%&.
23422
23423
23424 The &%hosts_max_try%& option limits the number of hosts that are tried
23425 for a single delivery. However, despite the term &"host"& in its name, the
23426 option actually applies to each IP address independently. In other words, a
23427 multihomed host is treated as several independent hosts, just as it is for
23428 retrying.
23429
23430 Many of the larger ISPs have multiple MX records which often point to
23431 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23432 created as a result of routing one of these domains.
23433
23434 Trying every single IP address on such a long list does not seem sensible; if
23435 several at the top of the list fail, it is reasonable to assume there is some
23436 problem that is likely to affect all of them. Roughly speaking, the value of
23437 &%hosts_max_try%& is the maximum number that are tried before deferring the
23438 delivery. However, the logic cannot be quite that simple.
23439
23440 Firstly, IP addresses that are skipped because their retry times have not
23441 arrived do not count, and in addition, addresses that are past their retry
23442 limits are also not counted, even when they are tried. This means that when
23443 some IP addresses are past their retry limits, more than the value of
23444 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23445 that all IP addresses are considered before timing out an email address (but
23446 see below for an exception).
23447
23448 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23449 list to see if there is a subsequent host with a different (higher valued) MX.
23450 If there is, that host is considered next, and the current IP address is used
23451 but not counted. This behaviour helps in the case of a domain with a retry rule
23452 that hardly ever delays any hosts, as is now explained:
23453
23454 Consider the case of a long list of hosts with one MX value, and a few with a
23455 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23456 hosts at the top of the list are tried at first. With the default retry rule,
23457 which specifies increasing retry times, the higher MX hosts are eventually
23458 tried when those at the top of the list are skipped because they have not
23459 reached their retry times.
23460
23461 However, it is common practice to put a fixed short retry time on domains for
23462 large ISPs, on the grounds that their servers are rarely down for very long.
23463 Unfortunately, these are exactly the domains that tend to resolve to long lists
23464 of hosts. The short retry time means that the lowest MX hosts are tried every
23465 time. The attempts may be in a different order because of random sorting, but
23466 without the special MX check, the higher MX hosts would never be tried until
23467 all the lower MX hosts had timed out (which might be several days), because
23468 there are always some lower MX hosts that have reached their retry times. With
23469 the special check, Exim considers at least one IP address from each MX value at
23470 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23471 reached.
23472
23473 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23474 particular, Exim normally eventually tries all the IP addresses before timing
23475 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23476 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23477 been set up with hundreds of IP addresses for some domains. It can
23478 take a very long time indeed for an address to time out in these cases.
23479
23480 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23481 Exim never tries more than this number of IP addresses; if it hits this limit
23482 and they are all timed out, the email address is bounced, even though not all
23483 possible IP addresses have been tried.
23484 .ecindex IIDsmttra1
23485 .ecindex IIDsmttra2
23486
23487
23488
23489
23490
23491 . ////////////////////////////////////////////////////////////////////////////
23492 . ////////////////////////////////////////////////////////////////////////////
23493
23494 .chapter "Address rewriting" "CHAPrewrite"
23495 .scindex IIDaddrew "rewriting" "addresses"
23496 There are some circumstances in which Exim automatically rewrites domains in
23497 addresses. The two most common are when an address is given without a domain
23498 (referred to as an &"unqualified address"&) or when an address contains an
23499 abbreviated domain that is expanded by DNS lookup.
23500
23501 Unqualified envelope addresses are accepted only for locally submitted
23502 messages, or for messages that are received from hosts matching
23503 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23504 appropriate. Unqualified addresses in header lines are qualified if they are in
23505 locally submitted messages, or messages from hosts that are permitted to send
23506 unqualified envelope addresses. Otherwise, unqualified addresses in header
23507 lines are neither qualified nor rewritten.
23508
23509 One situation in which Exim does &'not'& automatically rewrite a domain is
23510 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23511 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23512 do this. The new RFCs do not contain this suggestion.
23513
23514
23515 .section "Explicitly configured address rewriting" "SECID147"
23516 This chapter describes the rewriting rules that can be used in the
23517 main rewrite section of the configuration file, and also in the generic
23518 &%headers_rewrite%& option that can be set on any transport.
23519
23520 Some people believe that configured address rewriting is a Mortal Sin.
23521 Others believe that life is not possible without it. Exim provides the
23522 facility; you do not have to use it.
23523
23524 The main rewriting rules that appear in the &"rewrite"& section of the
23525 configuration file are applied to addresses in incoming messages, both envelope
23526 addresses and addresses in header lines. Each rule specifies the types of
23527 address to which it applies.
23528
23529 Whether or not addresses in header lines are rewritten depends on the origin of
23530 the headers and the type of rewriting. Global rewriting, that is, rewriting
23531 rules from the rewrite section of the configuration file, is applied only to
23532 those headers that were received with the message. Header lines that are added
23533 by ACLs or by a system filter or by individual routers or transports (which
23534 are specific to individual recipient addresses) are not rewritten by the global
23535 rules.
23536
23537 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23538 applies all headers except those added by routers and transports. That is, as
23539 well as the headers that were received with the message, it also applies to
23540 headers that were added by an ACL or a system filter.
23541
23542
23543 In general, rewriting addresses from your own system or domain has some
23544 legitimacy. Rewriting other addresses should be done only with great care and
23545 in special circumstances. The author of Exim believes that rewriting should be
23546 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23547 Although it can sometimes be used as a routing tool, this is very strongly
23548 discouraged.
23549
23550 There are two commonly encountered circumstances where rewriting is used, as
23551 illustrated by these examples:
23552
23553 .ilist
23554 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23555 exchange mail with each other behind a firewall, but there is only a single
23556 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23557 &'hitch.fict.example'& when sending mail off-site.
23558 .next
23559 A host rewrites the local parts of its own users so that, for example,
23560 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23561 .endlist
23562
23563
23564
23565 .section "When does rewriting happen?" "SECID148"
23566 .cindex "rewriting" "timing of"
23567 .cindex "&ACL;" "rewriting addresses in"
23568 Configured address rewriting can take place at several different stages of a
23569 message's processing.
23570
23571 .vindex "&$sender_address$&"
23572 At the start of an ACL for MAIL, the sender address may have been rewritten
23573 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23574 ordinary rewrite rules have yet been applied. If, however, the sender address
23575 is verified in the ACL, it is rewritten before verification, and remains
23576 rewritten thereafter. The subsequent value of &$sender_address$& is the
23577 rewritten address. This also applies if sender verification happens in a
23578 RCPT ACL. Otherwise, when the sender address is not verified, it is
23579 rewritten as soon as a message's header lines have been received.
23580
23581 .vindex "&$domain$&"
23582 .vindex "&$local_part$&"
23583 Similarly, at the start of an ACL for RCPT, the current recipient's address
23584 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23585 rewrite rules have yet been applied to it. However, the behaviour is different
23586 from the sender address when a recipient is verified. The address is rewritten
23587 for the verification, but the rewriting is not remembered at this stage. The
23588 value of &$local_part$& and &$domain$& after verification are always the same
23589 as they were before (that is, they contain the unrewritten &-- except for
23590 SMTP-time rewriting &-- address).
23591
23592 As soon as a message's header lines have been received, all the envelope
23593 recipient addresses are permanently rewritten, and rewriting is also applied to
23594 the addresses in the header lines (if configured). This happens before adding
23595 any header lines that were specified in MAIL or RCPT ACLs, and
23596 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23597 before the DATA ACL and &[local_scan()]& functions are run.
23598
23599 When an address is being routed, either for delivery or for verification,
23600 rewriting is applied immediately to child addresses that are generated by
23601 redirection, unless &%no_rewrite%& is set on the router.
23602
23603 .cindex "envelope sender" "rewriting at transport time"
23604 .cindex "rewriting" "at transport time"
23605 .cindex "header lines" "rewriting at transport time"
23606 At transport time, additional rewriting of addresses in header lines can be
23607 specified by setting the generic &%headers_rewrite%& option on a transport.
23608 This option contains rules that are identical in form to those in the rewrite
23609 section of the configuration file. They are applied to the original message
23610 header lines and any that were added by ACLs or a system filter. They are not
23611 applied to header lines that are added by routers or the transport.
23612
23613 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23614 transport option. However, it is not possible to rewrite envelope recipients at
23615 transport time.
23616
23617
23618
23619
23620 .section "Testing the rewriting rules that apply on input" "SECID149"
23621 .cindex "rewriting" "testing"
23622 .cindex "testing" "rewriting"
23623 Exim's input rewriting configuration appears in a part of the run time
23624 configuration file headed by &"begin rewrite"&. It can be tested by the
23625 &%-brw%& command line option. This takes an address (which can be a full RFC
23626 2822 address) as its argument. The output is a list of how the address would be
23627 transformed by the rewriting rules for each of the different places it might
23628 appear in an incoming message, that is, for each different header and for the
23629 envelope sender and recipient fields. For example,
23630 .code
23631 exim -brw ph10@exim.workshop.example
23632 .endd
23633 might produce the output
23634 .code
23635 sender: Philip.Hazel@exim.workshop.example
23636 from: Philip.Hazel@exim.workshop.example
23637 to: ph10@exim.workshop.example
23638 cc: ph10@exim.workshop.example
23639 bcc: ph10@exim.workshop.example
23640 reply-to: Philip.Hazel@exim.workshop.example
23641 env-from: Philip.Hazel@exim.workshop.example
23642 env-to: ph10@exim.workshop.example
23643 .endd
23644 which shows that rewriting has been set up for that address when used in any of
23645 the source fields, but not when it appears as a recipient address. At the
23646 present time, there is no equivalent way of testing rewriting rules that are
23647 set for a particular transport.
23648
23649
23650 .section "Rewriting rules" "SECID150"
23651 .cindex "rewriting" "rules"
23652 The rewrite section of the configuration file consists of lines of rewriting
23653 rules in the form
23654 .display
23655 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23656 .endd
23657 Rewriting rules that are specified for the &%headers_rewrite%& generic
23658 transport option are given as a colon-separated list. Each item in the list
23659 takes the same form as a line in the main rewriting configuration (except that
23660 any colons must be doubled, of course).
23661
23662 The formats of source patterns and replacement strings are described below.
23663 Each is terminated by white space, unless enclosed in double quotes, in which
23664 case normal quoting conventions apply inside the quotes. The flags are single
23665 characters which may appear in any order. Spaces and tabs between them are
23666 ignored.
23667
23668 For each address that could potentially be rewritten, the rules are scanned in
23669 order, and replacements for the address from earlier rules can themselves be
23670 replaced by later rules (but see the &"q"& and &"R"& flags).
23671
23672 The order in which addresses are rewritten is undefined, may change between
23673 releases, and must not be relied on, with one exception: when a message is
23674 received, the envelope sender is always rewritten first, before any header
23675 lines are rewritten. For example, the replacement string for a rewrite of an
23676 address in &'To:'& must not assume that the message's address in &'From:'& has
23677 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23678 that the envelope sender has already been rewritten.
23679
23680 .vindex "&$domain$&"
23681 .vindex "&$local_part$&"
23682 The variables &$local_part$& and &$domain$& can be used in the replacement
23683 string to refer to the address that is being rewritten. Note that lookup-driven
23684 rewriting can be done by a rule of the form
23685 .code
23686 *@*   ${lookup ...
23687 .endd
23688 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23689 refer to the address that is being rewritten.
23690
23691
23692 .section "Rewriting patterns" "SECID151"
23693 .cindex "rewriting" "patterns"
23694 .cindex "address list" "in a rewriting pattern"
23695 The source pattern in a rewriting rule is any item which may appear in an
23696 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23697 single-item address list, which means that it is expanded before being tested
23698 against the address. As always, if you use a regular expression as a pattern,
23699 you must take care to escape dollar and backslash characters, or use the &`\N`&
23700 facility to suppress string expansion within the regular expression.
23701
23702 Domains in patterns should be given in lower case. Local parts in patterns are
23703 case-sensitive. If you want to do case-insensitive matching of local parts, you
23704 can use a regular expression that starts with &`^(?i)`&.
23705
23706 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23707 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23708 depending on the type of match which occurred. These can be used in the
23709 replacement string to insert portions of the incoming address. &$0$& always
23710 refers to the complete incoming address. When a regular expression is used, the
23711 numerical variables are set from its capturing subexpressions. For other types
23712 of pattern they are set as follows:
23713
23714 .ilist
23715 If a local part or domain starts with an asterisk, the numerical variables
23716 refer to the character strings matched by asterisks, with &$1$& associated with
23717 the first asterisk, and &$2$& with the second, if present. For example, if the
23718 pattern
23719 .code
23720 *queen@*.fict.example
23721 .endd
23722 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23723 .code
23724 $0 = hearts-queen@wonderland.fict.example
23725 $1 = hearts-
23726 $2 = wonderland
23727 .endd
23728 Note that if the local part does not start with an asterisk, but the domain
23729 does, it is &$1$& that contains the wild part of the domain.
23730
23731 .next
23732 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23733 of the domain are placed in the next available numerical variables. Suppose,
23734 for example, that the address &'foo@bar.baz.example'& is processed by a
23735 rewriting rule of the form
23736 .display
23737 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23738 .endd
23739 and the key in the file that matches the domain is &`*.baz.example`&. Then
23740 .code
23741 $1 = foo
23742 $2 = bar
23743 $3 = baz.example
23744 .endd
23745 If the address &'foo@baz.example'& is looked up, this matches the same
23746 wildcard file entry, and in this case &$2$& is set to the empty string, but
23747 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23748 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23749 whole domain. For non-partial domain lookups, no numerical variables are set.
23750 .endlist
23751
23752
23753 .section "Rewriting replacements" "SECID152"
23754 .cindex "rewriting" "replacements"
23755 If the replacement string for a rule is a single asterisk, addresses that
23756 match the pattern and the flags are &'not'& rewritten, and no subsequent
23757 rewriting rules are scanned. For example,
23758 .code
23759 hatta@lookingglass.fict.example  *  f
23760 .endd
23761 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23762 &'From:'& headers.
23763
23764 .vindex "&$domain$&"
23765 .vindex "&$local_part$&"
23766 If the replacement string is not a single asterisk, it is expanded, and must
23767 yield a fully qualified address. Within the expansion, the variables
23768 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23769 Any letters they contain retain their original case &-- they are not lower
23770 cased. The numerical variables are set up according to the type of pattern that
23771 matched the address, as described above. If the expansion is forced to fail by
23772 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23773 current rule is abandoned, but subsequent rules may take effect. Any other
23774 expansion failure causes the entire rewriting operation to be abandoned, and an
23775 entry written to the panic log.
23776
23777
23778
23779 .section "Rewriting flags" "SECID153"
23780 There are three different kinds of flag that may appear on rewriting rules:
23781
23782 .ilist
23783 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23784 c, f, h, r, s, t.
23785 .next
23786 A flag that specifies rewriting at SMTP time: S.
23787 .next
23788 Flags that control the rewriting process: Q, q, R, w.
23789 .endlist
23790
23791 For rules that are part of the &%headers_rewrite%& generic transport option,
23792 E, F, T, and S are not permitted.
23793
23794
23795
23796 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23797          "SECID154"
23798 .cindex "rewriting" "flags"
23799 If none of the following flag letters, nor the &"S"& flag (see section
23800 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23801 and to both the sender and recipient fields of the envelope, whereas a
23802 transport-time rewriting rule just applies to all headers. Otherwise, the
23803 rewriting rule is skipped unless the relevant addresses are being processed.
23804 .display
23805 &`E`&       rewrite all envelope fields
23806 &`F`&       rewrite the envelope From field
23807 &`T`&       rewrite the envelope To field
23808 &`b`&       rewrite the &'Bcc:'& header
23809 &`c`&       rewrite the &'Cc:'& header
23810 &`f`&       rewrite the &'From:'& header
23811 &`h`&       rewrite all headers
23812 &`r`&       rewrite the &'Reply-To:'& header
23813 &`s`&       rewrite the &'Sender:'& header
23814 &`t`&       rewrite the &'To:'& header
23815 .endd
23816 "All headers" means all of the headers listed above that can be selected
23817 individually, plus their &'Resent-'& versions. It does not include
23818 other headers such as &'Subject:'& etc.
23819
23820 You should be particularly careful about rewriting &'Sender:'& headers, and
23821 restrict this to special known cases in your own domains.
23822
23823
23824 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23825 .cindex "SMTP" "rewriting malformed addresses"
23826 .cindex "RCPT" "rewriting argument of"
23827 .cindex "MAIL" "rewriting argument of"
23828 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23829 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23830 before any other processing; even before syntax checking. The pattern is
23831 required to be a regular expression, and it is matched against the whole of the
23832 data for the command, including any surrounding angle brackets.
23833
23834 .vindex "&$domain$&"
23835 .vindex "&$local_part$&"
23836 This form of rewrite rule allows for the handling of addresses that are not
23837 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23838 input). Because the input is not required to be a syntactically valid address,
23839 the variables &$local_part$& and &$domain$& are not available during the
23840 expansion of the replacement string. The result of rewriting replaces the
23841 original address in the MAIL or RCPT command.
23842
23843
23844 .section "Flags controlling the rewriting process" "SECID155"
23845 There are four flags which control the way the rewriting process works. These
23846 take effect only when a rule is invoked, that is, when the address is of the
23847 correct type (matches the flags) and matches the pattern:
23848
23849 .ilist
23850 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23851 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23852 absence of &"Q"& the rewritten address must always include a domain.
23853 .next
23854 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23855 even if no rewriting actually takes place because of a &"fail"& in the
23856 expansion. The &"q"& flag is not effective if the address is of the wrong type
23857 (does not match the flags) or does not match the pattern.
23858 .next
23859 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23860 address, up to ten times. It can be combined with the &"q"& flag, to stop
23861 rewriting once it fails to match (after at least one successful rewrite).
23862 .next
23863 .cindex "rewriting" "whole addresses"
23864 When an address in a header is rewritten, the rewriting normally applies only
23865 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23866 left unchanged. For example, rewriting might change
23867 .code
23868 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23869 .endd
23870 into
23871 .code
23872 From: Ford Prefect <prefectf@hitch.fict.example>
23873 .endd
23874 .cindex "RFC 2047"
23875 Sometimes there is a need to replace the whole address item, and this can be
23876 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23877 causes an address in a header line to be rewritten, the entire address is
23878 replaced, not just the working part. The replacement must be a complete RFC
23879 2822 address, including the angle brackets if necessary. If text outside angle
23880 brackets contains a character whose value is greater than 126 or less than 32
23881 (except for tab), the text is encoded according to RFC 2047. The character set
23882 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23883
23884 When the &"w"& flag is set on a rule that causes an envelope address to be
23885 rewritten, all but the working part of the replacement address is discarded.
23886 .endlist
23887
23888
23889 .section "Rewriting examples" "SECID156"
23890 Here is an example of the two common rewriting paradigms:
23891 .code
23892 *@*.hitch.fict.example  $1@hitch.fict.example
23893 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23894                      {$value}fail}@hitch.fict.example bctfrF
23895 .endd
23896 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23897 the string expansion to fail if the lookup does not succeed. In this context it
23898 has the effect of leaving the original address unchanged, but Exim goes on to
23899 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23900 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23901 explicitly, which would cause the rewritten address to be the same as before,
23902 at the cost of a small bit of processing. Not supplying either of these is an
23903 error, since the rewritten address would then contain no local part.
23904
23905 The first example above replaces the domain with a superior, more general
23906 domain. This may not be desirable for certain local parts. If the rule
23907 .code
23908 root@*.hitch.fict.example  *
23909 .endd
23910 were inserted before the first rule, rewriting would be suppressed for the
23911 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23912
23913 Rewriting can be made conditional on a number of tests, by making use of
23914 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23915 messages that originate outside the local host:
23916 .code
23917 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23918                          {$1@hitch.fict.example}fail}"
23919 .endd
23920 The replacement string is quoted in this example because it contains white
23921 space.
23922
23923 .cindex "rewriting" "bang paths"
23924 .cindex "bang paths" "rewriting"
23925 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23926 an address it treats it as an unqualified local part which it qualifies with
23927 the local qualification domain (if the source of the message is local or if the
23928 remote host is permitted to send unqualified addresses). Rewriting can
23929 sometimes be used to handle simple bang paths with a fixed number of
23930 components. For example, the rule
23931 .code
23932 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23933 .endd
23934 rewrites a two-component bang path &'host.name!user'& as the domain address
23935 &'user@host.name'&. However, there is a security implication in using this as
23936 a global rewriting rule for envelope addresses. It can provide a backdoor
23937 method for using your system as a relay, because the incoming addresses appear
23938 to be local. If the bang path addresses are received via SMTP, it is safer to
23939 use the &"S"& flag to rewrite them as they are received, so that relay checking
23940 can be done on the rewritten addresses.
23941 .ecindex IIDaddrew
23942
23943
23944
23945
23946
23947 . ////////////////////////////////////////////////////////////////////////////
23948 . ////////////////////////////////////////////////////////////////////////////
23949
23950 .chapter "Retry configuration" "CHAPretry"
23951 .scindex IIDretconf1 "retry" "configuration, description of"
23952 .scindex IIDregconf2 "configuration file" "retry section"
23953 The &"retry"& section of the runtime configuration file contains a list of
23954 retry rules that control how often Exim tries to deliver messages that cannot
23955 be delivered at the first attempt. If there are no retry rules (the section is
23956 empty or not present), there are no retries. In this situation, temporary
23957 errors are treated as permanent. The default configuration contains a single,
23958 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23959 line option can be used to test which retry rule will be used for a given
23960 address, domain and error.
23961
23962 The most common cause of retries is temporary failure to deliver to a remote
23963 host because the host is down, or inaccessible because of a network problem.
23964 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23965 address) basis, not on a per-message basis. Thus, if one message has recently
23966 been delayed, delivery of a new message to the same host is not immediately
23967 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23968 log selector is set, the message
23969 .cindex "retry" "time not reached"
23970 &"retry time not reached"& is written to the main log whenever a delivery is
23971 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23972 the handling of errors during remote deliveries.
23973
23974 Retry processing applies to routing as well as to delivering, except as covered
23975 in the next paragraph. The retry rules do not distinguish between these
23976 actions. It is not possible, for example, to specify different behaviour for
23977 failures to route the domain &'snark.fict.example'& and failures to deliver to
23978 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23979 added complication, so did not implement it. However, although they share the
23980 same retry rule, the actual retry times for routing and transporting a given
23981 domain are maintained independently.
23982
23983 When a delivery is not part of a queue run (typically an immediate delivery on
23984 receipt of a message), the routers are always run, and local deliveries are
23985 always attempted, even if retry times are set for them. This makes for better
23986 behaviour if one particular message is causing problems (for example, causing
23987 quota overflow, or provoking an error in a filter file). If such a delivery
23988 suffers a temporary failure, the retry data is updated as normal, and
23989 subsequent delivery attempts from queue runs occur only when the retry time for
23990 the local address is reached.
23991
23992 .section "Changing retry rules" "SECID157"
23993 If you change the retry rules in your configuration, you should consider
23994 whether or not to delete the retry data that is stored in Exim's spool area in
23995 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23996 always safe; that is why they are called &"hints"&.
23997
23998 The hints retry data contains suggested retry times based on the previous
23999 rules. In the case of a long-running problem with a remote host, it might
24000 record the fact that the host has timed out. If your new rules increase the
24001 timeout time for such a host, you should definitely remove the old retry data
24002 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24003 messages that it should now be retaining.
24004
24005
24006
24007 .section "Format of retry rules" "SECID158"
24008 .cindex "retry" "rules"
24009 Each retry rule occupies one line and consists of three or four parts,
24010 separated by white space: a pattern, an error name, an optional list of sender
24011 addresses, and a list of retry parameters. The pattern and sender lists must be
24012 enclosed in double quotes if they contain white space. The rules are searched
24013 in order until one is found where the pattern, error name, and sender list (if
24014 present) match the failing host or address, the error that occurred, and the
24015 message's sender, respectively.
24016
24017
24018 The pattern is any single item that may appear in an address list (see section
24019 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24020 which means that it is expanded before being tested against the address that
24021 has been delayed. A negated address list item is permitted. Address
24022 list processing treats a plain domain name as if it were preceded by &"*@"&,
24023 which makes it possible for many retry rules to start with just a domain. For
24024 example,
24025 .code
24026 lookingglass.fict.example        *  F,24h,30m;
24027 .endd
24028 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24029 whereas
24030 .code
24031 alice@lookingglass.fict.example  *  F,24h,30m;
24032 .endd
24033 applies only to temporary failures involving the local part &%alice%&.
24034 In practice, almost all rules start with a domain name pattern without a local
24035 part.
24036
24037 .cindex "regular expressions" "in retry rules"
24038 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24039 must match a complete address, not just a domain, because that is how regular
24040 expressions work in address lists.
24041 .display
24042 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24043 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24044 .endd
24045
24046
24047 .section "Choosing which retry rule to use for address errors" "SECID159"
24048 When Exim is looking for a retry rule after a routing attempt has failed (for
24049 example, after a DNS timeout), each line in the retry configuration is tested
24050 against the complete address only if &%retry_use_local_part%& is set for the
24051 router. Otherwise, only the domain is used, except when matching against a
24052 regular expression, when the local part of the address is replaced with &"*"&.
24053 A domain on its own can match a domain pattern, or a pattern that starts with
24054 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24055 &%check_local_user%& is true, and false for other routers.
24056
24057 Similarly, when Exim is looking for a retry rule after a local delivery has
24058 failed (for example, after a mailbox full error), each line in the retry
24059 configuration is tested against the complete address only if
24060 &%retry_use_local_part%& is set for the transport (it defaults true for all
24061 local transports).
24062
24063 .cindex "4&'xx'& responses" "retry rules for"
24064 However, when Exim is looking for a retry rule after a remote delivery attempt
24065 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24066 whole address is always used as the key when searching the retry rules. The
24067 rule that is found is used to create a retry time for the combination of the
24068 failing address and the message's sender. It is the combination of sender and
24069 recipient that is delayed in subsequent queue runs until its retry time is
24070 reached. You can delay the recipient without regard to the sender by setting
24071 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24072 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24073 commands.
24074
24075
24076
24077 .section "Choosing which retry rule to use for host and message errors" &&&
24078          "SECID160"
24079 For a temporary error that is not related to an individual address (for
24080 example, a connection timeout), each line in the retry configuration is checked
24081 twice. First, the name of the remote host is used as a domain name (preceded by
24082 &"*@"& when matching a regular expression). If this does not match the line,
24083 the domain from the email address is tried in a similar fashion. For example,
24084 suppose the MX records for &'a.b.c.example'& are
24085 .code
24086 a.b.c.example  MX  5  x.y.z.example
24087                MX  6  p.q.r.example
24088                MX  7  m.n.o.example
24089 .endd
24090 and the retry rules are
24091 .code
24092 p.q.r.example    *      F,24h,30m;
24093 a.b.c.example    *      F,4d,45m;
24094 .endd
24095 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24096 first rule matches neither the host nor the domain, so Exim looks at the second
24097 rule. This does not match the host, but it does match the domain, so it is used
24098 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24099 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24100 first retry rule is used, because it matches the host.
24101
24102 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24103 first rule to determine retry times, but for all the other hosts for the domain
24104 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24105 routing to &'a.b.c.example'& suffers a temporary failure.
24106
24107 &*Note*&: The host name is used when matching the patterns, not its IP address.
24108 However, if a message is routed directly to an IP address without the use of a
24109 host name, for example, if a &(manualroute)& router contains a setting such as:
24110 .code
24111 route_list = *.a.example  192.168.34.23
24112 .endd
24113 then the &"host name"& that is used when searching for a retry rule is the
24114 textual form of the IP address.
24115
24116 .section "Retry rules for specific errors" "SECID161"
24117 .cindex "retry" "specific errors; specifying"
24118 The second field in a retry rule is the name of a particular error, or an
24119 asterisk, which matches any error. The errors that can be tested for are:
24120
24121 .vlist
24122 .vitem &%auth_failed%&
24123 Authentication failed when trying to send to a host in the
24124 &%hosts_require_auth%& list in an &(smtp)& transport.
24125
24126 .vitem &%data_4xx%&
24127 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24128 after the command, or after sending the message's data.
24129
24130 .vitem &%mail_4xx%&
24131 A 4&'xx'& error was received for an outgoing MAIL command.
24132
24133 .vitem &%rcpt_4xx%&
24134 A 4&'xx'& error was received for an outgoing RCPT command.
24135 .endlist
24136
24137 For the three 4&'xx'& errors, either the first or both of the x's can be given
24138 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24139 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24140 and have retries every ten minutes with a one-hour timeout, you could set up a
24141 retry rule of this form:
24142 .code
24143 the.domain.name  rcpt_452   F,1h,10m
24144 .endd
24145 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24146 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24147
24148 .vlist
24149 .vitem &%lost_connection%&
24150 A server unexpectedly closed the SMTP connection. There may, of course,
24151 legitimate reasons for this (host died, network died), but if it repeats a lot
24152 for the same host, it indicates something odd.
24153
24154 .vitem &%refused_MX%&
24155 A connection to a host obtained from an MX record was refused.
24156
24157 .vitem &%refused_A%&
24158 A connection to a host not obtained from an MX record was refused.
24159
24160 .vitem &%refused%&
24161 A connection was refused.
24162
24163 .vitem &%timeout_connect_MX%&
24164 A connection attempt to a host obtained from an MX record timed out.
24165
24166 .vitem &%timeout_connect_A%&
24167 A connection attempt to a host not obtained from an MX record timed out.
24168
24169 .vitem &%timeout_connect%&
24170 A connection attempt timed out.
24171
24172 .vitem &%timeout_MX%&
24173 There was a timeout while connecting or during an SMTP session with a host
24174 obtained from an MX record.
24175
24176 .vitem &%timeout_A%&
24177 There was a timeout while connecting or during an SMTP session with a host not
24178 obtained from an MX record.
24179
24180 .vitem &%timeout%&
24181 There was a timeout while connecting or during an SMTP session.
24182
24183 .vitem &%tls_required%&
24184 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24185 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24186 to STARTTLS, or there was a problem setting up the TLS connection.
24187
24188 .vitem &%quota%&
24189 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24190 transport.
24191
24192 .vitem &%quota_%&<&'time'&>
24193 .cindex "quota" "error testing in retry rule"
24194 .cindex "retry" "quota error testing"
24195 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24196 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24197 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24198 for four days.
24199 .endlist
24200
24201 .cindex "mailbox" "time of last read"
24202 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24203 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24204 it should be based on the last time that the user accessed the mailbox.
24205 However, it is not always possible to determine this. Exim uses the following
24206 heuristic rules:
24207
24208 .ilist
24209 If the mailbox is a single file, the time of last access (the &"atime"&) is
24210 used. As no new messages are being delivered (because the mailbox is over
24211 quota), Exim does not access the file, so this is the time of last user access.
24212 .next
24213 .cindex "maildir format" "time of last read"
24214 For a maildir delivery, the time of last modification of the &_new_&
24215 subdirectory is used. As the mailbox is over quota, no new files are created in
24216 the &_new_& subdirectory, because no new messages are being delivered. Any
24217 change to the &_new_& subdirectory is therefore assumed to be the result of an
24218 MUA moving a new message to the &_cur_& directory when it is first read. The
24219 time that is used is therefore the last time that the user read a new message.
24220 .next
24221 For other kinds of multi-file mailbox, the time of last access cannot be
24222 obtained, so a retry rule that uses this type of error field is never matched.
24223 .endlist
24224
24225 The quota errors apply both to system-enforced quotas and to Exim's own quota
24226 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24227 when a local delivery is deferred because a partition is full (the ENOSPC
24228 error).
24229
24230
24231
24232 .section "Retry rules for specified senders" "SECID162"
24233 .cindex "retry" "rules; sender-specific"
24234 You can specify retry rules that apply only when the failing message has a
24235 specific sender. In particular, this can be used to define retry rules that
24236 apply only to bounce messages. The third item in a retry rule can be of this
24237 form:
24238 .display
24239 &`senders=`&<&'address list'&>
24240 .endd
24241 The retry timings themselves are then the fourth item. For example:
24242 .code
24243 *   rcpt_4xx   senders=:   F,1h,30m
24244 .endd
24245 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24246 host. If the address list contains white space, it must be enclosed in quotes.
24247 For example:
24248 .code
24249 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24250 .endd
24251 &*Warning*&: This facility can be unhelpful if it is used for host errors
24252 (which do not depend on the recipient). The reason is that the sender is used
24253 only to match the retry rule. Once the rule has been found for a host error,
24254 its contents are used to set a retry time for the host, and this will apply to
24255 all messages, not just those with specific senders.
24256
24257 When testing retry rules using &%-brt%&, you can supply a sender using the
24258 &%-f%& command line option, like this:
24259 .code
24260 exim -f "" -brt user@dom.ain
24261 .endd
24262 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24263 list is never matched.
24264
24265
24266
24267
24268
24269 .section "Retry parameters" "SECID163"
24270 .cindex "retry" "parameters in rules"
24271 The third (or fourth, if a senders list is present) field in a retry rule is a
24272 sequence of retry parameter sets, separated by semicolons. Each set consists of
24273 .display
24274 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24275 .endd
24276 The letter identifies the algorithm for computing a new retry time; the cutoff
24277 time is the time beyond which this algorithm no longer applies, and the
24278 arguments vary the algorithm's action. The cutoff time is measured from the
24279 time that the first failure for the domain (combined with the local part if
24280 relevant) was detected, not from the time the message was received.
24281
24282 .cindex "retry" "algorithms"
24283 .cindex "retry" "fixed intervals"
24284 .cindex "retry" "increasing intervals"
24285 .cindex "retry" "random intervals"
24286 The available algorithms are:
24287
24288 .ilist
24289 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24290 the interval.
24291 .next
24292 &'G'&: retry at geometrically increasing intervals. The first argument
24293 specifies a starting value for the interval, and the second a multiplier, which
24294 is used to increase the size of the interval at each retry.
24295 .next
24296 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24297 retry, the previous interval is multiplied by the factor in order to get a
24298 maximum for the next interval. The minimum interval is the first argument of
24299 the parameter, and an actual interval is chosen randomly between them. Such a
24300 rule has been found to be helpful in cluster configurations when all the
24301 members of the cluster restart at once, and may therefore synchronize their
24302 queue processing times.
24303 .endlist
24304
24305 When computing the next retry time, the algorithm definitions are scanned in
24306 order until one whose cutoff time has not yet passed is reached. This is then
24307 used to compute a new retry time that is later than the current time. In the
24308 case of fixed interval retries, this simply means adding the interval to the
24309 current time. For geometrically increasing intervals, retry intervals are
24310 computed from the rule's parameters until one that is greater than the previous
24311 interval is found. The main configuration variable
24312 .cindex "limit" "retry interval"
24313 .cindex "retry" "interval, maximum"
24314 .oindex "&%retry_interval_max%&"
24315 &%retry_interval_max%& limits the maximum interval between retries. It
24316 cannot be set greater than &`24h`&, which is its default value.
24317
24318 A single remote domain may have a number of hosts associated with it, and each
24319 host may have more than one IP address. Retry algorithms are selected on the
24320 basis of the domain name, but are applied to each IP address independently. If,
24321 for example, a host has two IP addresses and one is unusable, Exim will
24322 generate retry times for it and will not try to use it until its next retry
24323 time comes. Thus the good IP address is likely to be tried first most of the
24324 time.
24325
24326 .cindex "hints database" "use for retrying"
24327 Retry times are hints rather than promises. Exim does not make any attempt to
24328 run deliveries exactly at the computed times. Instead, a queue runner process
24329 starts delivery processes for delayed messages periodically, and these attempt
24330 new deliveries only for those addresses that have passed their next retry time.
24331 If a new message arrives for a deferred address, an immediate delivery attempt
24332 occurs only if the address has passed its retry time. In the absence of new
24333 messages, the minimum time between retries is the interval between queue runner
24334 processes. There is not much point in setting retry times of five minutes if
24335 your queue runners happen only once an hour, unless there are a significant
24336 number of incoming messages (which might be the case on a system that is
24337 sending everything to a smart host, for example).
24338
24339 The data in the retry hints database can be inspected by using the
24340 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24341 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24342 &'exinext'& utility script can be used to find out what the next retry times
24343 are for the hosts associated with a particular mail domain, and also for local
24344 deliveries that have been deferred.
24345
24346
24347 .section "Retry rule examples" "SECID164"
24348 Here are some example retry rules:
24349 .code
24350 alice@wonderland.fict.example quota_5d  F,7d,3h
24351 wonderland.fict.example       quota_5d
24352 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24353 lookingglass.fict.example     *         F,24h,30m;
24354 *                 refused_A   F,2h,20m;
24355 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24356 .endd
24357 The first rule sets up special handling for mail to
24358 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24359 mailbox has not been read for at least 5 days. Retries continue every three
24360 hours for 7 days. The second rule handles over-quota errors for all other local
24361 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24362 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24363 fail are bounced immediately if the mailbox has not been read for at least 5
24364 days.
24365
24366 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24367 happen every 15 minutes for an hour, then with geometrically increasing
24368 intervals until two days have passed since a delivery first failed. After the
24369 first hour there is a delay of one hour, then two hours, then four hours, and
24370 so on (this is a rather extreme example).
24371
24372 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24373 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24374 all other domains, with special action for connection refusal from hosts that
24375 were not obtained from an MX record.
24376
24377 The final rule in a retry configuration should always have asterisks in the
24378 first two fields so as to provide a general catch-all for any addresses that do
24379 not have their own special handling. This example tries every 15 minutes for 2
24380 hours, then with intervals starting at one hour and increasing by a factor of
24381 1.5 up to 16 hours, then every 8 hours up to 5 days.
24382
24383
24384
24385 .section "Timeout of retry data" "SECID165"
24386 .cindex "timeout" "of retry data"
24387 .oindex "&%retry_data_expire%&"
24388 .cindex "hints database" "data expiry"
24389 .cindex "retry" "timeout of data"
24390 Exim timestamps the data that it writes to its retry hints database. When it
24391 consults the data during a delivery it ignores any that is older than the value
24392 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24393 been tried for 7 days, Exim will try to deliver to it immediately a message
24394 arrives, and if that fails, it will calculate a retry time as if it were
24395 failing for the first time.
24396
24397 This improves the behaviour for messages routed to rarely-used hosts such as MX
24398 backups. If such a host was down at one time, and happens to be down again when
24399 Exim tries a month later, using the old retry data would imply that it had been
24400 down all the time, which is not a justified assumption.
24401
24402 If a host really is permanently dead, this behaviour causes a burst of retries
24403 every now and again, but only if messages routed to it are rare. If there is a
24404 message at least once every 7 days the retry data never expires.
24405
24406
24407
24408
24409 .section "Long-term failures" "SECID166"
24410 .cindex "delivery failure, long-term"
24411 .cindex "retry" "after long-term failure"
24412 Special processing happens when an email address has been failing for so long
24413 that the cutoff time for the last algorithm is reached. For example, using the
24414 default retry rule:
24415 .code
24416 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24417 .endd
24418 the cutoff time is four days. Reaching the retry cutoff is independent of how
24419 long any specific message has been failing; it is the length of continuous
24420 failure for the recipient address that counts.
24421
24422 When the cutoff time is reached for a local delivery, or for all the IP
24423 addresses associated with a remote delivery, a subsequent delivery failure
24424 causes Exim to give up on the address, and a bounce message is generated.
24425 In order to cater for new messages that use the failing address, a next retry
24426 time is still computed from the final algorithm, and is used as follows:
24427
24428 For local deliveries, one delivery attempt is always made for any subsequent
24429 messages. If this delivery fails, the address fails immediately. The
24430 post-cutoff retry time is not used.
24431
24432 If the delivery is remote, there are two possibilities, controlled by the
24433 .oindex "&%delay_after_cutoff%&"
24434 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24435 default. Until the post-cutoff retry time for one of the IP addresses is
24436 reached, the failing email address is bounced immediately, without a delivery
24437 attempt taking place. After that time, one new delivery attempt is made to
24438 those IP addresses that are past their retry times, and if that still fails,
24439 the address is bounced and new retry times are computed.
24440
24441 In other words, when all the hosts for a given email address have been failing
24442 for a long time, Exim bounces rather then defers until one of the hosts' retry
24443 times is reached. Then it tries once, and bounces if that attempt fails. This
24444 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24445 to a broken destination, but if the host does recover, Exim will eventually
24446 notice.
24447
24448 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24449 addresses are past their final cutoff time, Exim tries to deliver to those IP
24450 addresses that have not been tried since the message arrived. If there are
24451 no suitable IP addresses, or if they all fail, the address is bounced. In other
24452 words, it does not delay when a new message arrives, but tries the expired
24453 addresses immediately, unless they have been tried since the message arrived.
24454 If there is a continuous stream of messages for the failing domains, setting
24455 &%delay_after_cutoff%& false means that there will be many more attempts to
24456 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24457 true.
24458
24459 .section "Deliveries that work intermittently" "SECID167"
24460 .cindex "retry" "intermittently working deliveries"
24461 Some additional logic is needed to cope with cases where a host is
24462 intermittently available, or when a message has some attribute that prevents
24463 its delivery when others to the same address get through. In this situation,
24464 because some messages are successfully delivered, the &"retry clock"& for the
24465 host or address keeps getting reset by the successful deliveries, and so
24466 failing messages remain on the queue for ever because the cutoff time is never
24467 reached.
24468
24469 Two exceptional actions are applied to prevent this happening. The first
24470 applies to errors that are related to a message rather than a remote host.
24471 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24472 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24473 commands, and quota failures. For this type of error, if a message's arrival
24474 time is earlier than the &"first failed"& time for the error, the earlier time
24475 is used when scanning the retry rules to decide when to try next and when to
24476 time out the address.
24477
24478 The exceptional second action applies in all cases. If a message has been on
24479 the queue for longer than the cutoff time of any applicable retry rule for a
24480 given address, a delivery is attempted for that address, even if it is not yet
24481 time, and if this delivery fails, the address is timed out. A new retry time is
24482 not computed in this case, so that other messages for the same address are
24483 considered immediately.
24484 .ecindex IIDretconf1
24485 .ecindex IIDregconf2
24486
24487
24488
24489
24490
24491
24492 . ////////////////////////////////////////////////////////////////////////////
24493 . ////////////////////////////////////////////////////////////////////////////
24494
24495 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24496 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24497 .scindex IIDauthconf2 "authentication"
24498 The &"authenticators"& section of Exim's run time configuration is concerned
24499 with SMTP authentication. This facility is an extension to the SMTP protocol,
24500 described in RFC 2554, which allows a client SMTP host to authenticate itself
24501 to a server. This is a common way for a server to recognize clients that are
24502 permitted to use it as a relay. SMTP authentication is not of relevance to the
24503 transfer of mail between servers that have no managerial connection with each
24504 other.
24505
24506 .cindex "AUTH" "description of"
24507 Very briefly, the way SMTP authentication works is as follows:
24508
24509 .ilist
24510 The server advertises a number of authentication &'mechanisms'& in response to
24511 the client's EHLO command.
24512 .next
24513 The client issues an AUTH command, naming a specific mechanism. The command
24514 may, optionally, contain some authentication data.
24515 .next
24516 The server may issue one or more &'challenges'&, to which the client must send
24517 appropriate responses. In simple authentication mechanisms, the challenges are
24518 just prompts for user names and passwords. The server does not have to issue
24519 any challenges &-- in some mechanisms the relevant data may all be transmitted
24520 with the AUTH command.
24521 .next
24522 The server either accepts or denies authentication.
24523 .next
24524 If authentication succeeds, the client may optionally make use of the AUTH
24525 option on the MAIL command to pass an authenticated sender in subsequent
24526 mail transactions. Authentication lasts for the remainder of the SMTP
24527 connection.
24528 .next
24529 If authentication fails, the client may give up, or it may try a different
24530 authentication mechanism, or it may try transferring mail over the
24531 unauthenticated connection.
24532 .endlist
24533
24534 If you are setting up a client, and want to know which authentication
24535 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24536 SMTP port) on the server, and issue an EHLO command. The response to this
24537 includes the list of supported mechanisms. For example:
24538 .display
24539 &`$ `&&*&`telnet server.example 25`&*&
24540 &`Trying 192.168.34.25...`&
24541 &`Connected to server.example.`&
24542 &`Escape character is &#x0027;^]&#x0027;.`&
24543 &`220 server.example ESMTP Exim 4.20 ...`&
24544 &*&`ehlo client.example`&*&
24545 &`250-server.example Hello client.example [10.8.4.5]`&
24546 &`250-SIZE 52428800`&
24547 &`250-PIPELINING`&
24548 &`250-AUTH PLAIN`&
24549 &`250 HELP`&
24550 .endd
24551 The second-last line of this example output shows that the server supports
24552 authentication using the PLAIN mechanism. In Exim, the different authentication
24553 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24554 routers and transports, which authenticators are included in the binary is
24555 controlled by build-time definitions. The following are currently available,
24556 included by setting
24557 .code
24558 AUTH_CRAM_MD5=yes
24559 AUTH_CYRUS_SASL=yes
24560 AUTH_DOVECOT=yes
24561 AUTH_GSASL=yes
24562 AUTH_HEIMDAL_GSSAPI=yes
24563 AUTH_PLAINTEXT=yes
24564 AUTH_SPA=yes
24565 .endd
24566 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24567 authentication mechanism (RFC 2195), and the second provides an interface to
24568 the Cyrus SASL authentication library.
24569 The third is an interface to Dovecot's authentication system, delegating the
24570 work via a socket interface.
24571 The fourth provides an interface to the GNU SASL authentication library, which
24572 provides mechanisms but typically not data sources.
24573 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24574 supporting setting a server keytab.
24575 The sixth can be configured to support
24576 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24577 not formally documented, but used by several MUAs. The seventh authenticator
24578 supports Microsoft's &'Secure Password Authentication'& mechanism.
24579
24580 The authenticators are configured using the same syntax as other drivers (see
24581 section &<<SECTfordricon>>&). If no authenticators are required, no
24582 authentication section need be present in the configuration file. Each
24583 authenticator can in principle have both server and client functions. When Exim
24584 is receiving SMTP mail, it is acting as a server; when it is sending out
24585 messages over SMTP, it is acting as a client. Authenticator configuration
24586 options are provided for use in both these circumstances.
24587
24588 To make it clear which options apply to which situation, the prefixes
24589 &%server_%& and &%client_%& are used on option names that are specific to
24590 either the server or the client function, respectively. Server and client
24591 functions are disabled if none of their options are set. If an authenticator is
24592 to be used for both server and client functions, a single definition, using
24593 both sets of options, is required. For example:
24594 .code
24595 cram:
24596   driver = cram_md5
24597   public_name = CRAM-MD5
24598   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24599   client_name = ph10
24600   client_secret = secret2
24601 .endd
24602 The &%server_%& option is used when Exim is acting as a server, and the
24603 &%client_%& options when it is acting as a client.
24604
24605 Descriptions of the individual authenticators are given in subsequent chapters.
24606 The remainder of this chapter covers the generic options for the
24607 authenticators, followed by general discussion of the way authentication works
24608 in Exim.
24609
24610 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24611 per-mechanism basis.  Please read carefully to determine which variables hold
24612 account labels such as usercodes and which hold passwords or other
24613 authenticating data.
24614
24615 Note that some mechanisms support two different identifiers for accounts: the
24616 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24617 and &'authz'& are commonly encountered.  The American spelling is standard here.
24618 Conceptually, authentication data such as passwords are tied to the identifier
24619 used to authenticate; servers may have rules to permit one user to act as a
24620 second user, so that after login the session is treated as though that second
24621 user had logged in.  That second user is the &'authorization id'&.  A robust
24622 configuration might confirm that the &'authz'& field is empty or matches the
24623 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24624 as verified data, the &'authz'& as an unverified request which the server might
24625 choose to honour.
24626
24627 A &'realm'& is a text string, typically a domain name, presented by a server
24628 to a client to help it select an account and credentials to use.  In some
24629 mechanisms, the client and server provably agree on the realm, but clients
24630 typically can not treat the realm as secure data to be blindly trusted.
24631
24632
24633
24634 .section "Generic options for authenticators" "SECID168"
24635 .cindex "authentication" "generic options"
24636 .cindex "options" "generic; for authenticators"
24637
24638 .option client_condition authenticators string&!! unset
24639 When Exim is authenticating as a client, it skips any authenticator whose
24640 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24641 used, for example, to skip plain text authenticators when the connection is not
24642 encrypted by a setting such as:
24643 .code
24644 client_condition = ${if !eq{$tls_out_cipher}{}}
24645 .endd
24646
24647
24648 .option client_set_id authenticators string&!! unset
24649 When client authentication succeeds, this condition is expanded; the
24650 result is used in the log lines for outbound messasges.
24651 Typically it will be the user name used for authentication.
24652
24653
24654 .option driver authenticators string unset
24655 This option must always be set. It specifies which of the available
24656 authenticators is to be used.
24657
24658
24659 .option public_name authenticators string unset
24660 This option specifies the name of the authentication mechanism that the driver
24661 implements, and by which it is known to the outside world. These names should
24662 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24663 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24664 defaults to the driver's instance name.
24665
24666
24667 .option server_advertise_condition authenticators string&!! unset
24668 When a server is about to advertise an authentication mechanism, the condition
24669 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24670 mechanism is not advertised.
24671 If the expansion fails, the mechanism is not advertised. If the failure was not
24672 forced, and was not caused by a lookup defer, the incident is logged.
24673 See section &<<SECTauthexiser>>& below for further discussion.
24674
24675
24676 .option server_condition authenticators string&!! unset
24677 This option must be set for a &%plaintext%& server authenticator, where it
24678 is used directly to control authentication. See section &<<SECTplainserver>>&
24679 for details.
24680
24681 For the &(gsasl)& authenticator, this option is required for various
24682 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24683
24684 For the other authenticators, &%server_condition%& can be used as an additional
24685 authentication or authorization mechanism that is applied after the other
24686 authenticator conditions succeed. If it is set, it is expanded when the
24687 authenticator would otherwise return a success code. If the expansion is forced
24688 to fail, authentication fails. Any other expansion failure causes a temporary
24689 error code to be returned. If the result of a successful expansion is an empty
24690 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24691 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24692 other result, a temporary error code is returned, with the expanded string as
24693 the error text.
24694
24695
24696 .option server_debug_print authenticators string&!! unset
24697 If this option is set and authentication debugging is enabled (see the &%-d%&
24698 command line option), the string is expanded and included in the debugging
24699 output when the authenticator is run as a server. This can help with checking
24700 out the values of variables.
24701 If expansion of the string fails, the error message is written to the debugging
24702 output, and Exim carries on processing.
24703
24704
24705 .option server_set_id authenticators string&!! unset
24706 .vindex "&$authenticated_id$&"
24707 When an Exim server successfully authenticates a client, this string is
24708 expanded using data from the authentication, and preserved for any incoming
24709 messages in the variable &$authenticated_id$&. It is also included in the log
24710 lines for incoming messages. For example, a user/password authenticator
24711 configuration might preserve the user name that was used to authenticate, and
24712 refer to it subsequently during delivery of the message.
24713 If expansion fails, the option is ignored.
24714
24715
24716 .option server_mail_auth_condition authenticators string&!! unset
24717 This option allows a server to discard authenticated sender addresses supplied
24718 as part of MAIL commands in SMTP connections that are authenticated by the
24719 driver on which &%server_mail_auth_condition%& is set. The option is not used
24720 as part of the authentication process; instead its (unexpanded) value is
24721 remembered for later use.
24722 How it is used is described in the following section.
24723
24724
24725
24726
24727
24728 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24729 .cindex "authentication" "sender; authenticated"
24730 .cindex "AUTH" "on MAIL command"
24731 When a client supplied an AUTH= item on a MAIL command, Exim applies
24732 the following checks before accepting it as the authenticated sender of the
24733 message:
24734
24735 .ilist
24736 If the connection is not using extended SMTP (that is, HELO was used rather
24737 than EHLO), the use of AUTH= is a syntax error.
24738 .next
24739 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24740 .next
24741 .vindex "&$authenticated_sender$&"
24742 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24743 running, the value of &$authenticated_sender$& is set to the value obtained
24744 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24745 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24746 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24747 given for the MAIL command.
24748 .next
24749 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24750 is accepted and placed in &$authenticated_sender$& only if the client has
24751 authenticated.
24752 .next
24753 If the AUTH= value was accepted by either of the two previous rules, and
24754 the client has authenticated, and the authenticator has a setting for the
24755 &%server_mail_auth_condition%&, the condition is checked at this point. The
24756 valued that was saved from the authenticator is expanded. If the expansion
24757 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24758 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24759 the value of &$authenticated_sender$& is retained and passed on with the
24760 message.
24761 .endlist
24762
24763
24764 When &$authenticated_sender$& is set for a message, it is passed on to other
24765 hosts to which Exim authenticates as a client. Do not confuse this value with
24766 &$authenticated_id$&, which is a string obtained from the authentication
24767 process, and which is not usually a complete email address.
24768
24769 .vindex "&$sender_address$&"
24770 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24771 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24772 therefore make use of &$authenticated_sender$&. The converse is not true: the
24773 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24774 ACL is run.
24775
24776
24777
24778 .section "Authentication on an Exim server" "SECTauthexiser"
24779 .cindex "authentication" "on an Exim server"
24780 When Exim receives an EHLO command, it advertises the public names of those
24781 authenticators that are configured as servers, subject to the following
24782 conditions:
24783
24784 .ilist
24785 The client host must match &%auth_advertise_hosts%& (default *).
24786 .next
24787 It the &%server_advertise_condition%& option is set, its expansion must not
24788 yield the empty string, &"0"&, &"no"&, or &"false"&.
24789 .endlist
24790
24791 The order in which the authenticators are defined controls the order in which
24792 the mechanisms are advertised.
24793
24794 Some mail clients (for example, some versions of Netscape) require the user to
24795 provide a name and password for authentication whenever AUTH is advertised,
24796 even though authentication may not in fact be needed (for example, Exim may be
24797 set up to allow unconditional relaying from the client by an IP address check).
24798 You can make such clients more friendly by not advertising AUTH to them.
24799 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24800 that runs for RCPT) to relay without authentication, you should set
24801 .code
24802 auth_advertise_hosts = ! 10.9.8.0/24
24803 .endd
24804 so that no authentication mechanisms are advertised to them.
24805
24806 The &%server_advertise_condition%& controls the advertisement of individual
24807 authentication mechanisms. For example, it can be used to restrict the
24808 advertisement of a particular mechanism to encrypted connections, by a setting
24809 such as:
24810 .code
24811 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24812 .endd
24813 .vindex "&$tls_in_cipher$&"
24814 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24815 yields &"yes"&, which allows the advertisement to happen.
24816
24817 When an Exim server receives an AUTH command from a client, it rejects it
24818 immediately if AUTH was not advertised in response to an earlier EHLO
24819 command. This is the case if
24820
24821 .ilist
24822 The client host does not match &%auth_advertise_hosts%&; or
24823 .next
24824 No authenticators are configured with server options; or
24825 .next
24826 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24827 server authenticators.
24828 .endlist
24829
24830
24831 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24832 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24833 AUTH is accepted from any client host.
24834
24835 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24836 server authentication mechanism that was advertised in response to EHLO and
24837 that matches the one named in the AUTH command. If it finds one, it runs
24838 the appropriate authentication protocol, and authentication either succeeds or
24839 fails. If there is no matching advertised mechanism, the AUTH command is
24840 rejected with a 504 error.
24841
24842 .vindex "&$received_protocol$&"
24843 .vindex "&$sender_host_authenticated$&"
24844 When a message is received from an authenticated host, the value of
24845 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24846 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24847 public name) of the authenticator driver that successfully authenticated the
24848 client from which the message was received. This variable is empty if there was
24849 no successful authentication.
24850
24851
24852
24853
24854 .section "Testing server authentication" "SECID169"
24855 .cindex "authentication" "testing a server"
24856 .cindex "AUTH" "testing a server"
24857 .cindex "base64 encoding" "creating authentication test data"
24858 Exim's &%-bh%& option can be useful for testing server authentication
24859 configurations. The data for the AUTH command has to be sent using base64
24860 encoding. A quick way to produce such data for testing is the following Perl
24861 script:
24862 .code
24863 use MIME::Base64;
24864 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24865 .endd
24866 .cindex "binary zero" "in authentication data"
24867 This interprets its argument as a Perl string, and then encodes it. The
24868 interpretation as a Perl string allows binary zeros, which are required for
24869 some kinds of authentication, to be included in the data. For example, a
24870 command line to run this script on such data might be
24871 .code
24872 encode '\0user\0password'
24873 .endd
24874 Note the use of single quotes to prevent the shell interpreting the
24875 backslashes, so that they can be interpreted by Perl to specify characters
24876 whose code value is zero.
24877
24878 &*Warning 1*&: If either of the user or password strings starts with an octal
24879 digit, you must use three zeros instead of one after the leading backslash. If
24880 you do not, the octal digit that starts your string will be incorrectly
24881 interpreted as part of the code for the first character.
24882
24883 &*Warning 2*&: If there are characters in the strings that Perl interprets
24884 specially, you must use a Perl escape to prevent them being misinterpreted. For
24885 example, a command such as
24886 .code
24887 encode '\0user@domain.com\0pas$$word'
24888 .endd
24889 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24890
24891 If you have the &%mimencode%& command installed, another way to do produce
24892 base64-encoded strings is to run the command
24893 .code
24894 echo -e -n `\0user\0password' | mimencode
24895 .endd
24896 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24897 in the argument, and the &%-n%& option specifies no newline at the end of its
24898 output. However, not all versions of &%echo%& recognize these options, so you
24899 should check your version before relying on this suggestion.
24900
24901
24902
24903 .section "Authentication by an Exim client" "SECID170"
24904 .cindex "authentication" "on an Exim client"
24905 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24906 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24907 announces support for authentication, and the host matches an entry in either
24908 of these options, Exim (as a client) tries to authenticate as follows:
24909
24910 .ilist
24911 For each authenticator that is configured as a client, in the order in which
24912 they are defined in the configuration, it searches the authentication
24913 mechanisms announced by the server for one whose name matches the public name
24914 of the authenticator.
24915 .next
24916 .vindex "&$host$&"
24917 .vindex "&$host_address$&"
24918 When it finds one that matches, it runs the authenticator's client code. The
24919 variables &$host$& and &$host_address$& are available for any string expansions
24920 that the client might do. They are set to the server's name and IP address. If
24921 any expansion is forced to fail, the authentication attempt is abandoned, and
24922 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24923 delivery to be deferred.
24924 .next
24925 If the result of the authentication attempt is a temporary error or a timeout,
24926 Exim abandons trying to send the message to the host for the moment. It will
24927 try again later. If there are any backup hosts available, they are tried in the
24928 usual way.
24929 .next
24930 If the response to authentication is a permanent error (5&'xx'& code), Exim
24931 carries on searching the list of authenticators and tries another one if
24932 possible. If all authentication attempts give permanent errors, or if there are
24933 no attempts because no mechanisms match (or option expansions force failure),
24934 what happens depends on whether the host matches &%hosts_require_auth%& or
24935 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24936 delivery is deferred. The error can be detected in the retry rules, and thereby
24937 turned into a permanent error if you wish. In the second case, Exim tries to
24938 deliver the message unauthenticated.
24939 .endlist
24940
24941 .cindex "AUTH" "on MAIL command"
24942 When Exim has authenticated itself to a remote server, it adds the AUTH
24943 parameter to the MAIL commands it sends, if it has an authenticated sender for
24944 the message. If the message came from a remote host, the authenticated sender
24945 is the one that was receiving on an incoming MAIL command, provided that the
24946 incoming connection was authenticated and the &%server_mail_auth%& condition
24947 allowed the authenticated sender to be retained. If a local process calls Exim
24948 to send a message, the sender address that is built from the login name and
24949 &%qualify_domain%& is treated as authenticated. However, if the
24950 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24951 the authenticated sender that was received with the message.
24952 .ecindex IIDauthconf1
24953 .ecindex IIDauthconf2
24954
24955
24956
24957
24958
24959
24960 . ////////////////////////////////////////////////////////////////////////////
24961 . ////////////////////////////////////////////////////////////////////////////
24962
24963 .chapter "The plaintext authenticator" "CHAPplaintext"
24964 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24965 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24966 The &(plaintext)& authenticator can be configured to support the PLAIN and
24967 LOGIN authentication mechanisms, both of which transfer authentication data as
24968 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24969 security risk; you are strongly advised to insist on the use of SMTP encryption
24970 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24971 use unencrypted plain text, you should not use the same passwords for SMTP
24972 connections as you do for login accounts.
24973
24974 .section "Plaintext options" "SECID171"
24975 .cindex "options" "&(plaintext)& authenticator (server)"
24976 When configured as a server, &(plaintext)& uses the following options:
24977
24978 .option server_condition authenticators string&!! unset
24979 This is actually a global authentication option, but it must be set in order to
24980 configure the &(plaintext)& driver as a server. Its use is described below.
24981
24982 .option server_prompts plaintext string&!! unset
24983 The contents of this option, after expansion, must be a colon-separated list of
24984 prompt strings. If expansion fails, a temporary authentication rejection is
24985 given.
24986
24987 .section "Using plaintext in a server" "SECTplainserver"
24988 .cindex "AUTH" "in &(plaintext)& authenticator"
24989 .cindex "binary zero" "in &(plaintext)& authenticator"
24990 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24991         "in &(plaintext)& authenticator"
24992 .vindex "&$auth1$&, &$auth2$&, etc"
24993 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24994
24995 When running as a server, &(plaintext)& performs the authentication test by
24996 expanding a string. The data sent by the client with the AUTH command, or in
24997 response to subsequent prompts, is base64 encoded, and so may contain any byte
24998 values when decoded. If any data is supplied with the command, it is treated as
24999 a list of strings, separated by NULs (binary zeros), the first three of which
25000 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25001 (neither LOGIN nor PLAIN uses more than three strings).
25002
25003 For compatibility with previous releases of Exim, the values are also placed in
25004 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25005 variables for this purpose is now deprecated, as it can lead to confusion in
25006 string expansions that also use them for other things.
25007
25008 If there are more strings in &%server_prompts%& than the number of strings
25009 supplied with the AUTH command, the remaining prompts are used to obtain more
25010 data. Each response from the client may be a list of NUL-separated strings.
25011
25012 .vindex "&$authenticated_id$&"
25013 Once a sufficient number of data strings have been received,
25014 &%server_condition%& is expanded. If the expansion is forced to fail,
25015 authentication fails. Any other expansion failure causes a temporary error code
25016 to be returned. If the result of a successful expansion is an empty string,
25017 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25018 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25019 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25020 For any other result, a temporary error code is returned, with the expanded
25021 string as the error text
25022
25023 &*Warning*&: If you use a lookup in the expansion to find the user's
25024 password, be sure to make the authentication fail if the user is unknown.
25025 There are good and bad examples at the end of the next section.
25026
25027
25028
25029 .section "The PLAIN authentication mechanism" "SECID172"
25030 .cindex "PLAIN authentication mechanism"
25031 .cindex "authentication" "PLAIN mechanism"
25032 .cindex "binary zero" "in &(plaintext)& authenticator"
25033 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25034 sent as one item of data (that is, one combined string containing two NUL
25035 separators). The data is sent either as part of the AUTH command, or
25036 subsequently in response to an empty prompt from the server.
25037
25038 The second and third strings are a user name and a corresponding password.
25039 Using a single fixed user name and password as an example, this could be
25040 configured as follows:
25041 .code
25042 fixed_plain:
25043   driver = plaintext
25044   public_name = PLAIN
25045   server_prompts = :
25046   server_condition = \
25047     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25048   server_set_id = $auth2
25049 .endd
25050 Note that the default result strings from &%if%& (&"true"& or an empty string)
25051 are exactly what we want here, so they need not be specified. Obviously, if the
25052 password contains expansion-significant characters such as dollar, backslash,
25053 or closing brace, they have to be escaped.
25054
25055 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25056 the end of a string list are ignored). If all the data comes as part of the
25057 AUTH command, as is commonly the case, the prompt is not used. This
25058 authenticator is advertised in the response to EHLO as
25059 .code
25060 250-AUTH PLAIN
25061 .endd
25062 and a client host can authenticate itself by sending the command
25063 .code
25064 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25065 .endd
25066 As this contains three strings (more than the number of prompts), no further
25067 data is required from the client. Alternatively, the client may just send
25068 .code
25069 AUTH PLAIN
25070 .endd
25071 to initiate authentication, in which case the server replies with an empty
25072 prompt. The client must respond with the combined data string.
25073
25074 The data string is base64 encoded, as required by the RFC. This example,
25075 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25076 represents a zero byte. This is split up into three strings, the first of which
25077 is empty. The &%server_condition%& option in the authenticator checks that the
25078 second two are &`username`& and &`mysecret`& respectively.
25079
25080 Having just one fixed user name and password, as in this example, is not very
25081 realistic, though for a small organization with only a handful of
25082 authenticating clients it could make sense.
25083
25084 A more sophisticated instance of this authenticator could use the user name in
25085 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25086 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25087 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25088 This is an incorrect example:
25089 .code
25090 server_condition = \
25091   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25092 .endd
25093 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25094 which it then compares to the supplied password (&$auth3$&). Why is this example
25095 incorrect? It works fine for existing users, but consider what happens if a
25096 non-existent user name is given. The lookup fails, but as no success/failure
25097 strings are given for the lookup, it yields an empty string. Thus, to defeat
25098 the authentication, all a client has to do is to supply a non-existent user
25099 name and an empty password. The correct way of writing this test is:
25100 .code
25101 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25102   {${if eq{$value}{$auth3}}} {false}}
25103 .endd
25104 In this case, if the lookup succeeds, the result is checked; if the lookup
25105 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25106 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25107 always fails if its second argument is empty. However, the second way of
25108 writing the test makes the logic clearer.
25109
25110
25111 .section "The LOGIN authentication mechanism" "SECID173"
25112 .cindex "LOGIN authentication mechanism"
25113 .cindex "authentication" "LOGIN mechanism"
25114 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25115 in a number of programs. No data is sent with the AUTH command. Instead, a
25116 user name and password are supplied separately, in response to prompts. The
25117 plaintext authenticator can be configured to support this as in this example:
25118 .code
25119 fixed_login:
25120   driver = plaintext
25121   public_name = LOGIN
25122   server_prompts = User Name : Password
25123   server_condition = \
25124     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25125   server_set_id = $auth1
25126 .endd
25127 Because of the way plaintext operates, this authenticator accepts data supplied
25128 with the AUTH command (in contravention of the specification of LOGIN), but
25129 if the client does not supply it (as is the case for LOGIN clients), the prompt
25130 strings are used to obtain two data items.
25131
25132 Some clients are very particular about the precise text of the prompts. For
25133 example, Outlook Express is reported to recognize only &"Username:"& and
25134 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25135 strings. It uses the &%ldapauth%& expansion condition to check the user
25136 name and password by binding to an LDAP server:
25137 .code
25138 login:
25139   driver = plaintext
25140   public_name = LOGIN
25141   server_prompts = Username:: : Password::
25142   server_condition = ${if and{{ \
25143     !eq{}{$auth1} }{ \
25144     ldapauth{\
25145       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25146       pass=${quote:$auth2} \
25147       ldap://ldap.example.org/} }} }
25148   server_set_id = uid=$auth1,ou=people,o=example.org
25149 .endd
25150 We have to check that the username is not empty before using it, because LDAP
25151 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25152 operator to correctly quote the DN for authentication. However, the basic
25153 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25154 correct one to use for the password, because quoting is needed only to make
25155 the password conform to the Exim syntax. At the LDAP level, the password is an
25156 uninterpreted string.
25157
25158
25159 .section "Support for different kinds of authentication" "SECID174"
25160 A number of string expansion features are provided for the purpose of
25161 interfacing to different ways of user authentication. These include checking
25162 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25163 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25164 &<<SECTexpcond>>&.
25165
25166
25167
25168
25169 .section "Using plaintext in a client" "SECID175"
25170 .cindex "options" "&(plaintext)& authenticator (client)"
25171 The &(plaintext)& authenticator has two client options:
25172
25173 .option client_ignore_invalid_base64 plaintext boolean false
25174 If the client receives a server prompt that is not a valid base64 string,
25175 authentication is abandoned by default. However, if this option is set true,
25176 the error in the challenge is ignored and the client sends the response as
25177 usual.
25178
25179 .option client_send plaintext string&!! unset
25180 The string is a colon-separated list of authentication data strings. Each
25181 string is independently expanded before being sent to the server. The first
25182 string is sent with the AUTH command; any more strings are sent in response
25183 to prompts from the server. Before each string is expanded, the value of the
25184 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25185 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25186 way. Thus, the prompt that is received in response to sending the first string
25187 (with the AUTH command) can be used in the expansion of the second string, and
25188 so on. If an invalid base64 string is received when
25189 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25190 &$auth$&<&'n'&> variable.
25191
25192 &*Note*&: You cannot use expansion to create multiple strings, because
25193 splitting takes priority and happens first.
25194
25195 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25196 the data, further processing is applied to each string before it is sent. If
25197 there are any single circumflex characters in the string, they are converted to
25198 NULs. Should an actual circumflex be required as data, it must be doubled in
25199 the string.
25200
25201 This is an example of a client configuration that implements the PLAIN
25202 authentication mechanism with a fixed user name and password:
25203 .code
25204 fixed_plain:
25205   driver = plaintext
25206   public_name = PLAIN
25207   client_send = ^username^mysecret
25208 .endd
25209 The lack of colons means that the entire text is sent with the AUTH
25210 command, with the circumflex characters converted to NULs. A similar example
25211 that uses the LOGIN mechanism is:
25212 .code
25213 fixed_login:
25214   driver = plaintext
25215   public_name = LOGIN
25216   client_send = : username : mysecret
25217 .endd
25218 The initial colon means that the first string is empty, so no data is sent with
25219 the AUTH command itself. The remaining strings are sent in response to
25220 prompts.
25221 .ecindex IIDplaiauth1
25222 .ecindex IIDplaiauth2
25223
25224
25225
25226
25227 . ////////////////////////////////////////////////////////////////////////////
25228 . ////////////////////////////////////////////////////////////////////////////
25229
25230 .chapter "The cram_md5 authenticator" "CHID9"
25231 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25232 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25233 .cindex "CRAM-MD5 authentication mechanism"
25234 .cindex "authentication" "CRAM-MD5 mechanism"
25235 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25236 sends a challenge string to the client, and the response consists of a user
25237 name and the CRAM-MD5 digest of the challenge string combined with a secret
25238 string (password) which is known to both server and client. Thus, the secret
25239 is not sent over the network as plain text, which makes this authenticator more
25240 secure than &(plaintext)&. However, the downside is that the secret has to be
25241 available in plain text at either end.
25242
25243
25244 .section "Using cram_md5 as a server" "SECID176"
25245 .cindex "options" "&(cram_md5)& authenticator (server)"
25246 This authenticator has one server option, which must be set to configure the
25247 authenticator as a server:
25248
25249 .option server_secret cram_md5 string&!! unset
25250 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25251 When the server receives the client's response, the user name is placed in
25252 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25253 obtain the password for that user. The server then computes the CRAM-MD5 digest
25254 that the client should have sent, and checks that it received the correct
25255 string. If the expansion of &%server_secret%& is forced to fail, authentication
25256 fails. If the expansion fails for some other reason, a temporary error code is
25257 returned to the client.
25258
25259 For compatibility with previous releases of Exim, the user name is also placed
25260 in &$1$&. However, the use of this variables for this purpose is now
25261 deprecated, as it can lead to confusion in string expansions that also use
25262 numeric variables for other things.
25263
25264 For example, the following authenticator checks that the user name given by the
25265 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25266 user name, authentication fails.
25267 .code
25268 fixed_cram:
25269   driver = cram_md5
25270   public_name = CRAM-MD5
25271   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25272   server_set_id = $auth1
25273 .endd
25274 .vindex "&$authenticated_id$&"
25275 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25276 name in &$authenticated_id$&. A more typical configuration might look up the
25277 secret string in a file, using the user name as the key. For example:
25278 .code
25279 lookup_cram:
25280   driver = cram_md5
25281   public_name = CRAM-MD5
25282   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25283                   {$value}fail}
25284   server_set_id = $auth1
25285 .endd
25286 Note that this expansion explicitly forces failure if the lookup fails
25287 because &$auth1$& contains an unknown user name.
25288
25289 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25290 using the relevant libraries, you need to know the realm to specify in the
25291 lookup and then ask for the &"userPassword"& attribute for that user in that
25292 realm, with:
25293 .code
25294 cyrusless_crammd5:
25295   driver = cram_md5
25296   public_name = CRAM-MD5
25297   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25298                   dbmjz{/etc/sasldb2}}
25299   server_set_id = $auth1
25300 .endd
25301
25302 .section "Using cram_md5 as a client" "SECID177"
25303 .cindex "options" "&(cram_md5)& authenticator (client)"
25304 When used as a client, the &(cram_md5)& authenticator has two options:
25305
25306
25307
25308 .option client_name cram_md5 string&!! "the primary host name"
25309 This string is expanded, and the result used as the user name data when
25310 computing the response to the server's challenge.
25311
25312
25313 .option client_secret cram_md5 string&!! unset
25314 This option must be set for the authenticator to work as a client. Its value is
25315 expanded and the result used as the secret string when computing the response.
25316
25317
25318 .vindex "&$host$&"
25319 .vindex "&$host_address$&"
25320 Different user names and secrets can be used for different servers by referring
25321 to &$host$& or &$host_address$& in the options. Forced failure of either
25322 expansion string is treated as an indication that this authenticator is not
25323 prepared to handle this case. Exim moves on to the next configured client
25324 authenticator. Any other expansion failure causes Exim to give up trying to
25325 send the message to the current server.
25326
25327 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25328 strings, is:
25329 .code
25330 fixed_cram:
25331   driver = cram_md5
25332   public_name = CRAM-MD5
25333   client_name = ph10
25334   client_secret = secret
25335 .endd
25336 .ecindex IIDcramauth1
25337 .ecindex IIDcramauth2
25338
25339
25340
25341 . ////////////////////////////////////////////////////////////////////////////
25342 . ////////////////////////////////////////////////////////////////////////////
25343
25344 .chapter "The cyrus_sasl authenticator" "CHID10"
25345 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25346 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25347 .cindex "Cyrus" "SASL library"
25348 .cindex "Kerberos"
25349 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25350 Digital Ltd (&url(http://www.aldigital.co.uk)).
25351
25352 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25353 library implementation of the RFC 2222 (&"Simple Authentication and Security
25354 Layer"&). This library supports a number of authentication mechanisms,
25355 including PLAIN and LOGIN, but also several others that Exim does not support
25356 directly. In particular, there is support for Kerberos authentication.
25357
25358 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25359 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25360 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25361 name of the driver to determine which mechanism to support.
25362
25363 Where access to some kind of secret file is required, for example in GSSAPI
25364 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25365 user, and that the Cyrus SASL library has no way of escalating privileges
25366 by default. You may also find you need to set environment variables,
25367 depending on the driver you are using.
25368
25369 The application name provided by Exim is &"exim"&, so various SASL options may
25370 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25371 Kerberos, note that because of limitations in the GSSAPI interface,
25372 changing the server keytab might need to be communicated down to the Kerberos
25373 layer independently. The mechanism for doing so is dependent upon the Kerberos
25374 implementation.
25375
25376 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25377 may be set to point to an alternative keytab file. Exim will pass this
25378 variable through from its own inherited environment when started as root or the
25379 Exim user. The keytab file needs to be readable by the Exim user.
25380 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25381 environment variable.  In practice, for those releases, the Cyrus authenticator
25382 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25383 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25384
25385
25386 .section "Using cyrus_sasl as a server" "SECID178"
25387 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25388 (on a successful authentication) into &$auth1$&. For compatibility with
25389 previous releases of Exim, the username is also placed in &$1$&. However, the
25390 use of this variable for this purpose is now deprecated, as it can lead to
25391 confusion in string expansions that also use numeric variables for other
25392 things.
25393
25394
25395 .option server_hostname cyrus_sasl string&!! "see below"
25396 This option selects the hostname that is used when communicating with the
25397 library. The default value is &`$primary_hostname`&. It is up to the underlying
25398 SASL plug-in what it does with this data.
25399
25400
25401 .option server_mech cyrus_sasl string "see below"
25402 This option selects the authentication mechanism this driver should use. The
25403 default is the value of the generic &%public_name%& option. This option allows
25404 you to use a different underlying mechanism from the advertised name. For
25405 example:
25406 .code
25407 sasl:
25408   driver = cyrus_sasl
25409   public_name = X-ANYTHING
25410   server_mech = CRAM-MD5
25411   server_set_id = $auth1
25412 .endd
25413
25414 .option server_realm cyrus_sasl string&!! unset
25415 This specifies the SASL realm that the server claims to be in.
25416
25417
25418 .option server_service cyrus_sasl string &`smtp`&
25419 This is the SASL service that the server claims to implement.
25420
25421
25422 For straightforward cases, you do not need to set any of the authenticator's
25423 private options. All you need to do is to specify an appropriate mechanism as
25424 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25425 PLAIN, you could have two authenticators as follows:
25426 .code
25427 sasl_cram_md5:
25428   driver = cyrus_sasl
25429   public_name = CRAM-MD5
25430   server_set_id = $auth1
25431
25432 sasl_plain:
25433   driver = cyrus_sasl
25434   public_name = PLAIN
25435   server_set_id = $auth2
25436 .endd
25437 Cyrus SASL does implement the LOGIN authentication method, even though it is
25438 not a standard method. It is disabled by default in the source distribution,
25439 but it is present in many binary distributions.
25440 .ecindex IIDcyrauth1
25441 .ecindex IIDcyrauth2
25442
25443
25444
25445
25446 . ////////////////////////////////////////////////////////////////////////////
25447 . ////////////////////////////////////////////////////////////////////////////
25448 .chapter "The dovecot authenticator" "CHAPdovecot"
25449 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25450 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25451 This authenticator is an interface to the authentication facility of the
25452 Dovecot POP/IMAP server, which can support a number of authentication methods.
25453 Note that Dovecot must be configured to use auth-client not auth-userdb.
25454 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25455 to use the same mechanisms for SMTP authentication. This is a server
25456 authenticator only. There is only one option:
25457
25458 .option server_socket dovecot string unset
25459
25460 This option must specify the socket that is the interface to Dovecot
25461 authentication. The &%public_name%& option must specify an authentication
25462 mechanism that Dovecot is configured to support. You can have several
25463 authenticators for different mechanisms. For example:
25464 .code
25465 dovecot_plain:
25466   driver = dovecot
25467   public_name = PLAIN
25468   server_socket = /var/run/dovecot/auth-client
25469   server_set_id = $auth1
25470
25471 dovecot_ntlm:
25472   driver = dovecot
25473   public_name = NTLM
25474   server_socket = /var/run/dovecot/auth-client
25475   server_set_id = $auth1
25476 .endd
25477 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25478 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25479 option is passed in the Dovecot authentication command. If, for a TLS
25480 connection, a client certificate has been verified, the &"valid-client-cert"&
25481 option is passed. When authentication succeeds, the identity of the user
25482 who authenticated is placed in &$auth1$&.
25483 .ecindex IIDdcotauth1
25484 .ecindex IIDdcotauth2
25485
25486
25487 . ////////////////////////////////////////////////////////////////////////////
25488 . ////////////////////////////////////////////////////////////////////////////
25489 .chapter "The gsasl authenticator" "CHAPgsasl"
25490 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25491 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25492 .cindex "authentication" "GNU SASL"
25493 .cindex "authentication" "SASL"
25494 .cindex "authentication" "EXTERNAL"
25495 .cindex "authentication" "ANONYMOUS"
25496 .cindex "authentication" "PLAIN"
25497 .cindex "authentication" "LOGIN"
25498 .cindex "authentication" "DIGEST-MD5"
25499 .cindex "authentication" "CRAM-MD5"
25500 .cindex "authentication" "SCRAM-SHA-1"
25501 The &(gsasl)& authenticator provides server integration for the GNU SASL
25502 library and the mechanisms it provides.  This is new as of the 4.80 release
25503 and there are a few areas where the library does not let Exim smoothly
25504 scale to handle future authentication mechanisms, so no guarantee can be
25505 made that any particular new authentication mechanism will be supported
25506 without code changes in Exim.
25507
25508
25509 .option server_channelbinding gsasl boolean false
25510 Some authentication mechanisms are able to use external context at both ends
25511 of the session to bind the authentication to that context, and fail the
25512 authentication process if that context differs.  Specifically, some TLS
25513 ciphersuites can provide identifying information about the cryptographic
25514 context.
25515
25516 This means that certificate identity and verification becomes a non-issue,
25517 as a man-in-the-middle attack will cause the correct client and server to
25518 see different identifiers and authentication will fail.
25519
25520 This is currently only supported when using the GnuTLS library.  This is
25521 only usable by mechanisms which support "channel binding"; at time of
25522 writing, that's the SCRAM family.
25523
25524 This defaults off to ensure smooth upgrade across Exim releases, in case
25525 this option causes some clients to start failing.  Some future release
25526 of Exim may switch the default to be true.
25527
25528
25529 .option server_hostname gsasl string&!! "see below"
25530 This option selects the hostname that is used when communicating with the
25531 library. The default value is &`$primary_hostname`&.
25532 Some mechanisms will use this data.
25533
25534
25535 .option server_mech gsasl string "see below"
25536 This option selects the authentication mechanism this driver should use. The
25537 default is the value of the generic &%public_name%& option. This option allows
25538 you to use a different underlying mechanism from the advertised name. For
25539 example:
25540 .code
25541 sasl:
25542   driver = gsasl
25543   public_name = X-ANYTHING
25544   server_mech = CRAM-MD5
25545   server_set_id = $auth1
25546 .endd
25547
25548
25549 .option server_password gsasl string&!! unset
25550 Various mechanisms need access to the cleartext password on the server, so
25551 that proof-of-possession can be demonstrated on the wire, without sending
25552 the password itself.
25553
25554 The data available for lookup varies per mechanism.
25555 In all cases, &$auth1$& is set to the &'authentication id'&.
25556 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25557 if available, else the empty string.
25558 The &$auth3$& variable will always be the &'realm'& if available,
25559 else the empty string.
25560
25561 A forced failure will cause authentication to defer.
25562
25563 If using this option, it may make sense to set the &%server_condition%&
25564 option to be simply "true".
25565
25566
25567 .option server_realm gsasl string&!! unset
25568 This specifies the SASL realm that the server claims to be in.
25569 Some mechanisms will use this data.
25570
25571
25572 .option server_scram_iter gsasl string&!! unset
25573 This option provides data for the SCRAM family of mechanisms.
25574 &$auth1$& is not available at evaluation time.
25575 (This may change, as we receive feedback on use)
25576
25577
25578 .option server_scram_salt gsasl string&!! unset
25579 This option provides data for the SCRAM family of mechanisms.
25580 &$auth1$& is not available at evaluation time.
25581 (This may change, as we receive feedback on use)
25582
25583
25584 .option server_service gsasl string &`smtp`&
25585 This is the SASL service that the server claims to implement.
25586 Some mechanisms will use this data.
25587
25588
25589 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25590 .vindex "&$auth1$&, &$auth2$&, etc"
25591 These may be set when evaluating specific options, as detailed above.
25592 They will also be set when evaluating &%server_condition%&.
25593
25594 Unless otherwise stated below, the &(gsasl)& integration will use the following
25595 meanings for these variables:
25596
25597 .ilist
25598 .vindex "&$auth1$&"
25599 &$auth1$&: the &'authentication id'&
25600 .next
25601 .vindex "&$auth2$&"
25602 &$auth2$&: the &'authorization id'&
25603 .next
25604 .vindex "&$auth3$&"
25605 &$auth3$&: the &'realm'&
25606 .endlist
25607
25608 On a per-mechanism basis:
25609
25610 .ilist
25611 .cindex "authentication" "EXTERNAL"
25612 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25613 the &%server_condition%& option must be present.
25614 .next
25615 .cindex "authentication" "ANONYMOUS"
25616 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25617 the &%server_condition%& option must be present.
25618 .next
25619 .cindex "authentication" "GSSAPI"
25620 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25621 &$auth2$& will be set to the &'authorization id'&,
25622 the &%server_condition%& option must be present.
25623 .endlist
25624
25625 An &'anonymous token'& is something passed along as an unauthenticated
25626 identifier; this is analogous to FTP anonymous authentication passing an
25627 email address, or software-identifier@, as the "password".
25628
25629
25630 An example showing the password having the realm specified in the callback
25631 and demonstrating a Cyrus SASL to GSASL migration approach is:
25632 .code
25633 gsasl_cyrusless_crammd5:
25634   driver = gsasl
25635   public_name = CRAM-MD5
25636   server_realm = imap.example.org
25637   server_password = ${lookup{$auth1:$auth3:userPassword}\
25638                     dbmjz{/etc/sasldb2}{$value}fail}
25639   server_set_id = ${quote:$auth1}
25640   server_condition = yes
25641 .endd
25642
25643
25644 . ////////////////////////////////////////////////////////////////////////////
25645 . ////////////////////////////////////////////////////////////////////////////
25646
25647 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25648 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25649 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25650 .cindex "authentication" "GSSAPI"
25651 .cindex "authentication" "Kerberos"
25652 The &(heimdal_gssapi)& authenticator provides server integration for the
25653 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25654 reliably.
25655
25656 .option server_hostname heimdal_gssapi string&!! "see below"
25657 This option selects the hostname that is used, with &%server_service%&,
25658 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25659 identifier.  The default value is &`$primary_hostname`&.
25660
25661 .option server_keytab heimdal_gssapi string&!! unset
25662 If set, then Heimdal will not use the system default keytab (typically
25663 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25664 The value should be a pathname, with no &"file:"& prefix.
25665
25666 .option server_service heimdal_gssapi string&!! "smtp"
25667 This option specifies the service identifier used, in conjunction with
25668 &%server_hostname%&, for building the identifer for finding credentials
25669 from the keytab.
25670
25671
25672 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25673 Beware that these variables will typically include a realm, thus will appear
25674 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25675 not verified, so a malicious client can set it to anything.
25676
25677 The &$auth1$& field should be safely trustable as a value from the Key
25678 Distribution Center.  Note that these are not quite email addresses.
25679 Each identifier is for a role, and so the left-hand-side may include a
25680 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25681
25682 .vindex "&$auth1$&, &$auth2$&, etc"
25683 .ilist
25684 .vindex "&$auth1$&"
25685 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25686 .next
25687 .vindex "&$auth2$&"
25688 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25689 authentication.  If that was empty, this will also be set to the
25690 GSS Display Name.
25691 .endlist
25692
25693
25694 . ////////////////////////////////////////////////////////////////////////////
25695 . ////////////////////////////////////////////////////////////////////////////
25696
25697 .chapter "The spa authenticator" "CHAPspa"
25698 .scindex IIDspaauth1 "&(spa)& authenticator"
25699 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25700 .cindex "authentication" "Microsoft Secure Password"
25701 .cindex "authentication" "NTLM"
25702 .cindex "Microsoft Secure Password Authentication"
25703 .cindex "NTLM authentication"
25704 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25705 Password Authentication'& mechanism,
25706 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25707 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25708 taken from the Samba project (&url(http://www.samba.org)). The code for the
25709 server side was subsequently contributed by Tom Kistner. The mechanism works as
25710 follows:
25711
25712 .ilist
25713 After the AUTH command has been accepted, the client sends an SPA
25714 authentication request based on the user name and optional domain.
25715 .next
25716 The server sends back a challenge.
25717 .next
25718 The client builds a challenge response which makes use of the user's password
25719 and sends it to the server, which then accepts or rejects it.
25720 .endlist
25721
25722 Encryption is used to protect the password in transit.
25723
25724
25725
25726 .section "Using spa as a server" "SECID179"
25727 .cindex "options" "&(spa)& authenticator (server)"
25728 The &(spa)& authenticator has just one server option:
25729
25730 .option server_password spa string&!! unset
25731 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25732 This option is expanded, and the result must be the cleartext password for the
25733 authenticating user, whose name is at this point in &$auth1$&. For
25734 compatibility with previous releases of Exim, the user name is also placed in
25735 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25736 it can lead to confusion in string expansions that also use numeric variables
25737 for other things. For example:
25738 .code
25739 spa:
25740   driver = spa
25741   public_name = NTLM
25742   server_password = \
25743     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25744 .endd
25745 If the expansion is forced to fail, authentication fails. Any other expansion
25746 failure causes a temporary error code to be returned.
25747
25748
25749
25750
25751
25752 .section "Using spa as a client" "SECID180"
25753 .cindex "options" "&(spa)& authenticator (client)"
25754 The &(spa)& authenticator has the following client options:
25755
25756
25757
25758 .option client_domain spa string&!! unset
25759 This option specifies an optional domain for the authentication.
25760
25761
25762 .option client_password spa string&!! unset
25763 This option specifies the user's password, and must be set.
25764
25765
25766 .option client_username spa string&!! unset
25767 This option specifies the user name, and must be set. Here is an example of a
25768 configuration of this authenticator for use with the mail servers at
25769 &'msn.com'&:
25770 .code
25771 msn:
25772   driver = spa
25773   public_name = MSN
25774   client_username = msn/msn_username
25775   client_password = msn_plaintext_password
25776   client_domain = DOMAIN_OR_UNSET
25777 .endd
25778 .ecindex IIDspaauth1
25779 .ecindex IIDspaauth2
25780
25781
25782
25783
25784
25785 . ////////////////////////////////////////////////////////////////////////////
25786 . ////////////////////////////////////////////////////////////////////////////
25787
25788 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25789          "Encrypted SMTP connections"
25790 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25791 .scindex IIDencsmtp2 "SMTP" "encryption"
25792 .cindex "TLS" "on SMTP connection"
25793 .cindex "OpenSSL"
25794 .cindex "GnuTLS"
25795 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25796 Sockets Layer), is implemented by making use of the OpenSSL library or the
25797 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25798 cryptographic code in the Exim distribution itself for implementing TLS. In
25799 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25800 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25801 You also need to understand the basic concepts of encryption at a managerial
25802 level, and in particular, the way that public keys, private keys, and
25803 certificates are used.
25804
25805 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25806 connection is established, the client issues a STARTTLS command. If the
25807 server accepts this, the client and the server negotiate an encryption
25808 mechanism. If the negotiation succeeds, the data that subsequently passes
25809 between them is encrypted.
25810
25811 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25812 and if so, what cipher suite is in use, whether the client supplied a
25813 certificate, and whether or not that certificate was verified. This makes it
25814 possible for an Exim server to deny or accept certain commands based on the
25815 encryption state.
25816
25817 &*Warning*&: Certain types of firewall and certain anti-virus products can
25818 disrupt TLS connections. You need to turn off SMTP scanning for these products
25819 in order to get TLS to work.
25820
25821
25822
25823 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25824          "SECID284"
25825 .cindex "ssmtp protocol"
25826 .cindex "smtps protocol"
25827 .cindex "SMTP" "ssmtp protocol"
25828 .cindex "SMTP" "smtps protocol"
25829 Early implementations of encrypted SMTP used a different TCP port from normal
25830 SMTP, and expected an encryption negotiation to start immediately, instead of
25831 waiting for a STARTTLS command from the client using the standard SMTP
25832 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25833 allocated for this purpose.
25834
25835 This approach was abandoned when encrypted SMTP was standardized, but there are
25836 still some legacy clients that use it. Exim supports these clients by means of
25837 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25838 numbers; the most common use is expected to be:
25839 .code
25840 tls_on_connect_ports = 465
25841 .endd
25842 The port numbers specified by this option apply to all SMTP connections, both
25843 via the daemon and via &'inetd'&. You still need to specify all the ports that
25844 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25845 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25846 an extra port &-- rather, it specifies different behaviour on a port that is
25847 defined elsewhere.
25848
25849 There is also a &%-tls-on-connect%& command line option. This overrides
25850 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25851
25852
25853
25854
25855
25856
25857 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25858 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25859 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25860 followed later, when the first versions of GnuTLS were released. To build Exim
25861 to use GnuTLS, you need to set
25862 .code
25863 USE_GNUTLS=yes
25864 .endd
25865 in Local/Makefile, in addition to
25866 .code
25867 SUPPORT_TLS=yes
25868 .endd
25869 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25870 include files and libraries for GnuTLS can be found.
25871
25872 There are some differences in usage when using GnuTLS instead of OpenSSL:
25873
25874 .ilist
25875 The &%tls_verify_certificates%& option must contain the name of a file, not the
25876 name of a directory (for OpenSSL it can be either).
25877 .next
25878 The default value for &%tls_dhparam%& differs for historical reasons.
25879 .next
25880 .vindex "&$tls_in_peerdn$&"
25881 .vindex "&$tls_out_peerdn$&"
25882 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25883 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25884 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25885 .next
25886 OpenSSL identifies cipher suites using hyphens as separators, for example:
25887 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25888 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25889 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25890 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25891 to handle its own older variants) when processing lists of cipher suites in the
25892 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25893 option).
25894 .next
25895 The &%tls_require_ciphers%& options operate differently, as described in the
25896 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25897 .next
25898 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25899 When using OpenSSL, this option is ignored.
25900 (If an API is found to let OpenSSL be configured in this way,
25901 let the Exim Maintainers know and we'll likely use it).
25902 .next
25903 Some other recently added features may only be available in one or the other.
25904 This should be documented with the feature.  If the documentation does not
25905 explicitly state that the feature is infeasible in the other TLS
25906 implementation, then patches are welcome.
25907 .endlist
25908
25909
25910 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25911 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25912 an explicit path; if the latter, then the text about generation still applies,
25913 but not the chosen filename.
25914 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25915 See the documentation of &%tls_dhparam%& for more information.
25916
25917 GnuTLS uses D-H parameters that may take a substantial amount of time
25918 to compute. It is unreasonable to re-compute them for every TLS session.
25919 Therefore, Exim keeps this data in a file in its spool directory, called
25920 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25921 of bits requested.
25922 The file is owned by the Exim user and is readable only by
25923 its owner. Every Exim process that start up GnuTLS reads the D-H
25924 parameters from this file. If the file does not exist, the first Exim process
25925 that needs it computes the data and writes it to a temporary file which is
25926 renamed once it is complete. It does not matter if several Exim processes do
25927 this simultaneously (apart from wasting a few resources). Once a file is in
25928 place, new Exim processes immediately start using it.
25929
25930 For maximum security, the parameters that are stored in this file should be
25931 recalculated periodically, the frequency depending on your paranoia level.
25932 If you are avoiding using the fixed D-H primes published in RFCs, then you
25933 are concerned about some advanced attacks and will wish to do this; if you do
25934 not regenerate then you might as well stick to the standard primes.
25935
25936 Arranging this is easy in principle; just delete the file when you want new
25937 values to be computed. However, there may be a problem. The calculation of new
25938 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25939 If the system is not very active, &_/dev/random_& may delay returning data
25940 until enough randomness (entropy) is available. This may cause Exim to hang for
25941 a substantial amount of time, causing timeouts on incoming connections.
25942
25943 The solution is to generate the parameters externally to Exim. They are stored
25944 in &_gnutls-params-N_& in PEM format, which means that they can be
25945 generated externally using the &(certtool)& command that is part of GnuTLS.
25946
25947 To replace the parameters with new ones, instead of deleting the file
25948 and letting Exim re-create it, you can generate new parameters using
25949 &(certtool)& and, when this has been done, replace Exim's cache file by
25950 renaming. The relevant commands are something like this:
25951 .code
25952 # ls
25953 [ look for file; assume gnutls-params-2236 is the most recent ]
25954 # rm -f new-params
25955 # touch new-params
25956 # chown exim:exim new-params
25957 # chmod 0600 new-params
25958 # certtool --generate-dh-params --bits 2236 >>new-params
25959 # openssl dhparam -noout -text -in new-params | head
25960 [ check the first line, make sure it's not more than 2236;
25961   if it is, then go back to the start ("rm") and repeat
25962   until the size generated is at most the size requested ]
25963 # chmod 0400 new-params
25964 # mv new-params gnutls-params-2236
25965 .endd
25966 If Exim never has to generate the parameters itself, the possibility of
25967 stalling is removed.
25968
25969 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25970 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25971 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25972 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25973 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25974 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25975 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25976 which applies to all D-H usage, client or server.  If the value returned by
25977 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25978 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25979 limit, which is still much higher than Exim historically used.
25980
25981 The filename and bits used will change as the GnuTLS maintainers change the
25982 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25983 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25984 2432 bits, while NSS is limited to 2236 bits.
25985
25986 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25987 increase the chance of the generated prime actually being within acceptable
25988 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25989 procedure above.  There is no sane procedure available to Exim to double-check
25990 the size of the generated prime, so it might still be too large.
25991
25992
25993 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25994 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25995 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25996 There is a function in the OpenSSL library that can be passed a list of cipher
25997 suites before the cipher negotiation takes place. This specifies which ciphers
25998 are acceptable. The list is colon separated and may contain names like
25999 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26000 directly to this function call.
26001 Many systems will install the OpenSSL manual-pages, so you may have
26002 &'ciphers(1)'& available to you.
26003 The following quotation from the OpenSSL
26004 documentation specifies what forms of item are allowed in the cipher string:
26005
26006 .ilist
26007 It can consist of a single cipher suite such as RC4-SHA.
26008 .next
26009 It can represent a list of cipher suites containing a certain algorithm,
26010 or cipher suites of a certain type. For example SHA1 represents all
26011 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26012 SSL v3 algorithms.
26013 .next
26014 Lists of cipher suites can be combined in a single cipher string using
26015 the + character. This is used as a logical and operation. For example
26016 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26017 algorithms.
26018 .endlist
26019
26020 Each cipher string can be optionally preceded by one of the characters &`!`&,
26021 &`-`& or &`+`&.
26022 .ilist
26023 If &`!`& is used, the ciphers are permanently deleted from the list. The
26024 ciphers deleted can never reappear in the list even if they are explicitly
26025 stated.
26026 .next
26027 If &`-`& is used, the ciphers are deleted from the list, but some or all
26028 of the ciphers can be added again by later options.
26029 .next
26030 If &`+`& is used, the ciphers are moved to the end of the list. This
26031 option does not add any new ciphers; it just moves matching existing ones.
26032 .endlist
26033
26034 If none of these characters is present, the string is interpreted as
26035 a list of ciphers to be appended to the current preference list. If the list
26036 includes any ciphers already present they will be ignored: that is, they will
26037 not be moved to the end of the list.
26038 .endlist
26039
26040 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26041 string:
26042 .code
26043 # note single-quotes to get ! past any shell history expansion
26044 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26045 .endd
26046
26047 This example will let the library defaults be permitted on the MX port, where
26048 there's probably no identity verification anyway, but ups the ante on the
26049 submission ports where the administrator might have some influence on the
26050 choice of clients used:
26051 .code
26052 # OpenSSL variant; see man ciphers(1)
26053 tls_require_ciphers = ${if =={$received_port}{25}\
26054                            {DEFAULT}\
26055                            {HIGH:!MD5:!SHA1}}
26056 .endd
26057
26058
26059
26060 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26061          "SECTreqciphgnu"
26062 .cindex "GnuTLS" "specifying parameters for"
26063 .cindex "TLS" "specifying ciphers (GnuTLS)"
26064 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26065 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26066 .cindex "TLS" "specifying protocols (GnuTLS)"
26067 .cindex "TLS" "specifying priority string (GnuTLS)"
26068 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26069 The GnuTLS library allows the caller to provide a "priority string", documented
26070 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26071 ciphersuite specification in OpenSSL.
26072
26073 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
26074
26075 The &%tls_require_ciphers%& option is available both as an global option,
26076 controlling how Exim behaves as a server, and also as an option of the
26077 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26078 the value is string expanded.  The resulting string is not an Exim list and
26079 the string is given to the GnuTLS library, so that Exim does not need to be
26080 aware of future feature enhancements of GnuTLS.
26081
26082 Documentation of the strings accepted may be found in the GnuTLS manual, under
26083 "Priority strings".  This is online as
26084 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26085 but beware that this relates to GnuTLS 3, which may be newer than the version
26086 installed on your system.  If you are using GnuTLS 3,
26087 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26088 on that site can be used to test a given string.
26089
26090 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26091 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26092 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26093
26094 This example will let the library defaults be permitted on the MX port, where
26095 there's probably no identity verification anyway, and lowers security further
26096 by increasing compatibility; but this ups the ante on the submission ports
26097 where the administrator might have some influence on the choice of clients
26098 used:
26099 .code
26100 # GnuTLS variant
26101 tls_require_ciphers = ${if =={$received_port}{25}\
26102                            {NORMAL:%COMPAT}\
26103                            {SECURE128}}
26104 .endd
26105
26106
26107 .section "Configuring an Exim server to use TLS" "SECID182"
26108 .cindex "TLS" "configuring an Exim server"
26109 When Exim has been built with TLS support, it advertises the availability of
26110 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26111 but not to any others. The default value of this option is unset, which means
26112 that STARTTLS is not advertised at all. This default is chosen because you
26113 need to set some other options in order to make TLS available, and also it is
26114 sensible for systems that want to use TLS only as a client.
26115
26116 If a client issues a STARTTLS command and there is some configuration
26117 problem in the server, the command is rejected with a 454 error. If the client
26118 persists in trying to issue SMTP commands, all except QUIT are rejected
26119 with the error
26120 .code
26121 554 Security failure
26122 .endd
26123 If a STARTTLS command is issued within an existing TLS session, it is
26124 rejected with a 554 error code.
26125
26126 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26127 match some hosts. You can, of course, set it to * to match all hosts.
26128 However, this is not all you need to do. TLS sessions to a server won't work
26129 without some further configuration at the server end.
26130
26131 It is rumoured that all existing clients that support TLS/SSL use RSA
26132 encryption. To make this work you need to set, in the server,
26133 .code
26134 tls_certificate = /some/file/name
26135 tls_privatekey = /some/file/name
26136 .endd
26137 These options are, in fact, expanded strings, so you can make them depend on
26138 the identity of the client that is connected if you wish. The first file
26139 contains the server's X509 certificate, and the second contains the private key
26140 that goes with it. These files need to be readable by the Exim user, and must
26141 always be given as full path names. They can be the same file if both the
26142 certificate and the key are contained within it. If &%tls_privatekey%& is not
26143 set, or if its expansion is forced to fail or results in an empty string, this
26144 is assumed to be the case. The certificate file may also contain intermediate
26145 certificates that need to be sent to the client to enable it to authenticate
26146 the server's certificate.
26147
26148 If you do not understand about certificates and keys, please try to find a
26149 source of this background information, which is not Exim-specific. (There are a
26150 few comments below in section &<<SECTcerandall>>&.)
26151
26152 &*Note*&: These options do not apply when Exim is operating as a client &--
26153 they apply only in the case of a server. If you need to use a certificate in an
26154 Exim client, you must set the options of the same names in an &(smtp)&
26155 transport.
26156
26157 With just these options, an Exim server will be able to use TLS. It does not
26158 require the client to have a certificate (but see below for how to insist on
26159 this). There is one other option that may be needed in other situations. If
26160 .code
26161 tls_dhparam = /some/file/name
26162 .endd
26163 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26164 with the parameters contained in the file.
26165 Set this to &`none`& to disable use of DH entirely, by making no prime
26166 available:
26167 .code
26168 tls_dhparam = none
26169 .endd
26170 This may also be set to a string identifying a standard prime to be used for
26171 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26172 used is &`ike23`&.  There are a few standard primes available, see the
26173 documentation for &%tls_dhparam%& for the complete list.
26174
26175 See the command
26176 .code
26177 openssl dhparam
26178 .endd
26179 for a way of generating file data.
26180
26181 The strings supplied for these three options are expanded every time a client
26182 host connects. It is therefore possible to use different certificates and keys
26183 for different hosts, if you so wish, by making use of the client's IP address
26184 in &$sender_host_address$& to control the expansion. If a string expansion is
26185 forced to fail, Exim behaves as if the option is not set.
26186
26187 .cindex "cipher" "logging"
26188 .cindex "log" "TLS cipher"
26189 .vindex "&$tls_in_cipher$&"
26190 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26191 an incoming TLS connection. It is included in the &'Received:'& header of an
26192 incoming message (by default &-- you can, of course, change this), and it is
26193 also included in the log line that records a message's arrival, keyed by
26194 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26195 condition can be used to test for specific cipher suites in ACLs.
26196
26197 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26198 can check the name of the cipher suite and vary their actions accordingly. The
26199 cipher suite names vary, depending on which TLS library is being used. For
26200 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26201 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26202 documentation for more details.
26203
26204 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26205 (again depending on the &%tls_cipher%& log selector).
26206
26207
26208 .section "Requesting and verifying client certificates" "SECID183"
26209 .cindex "certificate" "verification of client"
26210 .cindex "TLS" "client certificate verification"
26211 If you want an Exim server to request a certificate when negotiating a TLS
26212 session with a client, you must set either &%tls_verify_hosts%& or
26213 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26214 apply to all TLS connections. For any host that matches one of these options,
26215 Exim requests a certificate as part of the setup of the TLS session. The
26216 contents of the certificate are verified by comparing it with a list of
26217 expected certificates. These must be available in a file or,
26218 for OpenSSL only (not GnuTLS), a directory, identified by
26219 &%tls_verify_certificates%&.
26220
26221 A file can contain multiple certificates, concatenated end to end. If a
26222 directory is used
26223 (OpenSSL only),
26224 each certificate must be in a separate file, with a name (or a symbolic link)
26225 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26226 certificate. You can compute the relevant hash by running the command
26227 .code
26228 openssl x509 -hash -noout -in /cert/file
26229 .endd
26230 where &_/cert/file_& contains a single certificate.
26231
26232 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26233 what happens if the client does not supply a certificate, or if the certificate
26234 does not match any of the certificates in the collection named by
26235 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26236 attempt to set up a TLS session is aborted, and the incoming connection is
26237 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26238 session continues. ACLs that run for subsequent SMTP commands can detect the
26239 fact that no certificate was verified, and vary their actions accordingly. For
26240 example, you can insist on a certificate before accepting a message for
26241 relaying, but not when the message is destined for local delivery.
26242
26243 .vindex "&$tls_in_peerdn$&"
26244 When a client supplies a certificate (whether it verifies or not), the value of
26245 the Distinguished Name of the certificate is made available in the variable
26246 &$tls_in_peerdn$& during subsequent processing of the message.
26247
26248 .cindex "log" "distinguished name"
26249 Because it is often a long text string, it is not included in the log line or
26250 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26251 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26252 &%received_header_text%& to change the &'Received:'& header. When no
26253 certificate is supplied, &$tls_in_peerdn$& is empty.
26254
26255
26256 .section "Revoked certificates" "SECID184"
26257 .cindex "TLS" "revoked certificates"
26258 .cindex "revocation list"
26259 .cindex "certificate" "revocation list"
26260 .cindex "OCSP" "stapling"
26261 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26262 certificates are revoked. If you have such a list, you can pass it to an Exim
26263 server using the global option called &%tls_crl%& and to an Exim client using
26264 an identically named option for the &(smtp)& transport. In each case, the value
26265 of the option is expanded and must then be the name of a file that contains a
26266 CRL in PEM format.
26267 The downside is that clients have to periodically re-download a potentially huge
26268 file from every certificate authority the know of.
26269
26270 The way with most moving parts at query time is Online Certificate
26271 Status Protocol (OCSP), where the client verifies the certificate
26272 against an OCSP server run by the CA.  This lets the CA track all
26273 usage of the certs.  It requires running software with access to the
26274 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26275 is based on HTTP and can be proxied accordingly.
26276
26277 The only widespread OCSP server implementation (known to this writer)
26278 comes as part of OpenSSL and aborts on an invalid request, such as
26279 connecting to the port and then disconnecting.  This requires
26280 re-entering the passphrase each time some random client does this.
26281
26282 The third way is OCSP Stapling; in this, the server using a certificate
26283 issued by the CA periodically requests an OCSP proof of validity from
26284 the OCSP server, then serves it up inline as part of the TLS
26285 negotiation.   This approach adds no extra round trips, does not let the
26286 CA track users, scales well with number of certs issued by the CA and is
26287 resilient to temporary OCSP server failures, as long as the server
26288 starts retrying to fetch an OCSP proof some time before its current
26289 proof expires.  The downside is that it requires server support.
26290
26291 Unless Exim is built with the support disabled,
26292 or with GnuTLS earlier than version 3.1.3,
26293 support for OCSP stapling is included.
26294
26295 There is a global option called &%tls_ocsp_file%&.
26296 The file specified therein is expected to be in DER format, and contain
26297 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26298 option will be re-expanded for SNI, if the &%tls_certificate%& option
26299 contains &`tls_in_sni`&, as per other TLS options.
26300
26301 Exim does not at this time implement any support for fetching a new OCSP
26302 proof.  The burden is on the administrator to handle this, outside of
26303 Exim.  The file specified should be replaced atomically, so that the
26304 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26305 on each connection, so a new file will be handled transparently on the
26306 next connection.
26307
26308 When built with OpenSSL Exim will check for a valid next update timestamp
26309 in the OCSP proof; if not present, or if the proof has expired, it will be
26310 ignored.
26311
26312 For the client to be able to verify the stapled OCSP the server must
26313 also supply, in its stapled information, any intermediate
26314 certificates for the chain leading to the OCSP proof from the signer
26315 of the server certificate.  There may be zero or one such. These
26316 intermediate certificates should be added to the server OCSP stapling
26317 file named by &%tls_ocsp_file%&.
26318
26319 Note that the proof only covers the terminal server certificate,
26320 not any of the chain from CA to it.
26321
26322 There is no current way to staple a proof for a client certificate.
26323
26324 .code
26325   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26326   OCSP server is supplied.  The server URL may be included in the
26327   server certificate, if the CA is helpful.
26328
26329   One failure mode seen was the OCSP Signer cert expiring before the end
26330   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26331   noted this as invalid overall, but the re-fetch script did not.
26332 .endd
26333
26334
26335
26336
26337 .section "Configuring an Exim client to use TLS" "SECID185"
26338 .cindex "cipher" "logging"
26339 .cindex "log" "TLS cipher"
26340 .cindex "log" "distinguished name"
26341 .cindex "TLS" "configuring an Exim client"
26342 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26343 deliveries as well as to incoming, the latter one causing logging of the
26344 server certificate's DN. The remaining client configuration for TLS is all
26345 within the &(smtp)& transport.
26346
26347 It is not necessary to set any options to have TLS work in the &(smtp)&
26348 transport. If Exim is built with TLS support, and TLS is advertised by a
26349 server, the &(smtp)& transport always tries to start a TLS session. However,
26350 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26351 transport) to a list of server hosts for which TLS should not be used.
26352
26353 If you do not want Exim to attempt to send messages unencrypted when an attempt
26354 to set up an encrypted connection fails in any way, you can set
26355 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26356 those hosts, delivery is always deferred if an encrypted connection cannot be
26357 set up. If there are any other hosts for the address, they are tried in the
26358 usual way.
26359
26360 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26361 the message unencrypted. It always does this if the response to STARTTLS is
26362 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26363 session after a success response code, what happens is controlled by the
26364 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26365 delivery to this host is deferred, and other hosts (if available) are tried. If
26366 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26367 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26368 negotiation fails, Exim closes the current connection (because it is in an
26369 unknown state), opens a new one to the same host, and then tries the delivery
26370 unencrypted.
26371
26372 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26373 transport provide the client with a certificate, which is passed to the server
26374 if it requests it. If the server is Exim, it will request a certificate only if
26375 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26376
26377 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26378 must name a file or,
26379 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
26380 expected server certificates. The client verifies the server's certificate
26381 against this collection, taking into account any revoked certificates that are
26382 in the list defined by &%tls_crl%&.
26383 Failure to verify fails the TLS connection unless either of the
26384 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26385
26386 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26387 certificate verification to the listed servers.  Verification either must
26388 or need not succeed respectively.
26389
26390 The &(smtp)& transport has two OCSP-related options:
26391 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26392 is requested and required for the connection to proceed.  The default
26393 value is empty.
26394 &%hosts_request_ocsp%&; a host-list for which (additionally)
26395 a Certificate Status is requested (but not necessarily verified).  The default
26396 value is "*" meaning that requests are made unless configured
26397 otherwise.
26398
26399 The host(s) should also be in &%hosts_require_tls%&, and
26400 &%tls_verify_certificates%& configured for the transport,
26401 for OCSP to be relevant.
26402
26403 If
26404 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26405 list of permitted cipher suites. If either of these checks fails, delivery to
26406 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26407 alternative hosts, if any.
26408
26409  &*Note*&:
26410 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26411 is operating as a client. Exim does not assume that a server certificate (set
26412 by the global options of the same name) should also be used when operating as a
26413 client.
26414
26415 .vindex "&$host$&"
26416 .vindex "&$host_address$&"
26417 All the TLS options in the &(smtp)& transport are expanded before use, with
26418 &$host$& and &$host_address$& containing the name and address of the server to
26419 which the client is connected. Forced failure of an expansion causes Exim to
26420 behave as if the relevant option were unset.
26421
26422 .vindex &$tls_out_bits$&
26423 .vindex &$tls_out_cipher$&
26424 .vindex &$tls_out_peerdn$&
26425 .vindex &$tls_out_sni$&
26426 Before an SMTP connection is established, the
26427 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26428 variables are emptied. (Until the first connection, they contain the values
26429 that were set when the message was received.) If STARTTLS is subsequently
26430 successfully obeyed, these variables are set to the relevant values for the
26431 outgoing connection.
26432
26433
26434
26435 .section "Use of TLS Server Name Indication" "SECTtlssni"
26436 .cindex "TLS" "Server Name Indication"
26437 .vindex "&$tls_in_sni$&"
26438 .oindex "&%tls_in_sni%&"
26439 With TLS1.0 or above, there is an extension mechanism by which extra
26440 information can be included at various points in the protocol.  One of these
26441 extensions, documented in RFC 6066 (and before that RFC 4366) is
26442 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26443 client in the initial handshake, so that the server can examine the servername
26444 within and possibly choose to use different certificates and keys (and more)
26445 for this session.
26446
26447 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26448 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26449 address.
26450
26451 With SMTP to MX, there are the same problems here as in choosing the identity
26452 against which to validate a certificate: you can't rely on insecure DNS to
26453 provide the identity which you then cryptographically verify.  So this will
26454 be of limited use in that environment.
26455
26456 With SMTP to Submission, there is a well-defined hostname which clients are
26457 connecting to and can validate certificates against.  Thus clients &*can*&
26458 choose to include this information in the TLS negotiation.  If this becomes
26459 wide-spread, then hosters can choose to present different certificates to
26460 different clients.  Or even negotiate different cipher suites.
26461
26462 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26463 if not empty, will be sent on a TLS session as part of the handshake.  There's
26464 nothing more to it.  Choosing a sensible value not derived insecurely is the
26465 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26466 for the lifetime of the client connection (including during authentication).
26467
26468 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26469 received from a client.
26470 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26471
26472 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26473 option (prior to expansion) then the following options will be re-expanded
26474 during TLS session handshake, to permit alternative values to be chosen:
26475
26476 .ilist
26477 .vindex "&%tls_certificate%&"
26478 &%tls_certificate%&
26479 .next
26480 .vindex "&%tls_crl%&"
26481 &%tls_crl%&
26482 .next
26483 .vindex "&%tls_privatekey%&"
26484 &%tls_privatekey%&
26485 .next
26486 .vindex "&%tls_verify_certificates%&"
26487 &%tls_verify_certificates%&
26488 .next
26489 .vindex "&%tls_ocsp_file%&"
26490 &%tls_verify_certificates%&
26491 .endlist
26492
26493 Great care should be taken to deal with matters of case, various injection
26494 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26495 can always be referenced; it is important to remember that &$tls_sni$& is
26496 arbitrary unverified data provided prior to authentication.
26497
26498 The Exim developers are proceeding cautiously and so far no other TLS options
26499 are re-expanded.
26500
26501 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26502 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26503 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26504 see &`-servername`& in the output, then OpenSSL has support.
26505
26506 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26507 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26508 built, then you have SNI support).
26509
26510
26511
26512 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26513          "SECTmulmessam"
26514 .cindex "multiple SMTP deliveries with TLS"
26515 .cindex "TLS" "multiple message deliveries"
26516 Exim sends multiple messages down the same TCP/IP connection by starting up
26517 an entirely new delivery process for each message, passing the socket from
26518 one process to the next. This implementation does not fit well with the use
26519 of TLS, because there is quite a lot of state information associated with a TLS
26520 connection, not just a socket identification. Passing all the state information
26521 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26522 session before passing the socket to a new process. The new process may then
26523 try to start a new TLS session, and if successful, may try to re-authenticate
26524 if AUTH is in use, before sending the next message.
26525
26526 The RFC is not clear as to whether or not an SMTP session continues in clear
26527 after TLS has been shut down, or whether TLS may be restarted again later, as
26528 just described. However, if the server is Exim, this shutdown and
26529 reinitialization works. It is not known which (if any) other servers operate
26530 successfully if the client closes a TLS session and continues with unencrypted
26531 SMTP, but there are certainly some that do not work. For such servers, Exim
26532 should not pass the socket to another process, because the failure of the
26533 subsequent attempt to use it would cause Exim to record a temporary host error,
26534 and delay other deliveries to that host.
26535
26536 To test for this case, Exim sends an EHLO command to the server after
26537 closing down the TLS session. If this fails in any way, the connection is
26538 closed instead of being passed to a new delivery process, but no retry
26539 information is recorded.
26540
26541 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26542 &(smtp)& transport to match those hosts for which Exim should not pass
26543 connections to new processes if TLS has been used.
26544
26545
26546
26547
26548 .section "Certificates and all that" "SECTcerandall"
26549 .cindex "certificate" "references to discussion"
26550 In order to understand fully how TLS works, you need to know about
26551 certificates, certificate signing, and certificate authorities. This is not the
26552 place to give a tutorial, especially as I do not know very much about it
26553 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26554 to Apache, currently at
26555 .display
26556 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26557 .endd
26558 Other parts of the &'modssl'& documentation are also helpful, and have
26559 links to further files.
26560 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26561 0-201-61598-3), contains both introductory and more in-depth descriptions.
26562 Some sample programs taken from the book are available from
26563 .display
26564 &url(http://www.rtfm.com/openssl-examples/)
26565 .endd
26566
26567
26568 .section "Certificate chains" "SECID186"
26569 The file named by &%tls_certificate%& may contain more than one
26570 certificate. This is useful in the case where the certificate that is being
26571 sent is validated by an intermediate certificate which the other end does
26572 not have. Multiple certificates must be in the correct order in the file.
26573 First the host's certificate itself, then the first intermediate
26574 certificate to validate the issuer of the host certificate, then the next
26575 intermediate certificate to validate the issuer of the first intermediate
26576 certificate, and so on, until finally (optionally) the root certificate.
26577 The root certificate must already be trusted by the recipient for
26578 validation to succeed, of course, but if it's not preinstalled, sending the
26579 root certificate along with the rest makes it available for the user to
26580 install if the receiving end is a client MUA that can interact with a user.
26581
26582 Note that certificates using MD5 are unlikely to work on today's Internet;
26583 even if your libraries allow loading them for use in Exim when acting as a
26584 server, increasingly clients will not accept such certificates.  The error
26585 diagnostics in such a case can be frustratingly vague.
26586
26587
26588
26589 .section "Self-signed certificates" "SECID187"
26590 .cindex "certificate" "self-signed"
26591 You can create a self-signed certificate using the &'req'& command provided
26592 with OpenSSL, like this:
26593 . ==== Do not shorten the duration here without reading and considering
26594 . ==== the text below.  Please leave it at 9999 days.
26595 .code
26596 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26597             -days 9999 -nodes
26598 .endd
26599 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26600 delimited and so can be identified independently. The &%-days%& option
26601 specifies a period for which the certificate is valid. The &%-nodes%& option is
26602 important: if you do not set it, the key is encrypted with a passphrase
26603 that you are prompted for, and any use that is made of the key causes more
26604 prompting for the passphrase. This is not helpful if you are going to use
26605 this certificate and key in an MTA, where prompting is not possible.
26606
26607 . ==== I expect to still be working 26 years from now.  The less technical
26608 . ==== debt I create, in terms of storing up trouble for my later years, the
26609 . ==== happier I will be then.  We really have reached the point where we
26610 . ==== should start, at the very least, provoking thought and making folks
26611 . ==== pause before proceeding, instead of leaving all the fixes until two
26612 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26613 . ==== -pdp, 2012
26614 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26615 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26616 the above command might produce a date in the past.  Think carefully about
26617 the lifetime of the systems you're deploying, and either reduce the duration
26618 of the certificate or reconsider your platform deployment.  (At time of
26619 writing, reducing the duration is the most likely choice, but the inexorable
26620 progression of time takes us steadily towards an era where this will not
26621 be a sensible resolution).
26622
26623 A self-signed certificate made in this way is sufficient for testing, and
26624 may be adequate for all your requirements if you are mainly interested in
26625 encrypting transfers, and not in secure identification.
26626
26627 However, many clients require that the certificate presented by the server be a
26628 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26629 certificate. In this situation, the self-signed certificate described above
26630 must be installed on the client host as a trusted root &'certification
26631 authority'& (CA), and the certificate used by Exim must be a user certificate
26632 signed with that self-signed certificate.
26633
26634 For information on creating self-signed CA certificates and using them to sign
26635 user certificates, see the &'General implementation overview'& chapter of the
26636 Open-source PKI book, available online at
26637 &url(http://ospkibook.sourceforge.net/).
26638 .ecindex IIDencsmtp1
26639 .ecindex IIDencsmtp2
26640
26641
26642
26643 . ////////////////////////////////////////////////////////////////////////////
26644 . ////////////////////////////////////////////////////////////////////////////
26645
26646 .chapter "Access control lists" "CHAPACL"
26647 .scindex IIDacl "&ACL;" "description"
26648 .cindex "control of incoming mail"
26649 .cindex "message" "controlling incoming"
26650 .cindex "policy control" "access control lists"
26651 Access Control Lists (ACLs) are defined in a separate section of the run time
26652 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26653 name, terminated by a colon. Here is a complete ACL section that contains just
26654 one very small ACL:
26655 .code
26656 begin acl
26657 small_acl:
26658   accept   hosts = one.host.only
26659 .endd
26660 You can have as many lists as you like in the ACL section, and the order in
26661 which they appear does not matter. The lists are self-terminating.
26662
26663 The majority of ACLs are used to control Exim's behaviour when it receives
26664 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26665 when a local process submits a message using SMTP by specifying the &%-bs%&
26666 option. The most common use is for controlling which recipients are accepted
26667 in incoming messages. In addition, you can define an ACL that is used to check
26668 local non-SMTP messages. The default configuration file contains an example of
26669 a realistic ACL for checking RCPT commands. This is discussed in chapter
26670 &<<CHAPdefconfil>>&.
26671
26672
26673 .section "Testing ACLs" "SECID188"
26674 The &%-bh%& command line option provides a way of testing your ACL
26675 configuration locally by running a fake SMTP session with which you interact.
26676 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26677 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26678
26679
26680
26681 .section "Specifying when ACLs are used" "SECID189"
26682 .cindex "&ACL;" "options for specifying"
26683 In order to cause an ACL to be used, you have to name it in one of the relevant
26684 options in the main part of the configuration. These options are:
26685 .cindex "AUTH" "ACL for"
26686 .cindex "DATA" "ACLs for"
26687 .cindex "ETRN" "ACL for"
26688 .cindex "EXPN" "ACL for"
26689 .cindex "HELO" "ACL for"
26690 .cindex "EHLO" "ACL for"
26691 .cindex "MAIL" "ACL for"
26692 .cindex "QUIT, ACL for"
26693 .cindex "RCPT" "ACL for"
26694 .cindex "STARTTLS, ACL for"
26695 .cindex "VRFY" "ACL for"
26696 .cindex "SMTP" "connection, ACL for"
26697 .cindex "non-SMTP messages" "ACLs for"
26698 .cindex "MIME content scanning" "ACL for"
26699 .cindex "PRDR" "ACL for"
26700
26701 .table2 140pt
26702 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26703 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26704 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26705 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26706 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26707 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26708 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26709 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26710 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26711 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26712 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26713 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26714 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26715 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26716 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26717 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26718 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26719 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26720 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26721 .endtable
26722
26723 For example, if you set
26724 .code
26725 acl_smtp_rcpt = small_acl
26726 .endd
26727 the little ACL defined above is used whenever Exim receives a RCPT command
26728 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26729 done when RCPT commands arrive. A rejection of RCPT should cause the
26730 sending MTA to give up on the recipient address contained in the RCPT
26731 command, whereas rejection at other times may cause the client MTA to keep on
26732 trying to deliver the message. It is therefore recommended that you do as much
26733 testing as possible at RCPT time.
26734
26735
26736 .section "The non-SMTP ACLs" "SECID190"
26737 .cindex "non-SMTP messages" "ACLs for"
26738 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26739 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26740 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26741 the state of the SMTP connection such as encryption and authentication) are not
26742 relevant and are forbidden in these ACLs. However, the sender and recipients
26743 are known, so the &%senders%& and &%sender_domains%& conditions and the
26744 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26745 &$authenticated_sender$& are also available. You can specify added header lines
26746 in any of these ACLs.
26747
26748 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26749 non-SMTP message, before any of the message has been read. (This is the
26750 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26751 batched SMTP input, it runs after the DATA command has been reached. The
26752 result of this ACL is ignored; it cannot be used to reject a message. If you
26753 really need to, you could set a value in an ACL variable here and reject based
26754 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26755 controls, and in particular, it can be used to set
26756 .code
26757 control = suppress_local_fixups
26758 .endd
26759 This cannot be used in the other non-SMTP ACLs because by the time they are
26760 run, it is too late.
26761
26762 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26763 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26764
26765 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26766 kind of rejection is treated as permanent, because there is no way of sending a
26767 temporary error for these kinds of message.
26768
26769
26770 .section "The SMTP connect ACL" "SECID191"
26771 .cindex "SMTP" "connection, ACL for"
26772 .oindex &%smtp_banner%&
26773 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26774 session, after the test specified by &%host_reject_connection%& (which is now
26775 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26776 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26777 the message override the banner message that is otherwise specified by the
26778 &%smtp_banner%& option.
26779
26780
26781 .section "The EHLO/HELO ACL" "SECID192"
26782 .cindex "EHLO" "ACL for"
26783 .cindex "HELO" "ACL for"
26784 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26785 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26786 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26787 Note that a client may issue more than one EHLO or HELO command in an SMTP
26788 session, and indeed is required to issue a new EHLO or HELO after successfully
26789 setting up encryption following a STARTTLS command.
26790
26791 If the command is accepted by an &%accept%& verb that has a &%message%&
26792 modifier, the message may not contain more than one line (it will be truncated
26793 at the first newline and a panic logged if it does). Such a message cannot
26794 affect the EHLO options that are listed on the second and subsequent lines of
26795 an EHLO response.
26796
26797
26798 .section "The DATA ACLs" "SECID193"
26799 .cindex "DATA" "ACLs for"
26800 Two ACLs are associated with the DATA command, because it is two-stage
26801 command, with two responses being sent to the client.
26802 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26803 is obeyed. This gives you control after all the RCPT commands, but before
26804 the message itself is received. It offers the opportunity to give a negative
26805 response to the DATA command before the data is transmitted. Header lines
26806 added by MAIL or RCPT ACLs are not visible at this time, but any that
26807 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26808
26809 You cannot test the contents of the message, for example, to verify addresses
26810 in the headers, at RCPT time or when the DATA command is received. Such
26811 tests have to appear in the ACL that is run after the message itself has been
26812 received, before the final response to the DATA command is sent. This is
26813 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26814 associated with the DATA command.
26815
26816 For both of these ACLs, it is not possible to reject individual recipients. An
26817 error response rejects the entire message. Unfortunately, it is known that some
26818 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26819 before or after the data) correctly &-- they keep the message on their queues
26820 and try again later, but that is their problem, though it does waste some of
26821 your resources.
26822
26823 The &%acl_smtp_data%& ACL is run after
26824 the &%acl_smtp_data_prdr%&,
26825 the &%acl_smtp_dkim%&
26826 and the &%acl_smtp_mime%& ACLs.
26827
26828 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26829 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26830 enabled (which is the default).
26831
26832 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26833 received, and is executed for each DKIM signature found in a message.  If not
26834 otherwise specified, the default action is to accept.
26835
26836 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26837
26838 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26839
26840
26841 .section "The SMTP MIME ACL" "SECID194"
26842 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26843 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26844
26845 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26846
26847
26848 .section "The SMTP PRDR ACL" "SECTPRDRACL"
26849 .oindex "&%prdr_enable%&"
26850 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
26851 with PRDR support enabled (which is the default).
26852 It becomes active only when the PRDR feature is negotiated between
26853 client and server for a message, and more than one recipient
26854 has been accepted.
26855
26856 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
26857 has been recieved, and is executed for each recipient of the message.
26858 The test may accept or deny for inividual recipients.
26859 The &%acl_smtp_data%& will still be called after this ACL and
26860 can reject the message overall, even if this ACL has accepted it
26861 for some or all recipients.
26862
26863 PRDR may be used to support per-user content filtering.  Without it
26864 one must defer any recipient after the first that has a different
26865 content-filter configuration.  With PRDR, the RCPT-time check
26866 for this can be disabled when the MAIL-time $smtp_command included
26867 "PRDR".  Any required difference in behaviour of the main DATA-time
26868 ACL should however depend on the PRDR-time ACL having run, as Exim
26869 will avoid doing so in some situations (eg.  single-recipient mails).
26870
26871 See also the &%prdr_enable%& global option
26872 and the &%hosts_try_prdr%& smtp transport option.
26873
26874 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26875 If the ACL is not defined, processing completes as if
26876 the feature was not requested by the client.
26877
26878 .section "The QUIT ACL" "SECTQUITACL"
26879 .cindex "QUIT, ACL for"
26880 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26881 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26882 does not in fact control any access. For this reason, the only verbs that are
26883 permitted are &%accept%& and &%warn%&.
26884
26885 This ACL can be used for tasks such as custom logging at the end of an SMTP
26886 session. For example, you can use ACL variables in other ACLs to count
26887 messages, recipients, etc., and log the totals at QUIT time using one or
26888 more &%logwrite%& modifiers on a &%warn%& verb.
26889
26890 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26891 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26892
26893 You do not need to have a final &%accept%&, but if you do, you can use a
26894 &%message%& modifier to specify custom text that is sent as part of the 221
26895 response to QUIT.
26896
26897 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26898 failure (for example, failure to open a log file, or when Exim is bombing out
26899 because it has detected an unrecoverable error), all SMTP commands from the
26900 client are given temporary error responses until QUIT is received or the
26901 connection is closed. In these special cases, the QUIT ACL does not run.
26902
26903
26904 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26905 .vindex &$acl_smtp_notquit$&
26906 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26907 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26908 trouble, such as being unable to write to its log files, this ACL is not run,
26909 because it might try to do things (such as write to log files) that make the
26910 situation even worse.
26911
26912 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26913 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26914 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26915 and &%warn%&.
26916
26917 .vindex &$smtp_notquit_reason$&
26918 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26919 to a string that indicates the reason for the termination of the SMTP
26920 connection. The possible values are:
26921 .table2
26922 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26923 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26924 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26925 .irow &`connection-lost`&          "The SMTP connection has been lost"
26926 .irow &`data-timeout`&             "Timeout while reading message data"
26927 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26928 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26929 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26930 .irow &`synchronization-error`&    "SMTP synchronization error"
26931 .irow &`tls-failed`&               "TLS failed to start"
26932 .endtable
26933 In most cases when an SMTP connection is closed without having received QUIT,
26934 Exim sends an SMTP response message before actually closing the connection.
26935 With the exception of the &`acl-drop`& case, the default message can be
26936 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26937 &%drop%& verb in another ACL, it is the message from the other ACL that is
26938 used.
26939
26940
26941 .section "Finding an ACL to use" "SECID195"
26942 .cindex "&ACL;" "finding which to use"
26943 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26944 you can use different ACLs in different circumstances. For example,
26945 .code
26946 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26947                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26948 .endd
26949 In the default configuration file there are some example settings for
26950 providing an RFC 4409 message submission service on port 587 and a
26951 non-standard &"smtps"& service on port 465. You can use a string
26952 expansion like this to choose an ACL for MUAs on these ports which is
26953 more appropriate for this purpose than the default ACL on port 25.
26954
26955 The expanded string does not have to be the name of an ACL in the
26956 configuration file; there are other possibilities. Having expanded the
26957 string, Exim searches for an ACL as follows:
26958
26959 .ilist
26960 If the string begins with a slash, Exim uses it as a file name, and reads its
26961 contents as an ACL. The lines are processed in the same way as lines in the
26962 Exim configuration file. In particular, continuation lines are supported, blank
26963 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26964 If the file does not exist or cannot be read, an error occurs (typically
26965 causing a temporary failure of whatever caused the ACL to be run). For example:
26966 .code
26967 acl_smtp_data = /etc/acls/\
26968   ${lookup{$sender_host_address}lsearch\
26969   {/etc/acllist}{$value}{default}}
26970 .endd
26971 This looks up an ACL file to use on the basis of the host's IP address, falling
26972 back to a default if the lookup fails. If an ACL is successfully read from a
26973 file, it is retained in memory for the duration of the Exim process, so that it
26974 can be re-used without having to re-read the file.
26975 .next
26976 If the string does not start with a slash, and does not contain any spaces,
26977 Exim searches the ACL section of the configuration for an ACL whose name
26978 matches the string.
26979 .next
26980 If no named ACL is found, or if the string contains spaces, Exim parses
26981 the string as an inline ACL. This can save typing in cases where you just
26982 want to have something like
26983 .code
26984 acl_smtp_vrfy = accept
26985 .endd
26986 in order to allow free use of the VRFY command. Such a string may contain
26987 newlines; it is processed in the same way as an ACL that is read from a file.
26988 .endlist
26989
26990
26991
26992
26993 .section "ACL return codes" "SECID196"
26994 .cindex "&ACL;" "return codes"
26995 Except for the QUIT ACL, which does not affect the SMTP return code (see
26996 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26997 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26998 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26999 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27000 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27001 This also causes a 4&'xx'& return code.
27002
27003 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27004 &"deny"&, because there is no mechanism for passing temporary errors to the
27005 submitters of non-SMTP messages.
27006
27007
27008 ACLs that are relevant to message reception may also return &"discard"&. This
27009 has the effect of &"accept"&, but causes either the entire message or an
27010 individual recipient address to be discarded. In other words, it is a
27011 blackholing facility. Use it with care.
27012
27013 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27014 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27015 RCPT ACL is to discard just the one recipient address. If there are no
27016 recipients left when the message's data is received, the DATA ACL is not
27017 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27018 remaining recipients. The &"discard"& return is not permitted for the
27019 &%acl_smtp_predata%& ACL.
27020
27021
27022 .cindex "&[local_scan()]& function" "when all recipients discarded"
27023 The &[local_scan()]& function is always run, even if there are no remaining
27024 recipients; it may create new recipients.
27025
27026
27027
27028 .section "Unset ACL options" "SECID197"
27029 .cindex "&ACL;" "unset options"
27030 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27031 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27032 not defined at all. For any defined ACL, the default action when control
27033 reaches the end of the ACL statements is &"deny"&.
27034
27035 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27036 these two are ACLs that are used only for their side effects. They cannot be
27037 used to accept or reject anything.
27038
27039 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27040 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27041 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27042 when the ACL is not defined is &"accept"&.
27043
27044 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27045 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27046 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27047 messages over an SMTP connection. For an example, see the ACL in the default
27048 configuration file.
27049
27050
27051
27052
27053 .section "Data for message ACLs" "SECID198"
27054 .cindex "&ACL;" "data for message ACL"
27055 .vindex &$domain$&
27056 .vindex &$local_part$&
27057 .vindex &$sender_address$&
27058 .vindex &$sender_host_address$&
27059 .vindex &$smtp_command$&
27060 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27061 that contain information about the host and the message's sender (for example,
27062 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27063 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27064 &$local_part$& are set from the argument address. The entire SMTP command
27065 is available in &$smtp_command$&.
27066
27067 When an ACL for the AUTH parameter of MAIL is running, the variables that
27068 contain information about the host are set, but &$sender_address$& is not yet
27069 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27070 how it is used.
27071
27072 .vindex "&$message_size$&"
27073 The &$message_size$& variable is set to the value of the SIZE parameter on
27074 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27075 that parameter is not given. The value is updated to the true message size by
27076 the time the final DATA ACL is run (after the message data has been
27077 received).
27078
27079 .vindex "&$rcpt_count$&"
27080 .vindex "&$recipients_count$&"
27081 The &$rcpt_count$& variable increases by one for each RCPT command received.
27082 The &$recipients_count$& variable increases by one each time a RCPT command is
27083 accepted, so while an ACL for RCPT is being processed, it contains the number
27084 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27085 &$rcpt_count$& contains the total number of RCPT commands, and
27086 &$recipients_count$& contains the total number of accepted recipients.
27087
27088
27089
27090
27091
27092 .section "Data for non-message ACLs" "SECTdatfornon"
27093 .cindex "&ACL;" "data for non-message ACL"
27094 .vindex &$smtp_command_argument$&
27095 .vindex &$smtp_command$&
27096 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27097 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27098 and the entire SMTP command is available in &$smtp_command$&.
27099 These variables can be tested using a &%condition%& condition. For example,
27100 here is an ACL for use with AUTH, which insists that either the session is
27101 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27102 does not permit authentication methods that use cleartext passwords on
27103 unencrypted connections.
27104 .code
27105 acl_check_auth:
27106   accept encrypted = *
27107   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27108                      {CRAM-MD5}}
27109   deny   message   = TLS encryption or CRAM-MD5 required
27110 .endd
27111 (Another way of applying this restriction is to arrange for the authenticators
27112 that use cleartext passwords not to be advertised when the connection is not
27113 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27114 option to do this.)
27115
27116
27117
27118 .section "Format of an ACL" "SECID199"
27119 .cindex "&ACL;" "format of"
27120 .cindex "&ACL;" "verbs, definition of"
27121 An individual ACL consists of a number of statements. Each statement starts
27122 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27123 Modifiers can change the way the verb operates, define error and log messages,
27124 set variables, insert delays, and vary the processing of accepted messages.
27125
27126 If all the conditions are met, the verb is obeyed. The same condition may be
27127 used (with different arguments) more than once in the same statement. This
27128 provides a means of specifying an &"and"& conjunction between conditions. For
27129 example:
27130 .code
27131 deny  dnslists = list1.example
27132 dnslists = list2.example
27133 .endd
27134 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27135 the conditions and modifiers when it reaches a condition that fails. What
27136 happens then depends on the verb (and in one case, on a special modifier). Not
27137 all the conditions make sense at every testing point. For example, you cannot
27138 test a sender address in the ACL that is run for a VRFY command.
27139
27140
27141 .section "ACL verbs" "SECID200"
27142 The ACL verbs are as follows:
27143
27144 .ilist
27145 .cindex "&%accept%& ACL verb"
27146 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27147 of the conditions are not met, what happens depends on whether &%endpass%&
27148 appears among the conditions (for syntax see below). If the failing condition
27149 is before &%endpass%&, control is passed to the next ACL statement; if it is
27150 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27151 check a RCPT command:
27152 .code
27153 accept domains = +local_domains
27154 endpass
27155 verify = recipient
27156 .endd
27157 If the recipient domain does not match the &%domains%& condition, control
27158 passes to the next statement. If it does match, the recipient is verified, and
27159 the command is accepted if verification succeeds. However, if verification
27160 fails, the ACL yields &"deny"&, because the failing condition is after
27161 &%endpass%&.
27162
27163 The &%endpass%& feature has turned out to be confusing to many people, so its
27164 use is not recommended nowadays. It is always possible to rewrite an ACL so
27165 that &%endpass%& is not needed, and it is no longer used in the default
27166 configuration.
27167
27168 .cindex "&%message%& ACL modifier" "with &%accept%&"
27169 If a &%message%& modifier appears on an &%accept%& statement, its action
27170 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27171 (when an &%accept%& verb either accepts or passes control to the next
27172 statement), &%message%& can be used to vary the message that is sent when an
27173 SMTP command is accepted. For example, in a RCPT ACL you could have:
27174 .display
27175 &`accept  `&<&'some conditions'&>
27176 &`        message = OK, I will allow you through today`&
27177 .endd
27178 You can specify an SMTP response code, optionally followed by an &"extended
27179 response code"& at the start of the message, but the first digit must be the
27180 same as would be sent by default, which is 2 for an &%accept%& verb.
27181
27182 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27183 an error message that is used when access is denied. This behaviour is retained
27184 for backward compatibility, but current &"best practice"& is to avoid the use
27185 of &%endpass%&.
27186
27187
27188 .next
27189 .cindex "&%defer%& ACL verb"
27190 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27191 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27192 &%defer%& is the same as &%deny%&, because there is no way of sending a
27193 temporary error. For a RCPT command, &%defer%& is much the same as using a
27194 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27195 be used in any ACL, and even for a recipient it might be a simpler approach.
27196
27197
27198 .next
27199 .cindex "&%deny%& ACL verb"
27200 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27201 the conditions are not met, control is passed to the next ACL statement. For
27202 example,
27203 .code
27204 deny dnslists = blackholes.mail-abuse.org
27205 .endd
27206 rejects commands from hosts that are on a DNS black list.
27207
27208
27209 .next
27210 .cindex "&%discard%& ACL verb"
27211 &%discard%&: This verb behaves like &%accept%&, except that it returns
27212 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27213 that are concerned with receiving messages. When all the conditions are true,
27214 the sending entity receives a &"success"& response. However, &%discard%& causes
27215 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27216 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27217 message's recipients are discarded. Recipients that are discarded before DATA
27218 do not appear in the log line when the &%received_recipients%& log selector is set.
27219
27220 If the &%log_message%& modifier is set when &%discard%& operates,
27221 its contents are added to the line that is automatically written to the log.
27222 The &%message%& modifier operates exactly as it does for &%accept%&.
27223
27224
27225 .next
27226 .cindex "&%drop%& ACL verb"
27227 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27228 forcibly closed after the 5&'xx'& error message has been sent. For example:
27229 .code
27230 drop   message   = I don't take more than 20 RCPTs
27231        condition = ${if > {$rcpt_count}{20}}
27232 .endd
27233 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27234 The connection is always dropped after sending a 550 response.
27235
27236 .next
27237 .cindex "&%require%& ACL verb"
27238 &%require%&: If all the conditions are met, control is passed to the next ACL
27239 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27240 example, when checking a RCPT command,
27241 .code
27242 require message = Sender did not verify
27243         verify  = sender
27244 .endd
27245 passes control to subsequent statements only if the message's sender can be
27246 verified. Otherwise, it rejects the command. Note the positioning of the
27247 &%message%& modifier, before the &%verify%& condition. The reason for this is
27248 discussed in section &<<SECTcondmodproc>>&.
27249
27250 .next
27251 .cindex "&%warn%& ACL verb"
27252 &%warn%&: If all the conditions are true, a line specified by the
27253 &%log_message%& modifier is written to Exim's main log. Control always passes
27254 to the next ACL statement. If any condition is false, the log line is not
27255 written. If an identical log line is requested several times in the same
27256 message, only one copy is actually written to the log. If you want to force
27257 duplicates to be written, use the &%logwrite%& modifier instead.
27258
27259 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27260 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27261 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27262 first failing condition. There is more about adding header lines in section
27263 &<<SECTaddheadacl>>&.
27264
27265 If any condition on a &%warn%& statement cannot be completed (that is, there is
27266 some sort of defer), the log line specified by &%log_message%& is not written.
27267 This does not include the case of a forced failure from a lookup, which
27268 is considered to be a successful completion. After a defer, no further
27269 conditions or modifiers in the &%warn%& statement are processed. The incident
27270 is logged, and the ACL continues to be processed, from the next statement
27271 onwards.
27272
27273
27274 .vindex "&$acl_verify_message$&"
27275 When one of the &%warn%& conditions is an address verification that fails, the
27276 text of the verification failure message is in &$acl_verify_message$&. If you
27277 want this logged, you must set it up explicitly. For example:
27278 .code
27279 warn   !verify = sender
27280        log_message = sender verify failed: $acl_verify_message
27281 .endd
27282 .endlist
27283
27284 At the end of each ACL there is an implicit unconditional &%deny%&.
27285
27286 As you can see from the examples above, the conditions and modifiers are
27287 written one to a line, with the first one on the same line as the verb, and
27288 subsequent ones on following lines. If you have a very long condition, you can
27289 continue it onto several physical lines by the usual backslash continuation
27290 mechanism. It is conventional to align the conditions vertically.
27291
27292
27293
27294 .section "ACL variables" "SECTaclvariables"
27295 .cindex "&ACL;" "variables"
27296 There are some special variables that can be set during ACL processing. They
27297 can be used to pass information between different ACLs, different invocations
27298 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27299 transports, and filters that are used to deliver a message. The names of these
27300 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27301 an underscore, but the remainder of the name can be any sequence of
27302 alphanumeric characters and underscores that you choose. There is no limit on
27303 the number of ACL variables. The two sets act as follows:
27304 .ilist
27305 The values of those variables whose names begin with &$acl_c$& persist
27306 throughout an SMTP connection. They are never reset. Thus, a value that is set
27307 while receiving one message is still available when receiving the next message
27308 on the same SMTP connection.
27309 .next
27310 The values of those variables whose names begin with &$acl_m$& persist only
27311 while a message is being received. They are reset afterwards. They are also
27312 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27313 .endlist
27314
27315 When a message is accepted, the current values of all the ACL variables are
27316 preserved with the message and are subsequently made available at delivery
27317 time. The ACL variables are set by a modifier called &%set%&. For example:
27318 .code
27319 accept hosts = whatever
27320        set acl_m4 = some value
27321 accept authenticated = *
27322        set acl_c_auth = yes
27323 .endd
27324 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27325 be set. If you want to set a variable without taking any action, you can use a
27326 &%warn%& verb without any other modifiers or conditions.
27327
27328 .oindex &%strict_acl_vars%&
27329 What happens if a syntactically valid but undefined ACL variable is
27330 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27331 false (the default), an empty string is substituted; if it is true, an
27332 error is generated.
27333
27334 Versions of Exim before 4.64 have a limited set of numbered variables, but
27335 their names are compatible, so there is no problem with upgrading.
27336
27337
27338 .section "Condition and modifier processing" "SECTcondmodproc"
27339 .cindex "&ACL;" "conditions; processing"
27340 .cindex "&ACL;" "modifiers; processing"
27341 An exclamation mark preceding a condition negates its result. For example:
27342 .code
27343 deny   domains = *.dom.example
27344       !verify  = recipient
27345 .endd
27346 causes the ACL to return &"deny"& if the recipient domain ends in
27347 &'dom.example'& and the recipient address cannot be verified. Sometimes
27348 negation can be used on the right-hand side of a condition. For example, these
27349 two statements are equivalent:
27350 .code
27351 deny  hosts = !192.168.3.4
27352 deny !hosts =  192.168.3.4
27353 .endd
27354 However, for many conditions (&%verify%& being a good example), only left-hand
27355 side negation of the whole condition is possible.
27356
27357 The arguments of conditions and modifiers are expanded. A forced failure
27358 of an expansion causes a condition to be ignored, that is, it behaves as if the
27359 condition is true. Consider these two statements:
27360 .code
27361 accept  senders = ${lookup{$host_name}lsearch\
27362                   {/some/file}{$value}fail}
27363 accept  senders = ${lookup{$host_name}lsearch\
27364                   {/some/file}{$value}{}}
27365 .endd
27366 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27367 the returned list is searched, but if the lookup fails the behaviour is
27368 different in the two cases. The &%fail%& in the first statement causes the
27369 condition to be ignored, leaving no further conditions. The &%accept%& verb
27370 therefore succeeds. The second statement, however, generates an empty list when
27371 the lookup fails. No sender can match an empty list, so the condition fails,
27372 and therefore the &%accept%& also fails.
27373
27374 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27375 specify actions that are taken as the conditions for a statement are checked;
27376 others specify text for messages that are used when access is denied or a
27377 warning is generated. The &%control%& modifier affects the way an incoming
27378 message is handled.
27379
27380 The positioning of the modifiers in an ACL statement is important, because the
27381 processing of a verb ceases as soon as its outcome is known. Only those
27382 modifiers that have already been encountered will take effect. For example,
27383 consider this use of the &%message%& modifier:
27384 .code
27385 require message = Can't verify sender
27386         verify  = sender
27387         message = Can't verify recipient
27388         verify  = recipient
27389         message = This message cannot be used
27390 .endd
27391 If sender verification fails, Exim knows that the result of the statement is
27392 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27393 so its text is used as the error message. If sender verification succeeds, but
27394 recipient verification fails, the second message is used. If recipient
27395 verification succeeds, the third message becomes &"current"&, but is never used
27396 because there are no more conditions to cause failure.
27397
27398 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27399 modifier that is used, because all the conditions must be true for rejection to
27400 happen. Specifying more than one &%message%& modifier does not make sense, and
27401 the message can even be specified after all the conditions. For example:
27402 .code
27403 deny   hosts = ...
27404       !senders = *@my.domain.example
27405        message = Invalid sender from client host
27406 .endd
27407 The &"deny"& result does not happen until the end of the statement is reached,
27408 by which time Exim has set up the message.
27409
27410
27411
27412 .section "ACL modifiers" "SECTACLmodi"
27413 .cindex "&ACL;" "modifiers; list of"
27414 The ACL modifiers are as follows:
27415
27416 .vlist
27417 .vitem &*add_header*&&~=&~<&'text'&>
27418 This modifier specifies one or more header lines that are to be added to an
27419 incoming message, assuming, of course, that the message is ultimately
27420 accepted. For details, see section &<<SECTaddheadacl>>&.
27421
27422 .vitem &*continue*&&~=&~<&'text'&>
27423 .cindex "&%continue%& ACL modifier"
27424 .cindex "database" "updating in ACL"
27425 This modifier does nothing of itself, and processing of the ACL always
27426 continues with the next condition or modifier. The value of &%continue%& is in
27427 the side effects of expanding its argument. Typically this could be used to
27428 update a database. It is really just a syntactic tidiness, to avoid having to
27429 write rather ugly lines like this:
27430 .display
27431 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27432 .endd
27433 Instead, all you need is
27434 .display
27435 &`continue = `&<&'some expansion'&>
27436 .endd
27437
27438 .vitem &*control*&&~=&~<&'text'&>
27439 .cindex "&%control%& ACL modifier"
27440 This modifier affects the subsequent processing of the SMTP connection or of an
27441 incoming message that is accepted. The effect of the first type of control
27442 lasts for the duration of the connection, whereas the effect of the second type
27443 lasts only until the current message has been received. The message-specific
27444 controls always apply to the whole message, not to individual recipients,
27445 even if the &%control%& modifier appears in a RCPT ACL.
27446
27447 As there are now quite a few controls that can be applied, they are described
27448 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27449 in several different ways. For example:
27450
27451 . ==== As this is a nested list, any displays it contains must be indented
27452 . ==== as otherwise they are too far to the left. That comment applies only
27453 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27454 . ==== way.
27455
27456 .ilist
27457 It can be at the end of an &%accept%& statement:
27458 .code
27459     accept  ...some conditions
27460             control = queue_only
27461 .endd
27462 In this case, the control is applied when this statement yields &"accept"&, in
27463 other words, when the conditions are all true.
27464
27465 .next
27466 It can be in the middle of an &%accept%& statement:
27467 .code
27468     accept  ...some conditions...
27469             control = queue_only
27470             ...some more conditions...
27471 .endd
27472 If the first set of conditions are true, the control is applied, even if the
27473 statement does not accept because one of the second set of conditions is false.
27474 In this case, some subsequent statement must yield &"accept"& for the control
27475 to be relevant.
27476
27477 .next
27478 It can be used with &%warn%& to apply the control, leaving the
27479 decision about accepting or denying to a subsequent verb. For
27480 example:
27481 .code
27482     warn    ...some conditions...
27483             control = freeze
27484     accept  ...
27485 .endd
27486 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27487 &%logwrite%&, so it does not add anything to the message and does not write a
27488 log entry.
27489
27490 .next
27491 If you want to apply a control unconditionally, you can use it with a
27492 &%require%& verb. For example:
27493 .code
27494     require  control = no_multiline_responses
27495 .endd
27496 .endlist
27497
27498 .vitem &*delay*&&~=&~<&'time'&>
27499 .cindex "&%delay%& ACL modifier"
27500 .oindex "&%-bh%&"
27501 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27502 the time interval before proceeding. However, when testing Exim using the
27503 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27504 output instead). The time is given in the usual Exim notation, and the delay
27505 happens as soon as the modifier is processed. In an SMTP session, pending
27506 output is flushed before the delay is imposed.
27507
27508 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27509 example:
27510 .code
27511 deny    ...some conditions...
27512         delay = 30s
27513 .endd
27514 The delay happens if all the conditions are true, before the statement returns
27515 &"deny"&. Compare this with:
27516 .code
27517 deny    delay = 30s
27518         ...some conditions...
27519 .endd
27520 which waits for 30s before processing the conditions. The &%delay%& modifier
27521 can also be used with &%warn%& and together with &%control%&:
27522 .code
27523 warn    ...some conditions...
27524         delay = 2m
27525         control = freeze
27526 accept  ...
27527 .endd
27528
27529 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27530 responses to several commands are no longer buffered and sent in one packet (as
27531 they would normally be) because all output is flushed before imposing the
27532 delay. This optimization is disabled so that a number of small delays do not
27533 appear to the client as one large aggregated delay that might provoke an
27534 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27535 using a &%control%& modifier to set &%no_delay_flush%&.
27536
27537
27538 .vitem &*endpass*&
27539 .cindex "&%endpass%& ACL modifier"
27540 This modifier, which has no argument, is recognized only in &%accept%& and
27541 &%discard%& statements. It marks the boundary between the conditions whose
27542 failure causes control to pass to the next statement, and the conditions whose
27543 failure causes the ACL to return &"deny"&. This concept has proved to be
27544 confusing to some people, so the use of &%endpass%& is no longer recommended as
27545 &"best practice"&. See the description of &%accept%& above for more details.
27546
27547
27548 .vitem &*log_message*&&~=&~<&'text'&>
27549 .cindex "&%log_message%& ACL modifier"
27550 This modifier sets up a message that is used as part of the log message if the
27551 ACL denies access or a &%warn%& statement's conditions are true. For example:
27552 .code
27553 require log_message = wrong cipher suite $tls_in_cipher
27554         encrypted   = DES-CBC3-SHA
27555 .endd
27556 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27557 example:
27558 .display
27559 &`discard `&<&'some conditions'&>
27560 &`        log_message = Discarded $local_part@$domain because...`&
27561 .endd
27562 When access is denied, &%log_message%& adds to any underlying error message
27563 that may exist because of a condition failure. For example, while verifying a
27564 recipient address, a &':fail:'& redirection might have already set up a
27565 message.
27566
27567 The message may be defined before the conditions to which it applies, because
27568 the string expansion does not happen until Exim decides that access is to be
27569 denied. This means that any variables that are set by the condition are
27570 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27571 variables are set after a DNS black list lookup succeeds. If the expansion of
27572 &%log_message%& fails, or if the result is an empty string, the modifier is
27573 ignored.
27574
27575 .vindex "&$acl_verify_message$&"
27576 If you want to use a &%warn%& statement to log the result of an address
27577 verification, you can use &$acl_verify_message$& to include the verification
27578 error message.
27579
27580 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27581 the start of the logged message. If the same warning log message is requested
27582 more than once while receiving  a single email message, only one copy is
27583 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27584 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27585 is logged for a successful &%warn%& statement.
27586
27587 If &%log_message%& is not present and there is no underlying error message (for
27588 example, from the failure of address verification), but &%message%& is present,
27589 the &%message%& text is used for logging rejections. However, if any text for
27590 logging contains newlines, only the first line is logged. In the absence of
27591 both &%log_message%& and &%message%&, a default built-in message is used for
27592 logging rejections.
27593
27594
27595 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27596 .cindex "&%log_reject_target%& ACL modifier"
27597 .cindex "logging in ACL" "specifying which log"
27598 This modifier makes it possible to specify which logs are used for messages
27599 about ACL rejections. Its argument is a colon-separated list of words that can
27600 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27601 may be empty, in which case a rejection is not logged at all. For example, this
27602 ACL fragment writes no logging information when access is denied:
27603 .display
27604 &`deny `&<&'some conditions'&>
27605 &`     log_reject_target =`&
27606 .endd
27607 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27608 permanent and temporary rejections. Its effect lasts for the rest of the
27609 current ACL.
27610
27611
27612 .vitem &*logwrite*&&~=&~<&'text'&>
27613 .cindex "&%logwrite%& ACL modifier"
27614 .cindex "logging in ACL" "immediate"
27615 This modifier writes a message to a log file as soon as it is encountered when
27616 processing an ACL. (Compare &%log_message%&, which, except in the case of
27617 &%warn%& and &%discard%&, is used only if the ACL statement denies
27618 access.) The &%logwrite%& modifier can be used to log special incidents in
27619 ACLs. For example:
27620 .display
27621 &`accept `&<&'some special conditions'&>
27622 &`       control  = freeze`&
27623 &`       logwrite = froze message because ...`&
27624 .endd
27625 By default, the message is written to the main log. However, it may begin
27626 with a colon, followed by a comma-separated list of log names, and then
27627 another colon, to specify exactly which logs are to be written. For
27628 example:
27629 .code
27630 logwrite = :main,reject: text for main and reject logs
27631 logwrite = :panic: text for panic log only
27632 .endd
27633
27634
27635 .vitem &*message*&&~=&~<&'text'&>
27636 .cindex "&%message%& ACL modifier"
27637 This modifier sets up a text string that is expanded and used as a response
27638 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27639 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27640 there is some complication if &%endpass%& is involved; see the description of
27641 &%accept%& for details.)
27642
27643 The expansion of the message happens at the time Exim decides that the ACL is
27644 to end, not at the time it processes &%message%&. If the expansion fails, or
27645 generates an empty string, the modifier is ignored. Here is an example where
27646 &%message%& must be specified first, because the ACL ends with a rejection if
27647 the &%hosts%& condition fails:
27648 .code
27649 require  message = Host not recognized
27650          hosts = 10.0.0.0/8
27651 .endd
27652 (Once a condition has failed, no further conditions or modifiers are
27653 processed.)
27654
27655 .cindex "SMTP" "error codes"
27656 .oindex "&%smtp_banner%&
27657 For ACLs that are triggered by SMTP commands, the message is returned as part
27658 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27659 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27660 is accepted. In the case of the connect ACL, accepting with a message modifier
27661 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27662 accept message may not contain more than one line (otherwise it will be
27663 truncated at the first newline and a panic logged), and it cannot affect the
27664 EHLO options.
27665
27666 When SMTP is involved, the message may begin with an overriding response code,
27667 consisting of three digits optionally followed by an &"extended response code"&
27668 of the form &'n.n.n'&, each code being followed by a space. For example:
27669 .code
27670 deny  message = 599 1.2.3 Host not welcome
27671       hosts = 192.168.34.0/24
27672 .endd
27673 The first digit of the supplied response code must be the same as would be sent
27674 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27675 access, but for the predata ACL, note that the default success code is 354, not
27676 2&'xx'&.
27677
27678 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27679 the message modifier cannot override the 221 response code.
27680
27681 The text in a &%message%& modifier is literal; any quotes are taken as
27682 literals, but because the string is expanded, backslash escapes are processed
27683 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27684 response.
27685
27686 .vindex "&$acl_verify_message$&"
27687 .new
27688 For ACLs that are called by an &%acl =%& ACL condition, the message is
27689 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27690 .wen
27691
27692 If &%message%& is used on a statement that verifies an address, the message
27693 specified overrides any message that is generated by the verification process.
27694 However, the original message is available in the variable
27695 &$acl_verify_message$&, so you can incorporate it into your message if you
27696 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27697 routers to be passed back as part of the SMTP response, you should either not
27698 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27699
27700 For compatibility with previous releases of Exim, a &%message%& modifier that
27701 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27702 modifier, but this usage is now deprecated. However, &%message%& acts only when
27703 all the conditions are true, wherever it appears in an ACL command, whereas
27704 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27705 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27706 effect.
27707
27708
27709 .vitem &*remove_header*&&~=&~<&'text'&>
27710 This modifier specifies one or more header names in a colon-separated list
27711  that are to be removed from an incoming message, assuming, of course, that
27712 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27713
27714
27715 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27716 .cindex "&%set%& ACL modifier"
27717 This modifier puts a value into one of the ACL variables (see section
27718 &<<SECTaclvariables>>&).
27719
27720
27721 .vitem &*udpsend*&&~=&~<&'parameters'&>
27722 This modifier sends a UDP packet, for purposes such as statistics
27723 collection or behaviour monitoring. The parameters are expanded, and
27724 the result of the expansion must be a colon-separated list consisting
27725 of a destination server, port number, and the packet contents. The
27726 server can be specified as a host name or IPv4 or IPv6 address. The
27727 separator can be changed with the usual angle bracket syntax. For
27728 example, you might want to collect information on which hosts connect
27729 when:
27730 .code
27731 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27732              $tod_zulu $sender_host_address
27733 .endd
27734 .endlist
27735
27736
27737
27738
27739 .section "Use of the control modifier" "SECTcontrols"
27740 .cindex "&%control%& ACL modifier"
27741 The &%control%& modifier supports the following settings:
27742
27743 .vlist
27744 .vitem &*control&~=&~allow_auth_unadvertised*&
27745 This modifier allows a client host to use the SMTP AUTH command even when it
27746 has not been advertised in response to EHLO. Furthermore, because there are
27747 apparently some really broken clients that do this, Exim will accept AUTH after
27748 HELO (rather than EHLO) when this control is set. It should be used only if you
27749 really need it, and you should limit its use to those broken clients that do
27750 not work without it. For example:
27751 .code
27752 warn hosts   = 192.168.34.25
27753      control = allow_auth_unadvertised
27754 .endd
27755 Normally, when an Exim server receives an AUTH command, it checks the name of
27756 the authentication mechanism that is given in the command to ensure that it
27757 matches an advertised mechanism. When this control is set, the check that a
27758 mechanism has been advertised is bypassed. Any configured mechanism can be used
27759 by the client. This control is permitted only in the connection and HELO ACLs.
27760
27761
27762 .vitem &*control&~=&~caseful_local_part*& &&&
27763        &*control&~=&~caselower_local_part*&
27764 .cindex "&ACL;" "case of local part in"
27765 .cindex "case of local parts"
27766 .vindex "&$local_part$&"
27767 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27768 (that is, during RCPT processing). By default, the contents of &$local_part$&
27769 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27770 any uppercase letters in the original local part are restored in &$local_part$&
27771 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27772 is encountered.
27773
27774 These controls affect only the current recipient. Moreover, they apply only to
27775 local part handling that takes place directly in the ACL (for example, as a key
27776 in lookups). If a test to verify the recipient is obeyed, the case-related
27777 handling of the local part during the verification is controlled by the router
27778 configuration (see the &%caseful_local_part%& generic router option).
27779
27780 This facility could be used, for example, to add a spam score to local parts
27781 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27782 spam score:
27783 .code
27784 warn  control = caseful_local_part
27785       set acl_m4 = ${eval:\
27786                      $acl_m4 + \
27787                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27788                     }
27789       control = caselower_local_part
27790 .endd
27791 Notice that we put back the lower cased version afterwards, assuming that
27792 is what is wanted for subsequent tests.
27793
27794
27795 .vitem &*control&~=&~cutthrough_delivery*&
27796 .cindex "&ACL;" "cutthrough routing"
27797 .cindex "cutthrough" "requesting"
27798 This option requests delivery be attempted while the item is being received.
27799 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27800 from one SMTP connection to another.  If a recipient-verify callout connection is
27801 requested in the same ACL it is held open and used for the data, otherwise one is made
27802 after the ACL completes.
27803
27804 Note that routers are used in verify mode,
27805 and cannot depend on content of received headers.
27806 Note also that headers cannot be
27807 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27808 Headers may be modified by routers (subject to the above) and transports.
27809
27810 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27811 of outgoing messages is done, because it sends data to the ultimate destination
27812 before the entire message has been received from the source.
27813
27814 Should the ultimate destination system positively accept or reject the mail,
27815 a corresponding indication is given to the source system and nothing is queued.
27816 If there is a temporary error the item is queued for later delivery in the
27817 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27818 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27819 line.
27820
27821 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27822 sender when the destination system is doing content-scan based rejection.
27823
27824
27825 .vitem &*control&~=&~debug/*&<&'options'&>
27826 .cindex "&ACL;" "enabling debug logging"
27827 .cindex "debugging" "enabling from an ACL"
27828 This control turns on debug logging, almost as though Exim had been invoked
27829 with &`-d`&, with the output going to a new logfile, by default called
27830 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27831 may access any variables already defined.  The logging may be adjusted with
27832 the &'opts'& option, which takes the same values as the &`-d`& command-line
27833 option.  Some examples (which depend on variables that don't exist in all
27834 contexts):
27835 .code
27836       control = debug
27837       control = debug/tag=.$sender_host_address
27838       control = debug/opts=+expand+acl
27839       control = debug/tag=.$message_exim_id/opts=+expand
27840 .endd
27841
27842
27843 .vitem &*control&~=&~dkim_disable_verify*&
27844 .cindex "disable DKIM verify"
27845 .cindex "DKIM" "disable verify"
27846 This control turns off DKIM verification processing entirely.  For details on
27847 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27848
27849
27850 .vitem &*control&~=&~dscp/*&<&'value'&>
27851 .cindex "&ACL;" "setting DSCP value"
27852 .cindex "DSCP" "inbound"
27853 This option causes the DSCP value associated with the socket for the inbound
27854 connection to be adjusted to a given value, given as one of a number of fixed
27855 strings or to numeric value.
27856 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27857 Common values include &`throughput`&, &`mincost`&, and on newer systems
27858 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27859
27860 The outbound packets from Exim will be marked with this value in the header
27861 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27862 that these values will have any effect, not be stripped by networking
27863 equipment, or do much of anything without cooperation with your Network
27864 Engineer and those of all network operators between the source and destination.
27865
27866
27867 .vitem &*control&~=&~enforce_sync*& &&&
27868        &*control&~=&~no_enforce_sync*&
27869 .cindex "SMTP" "synchronization checking"
27870 .cindex "synchronization checking in SMTP"
27871 These controls make it possible to be selective about when SMTP synchronization
27872 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27873 state of the switch (it is true by default). See the description of this option
27874 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27875
27876 The effect of these two controls lasts for the remainder of the SMTP
27877 connection. They can appear in any ACL except the one for the non-SMTP
27878 messages. The most straightforward place to put them is in the ACL defined by
27879 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27880 before the first synchronization check. The expected use is to turn off the
27881 synchronization checks for badly-behaved hosts that you nevertheless need to
27882 work with.
27883
27884
27885 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27886 .cindex "fake defer"
27887 .cindex "defer, fake"
27888 This control works in exactly the same way as &%fakereject%& (described below)
27889 except that it causes an SMTP 450 response after the message data instead of a
27890 550 response. You must take care when using &%fakedefer%& because it causes the
27891 messages to be duplicated when the sender retries. Therefore, you should not
27892 use &%fakedefer%& if the message is to be delivered normally.
27893
27894 .vitem &*control&~=&~fakereject/*&<&'message'&>
27895 .cindex "fake rejection"
27896 .cindex "rejection, fake"
27897 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27898 words, only when an SMTP message is being received. If Exim accepts the
27899 message, instead the final 250 response, a 550 rejection message is sent.
27900 However, Exim proceeds to deliver the message as normal. The control applies
27901 only to the current message, not to any subsequent ones that may be received in
27902 the same SMTP connection.
27903
27904 The text for the 550 response is taken from the &%control%& modifier. If no
27905 message is supplied, the following is used:
27906 .code
27907 550-Your message has been rejected but is being
27908 550-kept for evaluation.
27909 550-If it was a legitimate message, it may still be
27910 550 delivered to the target recipient(s).
27911 .endd
27912 This facility should be used with extreme caution.
27913
27914 .vitem &*control&~=&~freeze*&
27915 .cindex "frozen messages" "forcing in ACL"
27916 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27917 other words, only when a message is being received. If the message is accepted,
27918 it is placed on Exim's queue and frozen. The control applies only to the
27919 current message, not to any subsequent ones that may be received in the same
27920 SMTP connection.
27921
27922 This modifier can optionally be followed by &`/no_tell`&. If the global option
27923 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27924 is told about the freezing), provided all the &*control=freeze*& modifiers that
27925 are obeyed for the current message have the &`/no_tell`& option.
27926
27927 .vitem &*control&~=&~no_delay_flush*&
27928 .cindex "SMTP" "output flushing, disabling for delay"
27929 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27930 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27931 use. This control, as long as it is encountered before the &%delay%& modifier,
27932 disables such output flushing.
27933
27934 .vitem &*control&~=&~no_callout_flush*&
27935 .cindex "SMTP" "output flushing, disabling for callout"
27936 Exim normally flushes SMTP output before performing a callout in an ACL, to
27937 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27938 use. This control, as long as it is encountered before the &%verify%& condition
27939 that causes the callout, disables such output flushing.
27940
27941 .vitem &*control&~=&~no_mbox_unspool*&
27942 This control is available when Exim is compiled with the content scanning
27943 extension. Content scanning may require a copy of the current message, or parts
27944 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27945 or spam scanner. Normally, such copies are deleted when they are no longer
27946 needed. If this control is set, the copies are not deleted. The control applies
27947 only to the current message, not to any subsequent ones that may be received in
27948 the same SMTP connection. It is provided for debugging purposes and is unlikely
27949 to be useful in production.
27950
27951 .vitem &*control&~=&~no_multiline_responses*&
27952 .cindex "multiline responses, suppressing"
27953 This control is permitted for any ACL except the one for non-SMTP messages.
27954 It seems that there are broken clients in use that cannot handle multiline
27955 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27956
27957 If this control is set, multiline SMTP responses from ACL rejections are
27958 suppressed. One way of doing this would have been to put out these responses as
27959 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27960 (&"use multiline responses for more"& it says &-- ha!), and some of the
27961 responses might get close to that. So this facility, which is after all only a
27962 sop to broken clients, is implemented by doing two very easy things:
27963
27964 .ilist
27965 Extra information that is normally output as part of a rejection caused by
27966 sender verification failure is omitted. Only the final line (typically &"sender
27967 verification failed"&) is sent.
27968 .next
27969 If a &%message%& modifier supplies a multiline response, only the first
27970 line is output.
27971 .endlist
27972
27973 The setting of the switch can, of course, be made conditional on the
27974 calling host. Its effect lasts until the end of the SMTP connection.
27975
27976 .vitem &*control&~=&~no_pipelining*&
27977 .cindex "PIPELINING" "suppressing advertising"
27978 This control turns off the advertising of the PIPELINING extension to SMTP in
27979 the current session. To be useful, it must be obeyed before Exim sends its
27980 response to an EHLO command. Therefore, it should normally appear in an ACL
27981 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27982 &%pipelining_advertise_hosts%&.
27983
27984 .vitem &*control&~=&~queue_only*&
27985 .oindex "&%queue_only%&"
27986 .cindex "queueing incoming messages"
27987 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27988 other words, only when a message is being received. If the message is accepted,
27989 it is placed on Exim's queue and left there for delivery by a subsequent queue
27990 runner. No immediate delivery process is started. In other words, it has the
27991 effect as the &%queue_only%& global option. However, the control applies only
27992 to the current message, not to any subsequent ones that may be received in the
27993 same SMTP connection.
27994
27995 .vitem &*control&~=&~submission/*&<&'options'&>
27996 .cindex "message" "submission"
27997 .cindex "submission mode"
27998 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27999 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28000 the current message is a submission from a local MUA. In this case, Exim
28001 operates in &"submission mode"&, and applies certain fixups to the message if
28002 necessary. For example, it adds a &'Date:'& header line if one is not present.
28003 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28004 late (the message has already been created).
28005
28006 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28007 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28008 submission mode; the available options for this control are described there.
28009 The control applies only to the current message, not to any subsequent ones
28010 that may be received in the same SMTP connection.
28011
28012 .vitem &*control&~=&~suppress_local_fixups*&
28013 .cindex "submission fixups, suppressing"
28014 This control applies to locally submitted (non TCP/IP) messages, and is the
28015 complement of &`control = submission`&. It disables the fixups that are
28016 normally applied to locally-submitted messages. Specifically:
28017
28018 .ilist
28019 Any &'Sender:'& header line is left alone (in this respect, it is a
28020 dynamic version of &%local_sender_retain%&).
28021 .next
28022 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28023 .next
28024 There is no check that &'From:'& corresponds to the actual sender.
28025 .endlist ilist
28026
28027 This control may be useful when a remotely-originated message is accepted,
28028 passed to some scanning program, and then re-submitted for delivery. It can be
28029 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28030 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28031 data is read.
28032
28033 &*Note:*& This control applies only to the current message, not to any others
28034 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28035 .endlist vlist
28036
28037
28038 .section "Summary of message fixup control" "SECTsummesfix"
28039 All four possibilities for message fixups can be specified:
28040
28041 .ilist
28042 Locally submitted, fixups applied: the default.
28043 .next
28044 Locally submitted, no fixups applied: use
28045 &`control = suppress_local_fixups`&.
28046 .next
28047 Remotely submitted, no fixups applied: the default.
28048 .next
28049 Remotely submitted, fixups applied: use &`control = submission`&.
28050 .endlist
28051
28052
28053
28054 .section "Adding header lines in ACLs" "SECTaddheadacl"
28055 .cindex "header lines" "adding in an ACL"
28056 .cindex "header lines" "position of added lines"
28057 .cindex "&%add_header%& ACL modifier"
28058 The &%add_header%& modifier can be used to add one or more extra header lines
28059 to an incoming message, as in this example:
28060 .code
28061 warn dnslists = sbl.spamhaus.org : \
28062                 dialup.mail-abuse.org
28063      add_header = X-blacklisted-at: $dnslist_domain
28064 .endd
28065 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28066 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28067 receiving a message). The message must ultimately be accepted for
28068 &%add_header%& to have any significant effect. You can use &%add_header%& with
28069 any ACL verb, including &%deny%& (though this is potentially useful only in a
28070 RCPT ACL).
28071
28072 Headers will not be added to the message if the modifier is used in
28073 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28074
28075 Leading and trailing newlines are removed from
28076 the data for the &%add_header%& modifier; if it then
28077 contains one or more newlines that
28078 are not followed by a space or a tab, it is assumed to contain multiple header
28079 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28080 front of any line that is not a valid header line.
28081
28082 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28083 They are added to the message before processing the DATA and MIME ACLs.
28084 However, if an identical header line is requested more than once, only one copy
28085 is actually added to the message. Further header lines may be accumulated
28086 during the DATA and MIME ACLs, after which they are added to the message, again
28087 with duplicates suppressed. Thus, it is possible to add two identical header
28088 lines to an SMTP message, but only if one is added before DATA and one after.
28089 In the case of non-SMTP messages, new headers are accumulated during the
28090 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28091 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28092 are included in the entry that is written to the reject log.
28093
28094 .cindex "header lines" "added; visibility of"
28095 Header lines are not visible in string expansions
28096 of message headers
28097 until they are added to the
28098 message. It follows that header lines defined in the MAIL, RCPT, and predata
28099 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28100 header lines that are added by the DATA or MIME ACLs are not visible in those
28101 ACLs. Because of this restriction, you cannot use header lines as a way of
28102 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28103 this, you can use ACL variables, as described in section
28104 &<<SECTaclvariables>>&.
28105
28106 The list of headers yet to be added is given by the &%$headers_added%& variable.
28107
28108 The &%add_header%& modifier acts immediately as it is encountered during the
28109 processing of an ACL. Notice the difference between these two cases:
28110 .display
28111 &`accept add_header = ADDED: some text`&
28112 &`       `&<&'some condition'&>
28113
28114 &`accept `&<&'some condition'&>
28115 &`       add_header = ADDED: some text`&
28116 .endd
28117 In the first case, the header line is always added, whether or not the
28118 condition is true. In the second case, the header line is added only if the
28119 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28120 ACL statement. All those that are encountered before a condition fails are
28121 honoured.
28122
28123 .cindex "&%warn%& ACL verb"
28124 For compatibility with previous versions of Exim, a &%message%& modifier for a
28125 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28126 effect only if all the conditions are true, even if it appears before some of
28127 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28128 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28129 are present on a &%warn%& verb, both are processed according to their
28130 specifications.
28131
28132 By default, new header lines are added to a message at the end of the existing
28133 header lines. However, you can specify that any particular header line should
28134 be added right at the start (before all the &'Received:'& lines), immediately
28135 after the first block of &'Received:'& lines, or immediately before any line
28136 that is not a &'Received:'& or &'Resent-something:'& header.
28137
28138 This is done by specifying &":at_start:"&, &":after_received:"&, or
28139 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28140 header line, respectively. (Header text cannot start with a colon, as there has
28141 to be a header name first.) For example:
28142 .code
28143 warn add_header = \
28144        :after_received:X-My-Header: something or other...
28145 .endd
28146 If more than one header line is supplied in a single &%add_header%& modifier,
28147 each one is treated independently and can therefore be placed differently. If
28148 you add more than one line at the start, or after the Received: block, they end
28149 up in reverse order.
28150
28151 &*Warning*&: This facility currently applies only to header lines that are
28152 added in an ACL. It does NOT work for header lines that are added in a
28153 system filter or in a router or transport.
28154
28155
28156
28157 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28158 .cindex "header lines" "removing in an ACL"
28159 .cindex "header lines" "position of removed lines"
28160 .cindex "&%remove_header%& ACL modifier"
28161 The &%remove_header%& modifier can be used to remove one or more header lines
28162 from an incoming message, as in this example:
28163 .code
28164 warn   message        = Remove internal headers
28165        remove_header  = x-route-mail1 : x-route-mail2
28166 .endd
28167 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28168 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28169 receiving a message). The message must ultimately be accepted for
28170 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28171 with any ACL verb, including &%deny%&, though this is really not useful for
28172 any verb that doesn't result in a delivered message.
28173
28174 Headers will not be removed to the message if the modifier is used in
28175 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28176
28177 More than one header can be removed at the same time by using a colon separated
28178 list of header names. The header matching is case insensitive. Wildcards are
28179 not permitted, nor is list expansion performed, so you cannot use hostlists to
28180 create a list of headers, however both connection and message variable expansion
28181 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28182 .code
28183 warn   hosts           = +internal_hosts
28184        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28185 warn   message         = Remove internal headers
28186        remove_header   = $acl_c_ihdrs
28187 .endd
28188 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28189 They are removed from the message before processing the DATA and MIME ACLs.
28190 There is no harm in attempting to remove the same header twice nor is removing
28191 a non-existent header. Further header lines to be removed may be accumulated
28192 during the DATA and MIME ACLs, after which they are removed from the message,
28193 if present. In the case of non-SMTP messages, headers to be removed are
28194 accumulated during the non-SMTP ACLs, and are removed from the message after
28195 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28196 ACL, there really is no effect because there is no logging of what headers
28197 would have been removed.
28198
28199 .cindex "header lines" "removed; visibility of"
28200 Header lines are not visible in string expansions until the DATA phase when it
28201 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28202 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28203 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28204 this restriction, you cannot use header lines as a way of controlling data
28205 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28206 you should instead use ACL variables, as described in section
28207 &<<SECTaclvariables>>&.
28208
28209 The &%remove_header%& modifier acts immediately as it is encountered during the
28210 processing of an ACL. Notice the difference between these two cases:
28211 .display
28212 &`accept remove_header = X-Internal`&
28213 &`       `&<&'some condition'&>
28214
28215 &`accept `&<&'some condition'&>
28216 &`       remove_header = X-Internal`&
28217 .endd
28218 In the first case, the header line is always removed, whether or not the
28219 condition is true. In the second case, the header line is removed only if the
28220 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28221 same ACL statement. All those that are encountered before a condition fails
28222 are honoured.
28223
28224 &*Warning*&: This facility currently applies only to header lines that are
28225 present during ACL processing. It does NOT remove header lines that are added
28226 in a system filter or in a router or transport.
28227
28228
28229
28230
28231 .section "ACL conditions" "SECTaclconditions"
28232 .cindex "&ACL;" "conditions; list of"
28233 Some of the conditions listed in this section are available only when Exim is
28234 compiled with the content-scanning extension. They are included here briefly
28235 for completeness. More detailed descriptions can be found in the discussion on
28236 content scanning in chapter &<<CHAPexiscan>>&.
28237
28238 Not all conditions are relevant in all circumstances. For example, testing
28239 senders and recipients does not make sense in an ACL that is being run as the
28240 result of the arrival of an ETRN command, and checks on message headers can be
28241 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28242 can use the same condition (with different parameters) more than once in the
28243 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28244 The conditions are as follows:
28245
28246
28247 .vlist
28248 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28249 .cindex "&ACL;" "nested"
28250 .cindex "&ACL;" "indirect"
28251 .cindex "&ACL;" "arguments"
28252 .cindex "&%acl%& ACL condition"
28253 The possible values of the argument are the same as for the
28254 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28255 &"accept"& the condition is true; if it returns &"deny"& the condition is
28256 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28257 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28258 condition false. This means that further processing of the &%warn%& verb
28259 ceases, but processing of the ACL continues.
28260
28261 If the argument is a named ACL, up to nine space-separated optional values
28262 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28263 and $acl_narg is set to the count of values.
28264 Previous values of these variables are restored after the call returns.
28265 The name and values are expanded separately.
28266
28267 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28268 the connection is dropped. If it returns &"discard"&, the verb must be
28269 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28270 conditions are tested.
28271
28272 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28273 loops. This condition allows you to use different ACLs in different
28274 circumstances. For example, different ACLs can be used to handle RCPT commands
28275 for different local users or different local domains.
28276
28277 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28278 .cindex "&%authenticated%& ACL condition"
28279 .cindex "authentication" "ACL checking"
28280 .cindex "&ACL;" "testing for authentication"
28281 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28282 the name of the authenticator is tested against the list. To test for
28283 authentication by any authenticator, you can set
28284 .code
28285 authenticated = *
28286 .endd
28287
28288 .vitem &*condition&~=&~*&<&'string'&>
28289 .cindex "&%condition%& ACL condition"
28290 .cindex "customizing" "ACL condition"
28291 .cindex "&ACL;" "customized test"
28292 .cindex "&ACL;" "testing, customized"
28293 This feature allows you to make up custom conditions. If the result of
28294 expanding the string is an empty string, the number zero, or one of the strings
28295 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28296 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28297 any other value, some error is assumed to have occurred, and the ACL returns
28298 &"defer"&. However, if the expansion is forced to fail, the condition is
28299 ignored. The effect is to treat it as true, whether it is positive or
28300 negative.
28301
28302 .vitem &*decode&~=&~*&<&'location'&>
28303 .cindex "&%decode%& ACL condition"
28304 This condition is available only when Exim is compiled with the
28305 content-scanning extension, and it is allowed only in the ACL defined by
28306 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28307 If all goes well, the condition is true. It is false only if there are
28308 problems such as a syntax error or a memory shortage. For more details, see
28309 chapter &<<CHAPexiscan>>&.
28310
28311 .vitem &*demime&~=&~*&<&'extension&~list'&>
28312 .cindex "&%demime%& ACL condition"
28313 This condition is available only when Exim is compiled with the
28314 content-scanning extension. Its use is described in section
28315 &<<SECTdemimecond>>&.
28316
28317 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28318 .cindex "&%dnslists%& ACL condition"
28319 .cindex "DNS list" "in ACL"
28320 .cindex "black list (DNS)"
28321 .cindex "&ACL;" "testing a DNS list"
28322 This condition checks for entries in DNS black lists. These are also known as
28323 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28324 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28325 different variants of this condition to describe briefly here. See sections
28326 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28327
28328 .vitem &*domains&~=&~*&<&'domain&~list'&>
28329 .cindex "&%domains%& ACL condition"
28330 .cindex "domain" "ACL checking"
28331 .cindex "&ACL;" "testing a recipient domain"
28332 .vindex "&$domain_data$&"
28333 This condition is relevant only after a RCPT command. It checks that the domain
28334 of the recipient address is in the domain list. If percent-hack processing is
28335 enabled, it is done before this test is done. If the check succeeds with a
28336 lookup, the result of the lookup is placed in &$domain_data$& until the next
28337 &%domains%& test.
28338
28339 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28340 use &%domains%& in a DATA ACL.
28341
28342
28343 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28344 .cindex "&%encrypted%& ACL condition"
28345 .cindex "encryption" "checking in an ACL"
28346 .cindex "&ACL;" "testing for encryption"
28347 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28348 name of the cipher suite in use is tested against the list. To test for
28349 encryption without testing for any specific cipher suite(s), set
28350 .code
28351 encrypted = *
28352 .endd
28353
28354
28355 .vitem &*hosts&~=&~*&<&'host&~list'&>
28356 .cindex "&%hosts%& ACL condition"
28357 .cindex "host" "ACL checking"
28358 .cindex "&ACL;" "testing the client host"
28359 This condition tests that the calling host matches the host list. If you have
28360 name lookups or wildcarded host names and IP addresses in the same host list,
28361 you should normally put the IP addresses first. For example, you could have:
28362 .code
28363 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28364 .endd
28365 The lookup in this example uses the host name for its key. This is implied by
28366 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28367 and it wouldn't matter which way round you had these two items.)
28368
28369 The reason for the problem with host names lies in the left-to-right way that
28370 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28371 but when it reaches an item that requires a host name, it fails if it cannot
28372 find a host name to compare with the pattern. If the above list is given in the
28373 opposite order, the &%accept%& statement fails for a host whose name cannot be
28374 found, even if its IP address is 10.9.8.7.
28375
28376 If you really do want to do the name check first, and still recognize the IP
28377 address even if the name lookup fails, you can rewrite the ACL like this:
28378 .code
28379 accept hosts = dbm;/etc/friendly/hosts
28380 accept hosts = 10.9.8.7
28381 .endd
28382 The default action on failing to find the host name is to assume that the host
28383 is not in the list, so the first &%accept%& statement fails. The second
28384 statement can then check the IP address.
28385
28386 .vindex "&$host_data$&"
28387 If a &%hosts%& condition is satisfied by means of a lookup, the result
28388 of the lookup is made available in the &$host_data$& variable. This
28389 allows you, for example, to set up a statement like this:
28390 .code
28391 deny  hosts = net-lsearch;/some/file
28392 message = $host_data
28393 .endd
28394 which gives a custom error message for each denied host.
28395
28396 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28397 .cindex "&%local_parts%& ACL condition"
28398 .cindex "local part" "ACL checking"
28399 .cindex "&ACL;" "testing a local part"
28400 .vindex "&$local_part_data$&"
28401 This condition is relevant only after a RCPT command. It checks that the local
28402 part of the recipient address is in the list. If percent-hack processing is
28403 enabled, it is done before this test. If the check succeeds with a lookup, the
28404 result of the lookup is placed in &$local_part_data$&, which remains set until
28405 the next &%local_parts%& test.
28406
28407 .vitem &*malware&~=&~*&<&'option'&>
28408 .cindex "&%malware%& ACL condition"
28409 .cindex "&ACL;" "virus scanning"
28410 .cindex "&ACL;" "scanning for viruses"
28411 This condition is available only when Exim is compiled with the
28412 content-scanning extension. It causes the incoming message to be scanned for
28413 viruses. For details, see chapter &<<CHAPexiscan>>&.
28414
28415 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28416 .cindex "&%mime_regex%& ACL condition"
28417 .cindex "&ACL;" "testing by regex matching"
28418 This condition is available only when Exim is compiled with the
28419 content-scanning extension, and it is allowed only in the ACL defined by
28420 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28421 with any of the regular expressions. For details, see chapter
28422 &<<CHAPexiscan>>&.
28423
28424 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28425 .cindex "rate limiting"
28426 This condition can be used to limit the rate at which a user or host submits
28427 messages. Details are given in section &<<SECTratelimiting>>&.
28428
28429 .vitem &*recipients&~=&~*&<&'address&~list'&>
28430 .cindex "&%recipients%& ACL condition"
28431 .cindex "recipient" "ACL checking"
28432 .cindex "&ACL;" "testing a recipient"
28433 This condition is relevant only after a RCPT command. It checks the entire
28434 recipient address against a list of recipients.
28435
28436 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28437 .cindex "&%regex%& ACL condition"
28438 .cindex "&ACL;" "testing by regex matching"
28439 This condition is available only when Exim is compiled with the
28440 content-scanning extension, and is available only in the DATA, MIME, and
28441 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28442 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28443
28444 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28445 .cindex "&%sender_domains%& ACL condition"
28446 .cindex "sender" "ACL checking"
28447 .cindex "&ACL;" "testing a sender domain"
28448 .vindex "&$domain$&"
28449 .vindex "&$sender_address_domain$&"
28450 This condition tests the domain of the sender of the message against the given
28451 domain list. &*Note*&: The domain of the sender address is in
28452 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28453 of this condition. This is an exception to the general rule for testing domain
28454 lists. It is done this way so that, if this condition is used in an ACL for a
28455 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28456 influence the sender checking.
28457
28458 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28459 relaying, because sender addresses are easily, and commonly, forged.
28460
28461 .vitem &*senders&~=&~*&<&'address&~list'&>
28462 .cindex "&%senders%& ACL condition"
28463 .cindex "sender" "ACL checking"
28464 .cindex "&ACL;" "testing a sender"
28465 This condition tests the sender of the message against the given list. To test
28466 for a bounce message, which has an empty sender, set
28467 .code
28468 senders = :
28469 .endd
28470 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28471 relaying, because sender addresses are easily, and commonly, forged.
28472
28473 .vitem &*spam&~=&~*&<&'username'&>
28474 .cindex "&%spam%& ACL condition"
28475 .cindex "&ACL;" "scanning for spam"
28476 This condition is available only when Exim is compiled with the
28477 content-scanning extension. It causes the incoming message to be scanned by
28478 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28479
28480 .vitem &*verify&~=&~certificate*&
28481 .cindex "&%verify%& ACL condition"
28482 .cindex "TLS" "client certificate verification"
28483 .cindex "certificate" "verification of client"
28484 .cindex "&ACL;" "certificate verification"
28485 .cindex "&ACL;" "testing a TLS certificate"
28486 This condition is true in an SMTP session if the session is encrypted, and a
28487 certificate was received from the client, and the certificate was verified. The
28488 server requests a certificate only if the client matches &%tls_verify_hosts%&
28489 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28490
28491 .vitem &*verify&~=&~csa*&
28492 .cindex "CSA verification"
28493 This condition checks whether the sending host (the client) is authorized to
28494 send email. Details of how this works are given in section
28495 &<<SECTverifyCSA>>&.
28496
28497 .vitem &*verify&~=&~header_names_ascii*&
28498 .cindex "&%verify%& ACL condition"
28499 .cindex "&ACL;" "verifying header names only ASCII"
28500 .cindex "header lines" "verifying header names only ASCII"
28501 .cindex "verifying" "header names only ASCII"
28502 This condition is relevant only in an ACL that is run after a message has been
28503 received, that is, in an ACL specified by &%acl_smtp_data%& or
28504 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28505 there are no non-ASCII characters, also excluding control characters.  The
28506 allowable characters are decimal ASCII values 33 through 126.
28507
28508 Exim itself will handle headers with non-ASCII characters, but it can cause
28509 problems for downstream applications, so this option will allow their
28510 detection and rejection in the DATA ACL's.
28511
28512 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28513 .cindex "&%verify%& ACL condition"
28514 .cindex "&ACL;" "verifying sender in the header"
28515 .cindex "header lines" "verifying the sender in"
28516 .cindex "sender" "verifying in header"
28517 .cindex "verifying" "sender in header"
28518 This condition is relevant only in an ACL that is run after a message has been
28519 received, that is, in an ACL specified by &%acl_smtp_data%& or
28520 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28521 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28522 is loosely thought of as a &"sender"& address (hence the name of the test).
28523 However, an address that appears in one of these headers need not be an address
28524 that accepts bounce messages; only sender addresses in envelopes are required
28525 to accept bounces. Therefore, if you use the callout option on this check, you
28526 might want to arrange for a non-empty address in the MAIL command.
28527
28528 Details of address verification and the options are given later, starting at
28529 section &<<SECTaddressverification>>& (callouts are described in section
28530 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28531 condition to restrict it to bounce messages only:
28532 .code
28533 deny    senders = :
28534         message = A valid sender header is required for bounces
28535        !verify  = header_sender
28536 .endd
28537
28538 .vitem &*verify&~=&~header_syntax*&
28539 .cindex "&%verify%& ACL condition"
28540 .cindex "&ACL;" "verifying header syntax"
28541 .cindex "header lines" "verifying syntax"
28542 .cindex "verifying" "header syntax"
28543 This condition is relevant only in an ACL that is run after a message has been
28544 received, that is, in an ACL specified by &%acl_smtp_data%& or
28545 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28546 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28547 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28548 permitted only in locally generated messages and from hosts that match
28549 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28550 appropriate.
28551
28552 Note that this condition is a syntax check only. However, a common spamming
28553 ploy used to be to send syntactically invalid headers such as
28554 .code
28555 To: @
28556 .endd
28557 and this condition can be used to reject such messages, though they are not as
28558 common as they used to be.
28559
28560 .vitem &*verify&~=&~helo*&
28561 .cindex "&%verify%& ACL condition"
28562 .cindex "&ACL;" "verifying HELO/EHLO"
28563 .cindex "HELO" "verifying"
28564 .cindex "EHLO" "verifying"
28565 .cindex "verifying" "EHLO"
28566 .cindex "verifying" "HELO"
28567 This condition is true if a HELO or EHLO command has been received from the
28568 client host, and its contents have been verified. If there has been no previous
28569 attempt to verify the HELO/EHLO contents, it is carried out when this
28570 condition is encountered. See the description of the &%helo_verify_hosts%& and
28571 &%helo_try_verify_hosts%& options for details of how to request verification
28572 independently of this condition.
28573
28574 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28575 option), this condition is always true.
28576
28577
28578 .vitem &*verify&~=&~not_blind*&
28579 .cindex "verifying" "not blind"
28580 .cindex "bcc recipients, verifying none"
28581 This condition checks that there are no blind (bcc) recipients in the message.
28582 Every envelope recipient must appear either in a &'To:'& header line or in a
28583 &'Cc:'& header line for this condition to be true. Local parts are checked
28584 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28585 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28586 used only in a DATA or non-SMTP ACL.
28587
28588 There are, of course, many legitimate messages that make use of blind (bcc)
28589 recipients. This check should not be used on its own for blocking messages.
28590
28591
28592 .vitem &*verify&~=&~recipient/*&<&'options'&>
28593 .cindex "&%verify%& ACL condition"
28594 .cindex "&ACL;" "verifying recipient"
28595 .cindex "recipient" "verifying"
28596 .cindex "verifying" "recipient"
28597 .vindex "&$address_data$&"
28598 This condition is relevant only after a RCPT command. It verifies the current
28599 recipient. Details of address verification are given later, starting at section
28600 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28601 of &$address_data$& is the last value that was set while routing the address.
28602 This applies even if the verification fails. When an address that is being
28603 verified is redirected to a single address, verification continues with the new
28604 address, and in that case, the subsequent value of &$address_data$& is the
28605 value for the child address.
28606
28607 .vitem &*verify&~=&~reverse_host_lookup*&
28608 .cindex "&%verify%& ACL condition"
28609 .cindex "&ACL;" "verifying host reverse lookup"
28610 .cindex "host" "verifying reverse lookup"
28611 This condition ensures that a verified host name has been looked up from the IP
28612 address of the client host. (This may have happened already if the host name
28613 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28614 Verification ensures that the host name obtained from a reverse DNS lookup, or
28615 one of its aliases, does, when it is itself looked up in the DNS, yield the
28616 original IP address.
28617
28618 If this condition is used for a locally generated message (that is, when there
28619 is no client host involved), it always succeeds.
28620
28621 .vitem &*verify&~=&~sender/*&<&'options'&>
28622 .cindex "&%verify%& ACL condition"
28623 .cindex "&ACL;" "verifying sender"
28624 .cindex "sender" "verifying"
28625 .cindex "verifying" "sender"
28626 This condition is relevant only after a MAIL or RCPT command, or after a
28627 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28628 the message's sender is empty (that is, this is a bounce message), the
28629 condition is true. Otherwise, the sender address is verified.
28630
28631 .vindex "&$address_data$&"
28632 .vindex "&$sender_address_data$&"
28633 If there is data in the &$address_data$& variable at the end of routing, its
28634 value is placed in &$sender_address_data$& at the end of verification. This
28635 value can be used in subsequent conditions and modifiers in the same ACL
28636 statement. It does not persist after the end of the current statement. If you
28637 want to preserve the value for longer, you can save it in an ACL variable.
28638
28639 Details of verification are given later, starting at section
28640 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28641 to avoid doing it more than once per message.
28642
28643 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28644 .cindex "&%verify%& ACL condition"
28645 This is a variation of the previous option, in which a modified address is
28646 verified as a sender.
28647 .endlist
28648
28649
28650
28651 .section "Using DNS lists" "SECTmorednslists"
28652 .cindex "DNS list" "in ACL"
28653 .cindex "black list (DNS)"
28654 .cindex "&ACL;" "testing a DNS list"
28655 In its simplest form, the &%dnslists%& condition tests whether the calling host
28656 is on at least one of a number of DNS lists by looking up the inverted IP
28657 address in one or more DNS domains. (Note that DNS list domains are not mail
28658 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28659 special options instead.) For example, if the calling host's IP
28660 address is 192.168.62.43, and the ACL statement is
28661 .code
28662 deny dnslists = blackholes.mail-abuse.org : \
28663                 dialups.mail-abuse.org
28664 .endd
28665 the following records are looked up:
28666 .code
28667 43.62.168.192.blackholes.mail-abuse.org
28668 43.62.168.192.dialups.mail-abuse.org
28669 .endd
28670 As soon as Exim finds an existing DNS record, processing of the list stops.
28671 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28672 to test that a host is on more than one list (an &"and"& conjunction), you can
28673 use two separate conditions:
28674 .code
28675 deny dnslists = blackholes.mail-abuse.org
28676      dnslists = dialups.mail-abuse.org
28677 .endd
28678 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28679 behaves as if the host does not match the list item, that is, as if the DNS
28680 record does not exist. If there are further items in the DNS list, they are
28681 processed.
28682
28683 This is usually the required action when &%dnslists%& is used with &%deny%&
28684 (which is the most common usage), because it prevents a DNS failure from
28685 blocking mail. However, you can change this behaviour by putting one of the
28686 following special items in the list:
28687 .display
28688 &`+include_unknown `&   behave as if the item is on the list
28689 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28690 &`+defer_unknown   `&   give a temporary error
28691 .endd
28692 .cindex "&`+include_unknown`&"
28693 .cindex "&`+exclude_unknown`&"
28694 .cindex "&`+defer_unknown`&"
28695 Each of these applies to any subsequent items on the list. For example:
28696 .code
28697 deny dnslists = +defer_unknown : foo.bar.example
28698 .endd
28699 Testing the list of domains stops as soon as a match is found. If you want to
28700 warn for one list and block for another, you can use two different statements:
28701 .code
28702 deny  dnslists = blackholes.mail-abuse.org
28703 warn  message  = X-Warn: sending host is on dialups list
28704       dnslists = dialups.mail-abuse.org
28705 .endd
28706 DNS list lookups are cached by Exim for the duration of the SMTP session,
28707 so a lookup based on the IP address is done at most once for any incoming
28708 connection. Exim does not share information between multiple incoming
28709 connections (but your local name server cache should be active).
28710
28711
28712
28713 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28714 .cindex "DNS list" "keyed by explicit IP address"
28715 By default, the IP address that is used in a DNS list lookup is the IP address
28716 of the calling host. However, you can specify another IP address by listing it
28717 after the domain name, introduced by a slash. For example:
28718 .code
28719 deny dnslists = black.list.tld/192.168.1.2
28720 .endd
28721 This feature is not very helpful with explicit IP addresses; it is intended for
28722 use with IP addresses that are looked up, for example, the IP addresses of the
28723 MX hosts or nameservers of an email sender address. For an example, see section
28724 &<<SECTmulkeyfor>>& below.
28725
28726
28727
28728
28729 .section "DNS lists keyed on domain names" "SECID202"
28730 .cindex "DNS list" "keyed by domain name"
28731 There are some lists that are keyed on domain names rather than inverted IP
28732 addresses (see for example the &'domain based zones'& link at
28733 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28734 with these lists. You can change the name that is looked up in a DNS list by
28735 listing it after the domain name, introduced by a slash. For example,
28736 .code
28737 deny  message  = Sender's domain is listed at $dnslist_domain
28738       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28739 .endd
28740 This particular example is useful only in ACLs that are obeyed after the
28741 RCPT or DATA commands, when a sender address is available. If (for
28742 example) the message's sender is &'user@tld.example'& the name that is looked
28743 up by this example is
28744 .code
28745 tld.example.dsn.rfc-ignorant.org
28746 .endd
28747 A single &%dnslists%& condition can contain entries for both names and IP
28748 addresses. For example:
28749 .code
28750 deny dnslists = sbl.spamhaus.org : \
28751                 dsn.rfc-ignorant.org/$sender_address_domain
28752 .endd
28753 The first item checks the sending host's IP address; the second checks a domain
28754 name. The whole condition is true if either of the DNS lookups succeeds.
28755
28756
28757
28758
28759 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28760 .cindex "DNS list" "multiple keys for"
28761 The syntax described above for looking up explicitly-defined values (either
28762 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28763 name for the DNS list, what follows the slash can in fact be a list of items.
28764 As with all lists in Exim, the default separator is a colon. However, because
28765 this is a sublist within the list of DNS blacklist domains, it is necessary
28766 either to double the separators like this:
28767 .code
28768 dnslists = black.list.tld/name.1::name.2
28769 .endd
28770 or to change the separator character, like this:
28771 .code
28772 dnslists = black.list.tld/<;name.1;name.2
28773 .endd
28774 If an item in the list is an IP address, it is inverted before the DNS
28775 blacklist domain is appended. If it is not an IP address, no inversion
28776 occurs. Consider this condition:
28777 .code
28778 dnslists = black.list.tld/<;192.168.1.2;a.domain
28779 .endd
28780 The DNS lookups that occur are:
28781 .code
28782 2.1.168.192.black.list.tld
28783 a.domain.black.list.tld
28784 .endd
28785 Once a DNS record has been found (that matches a specific IP return
28786 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28787 are done. If there is a temporary DNS error, the rest of the sublist of domains
28788 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28789 only if no other DNS lookup in this sublist succeeds. In other words, a
28790 successful lookup for any of the items in the sublist overrides a temporary
28791 error for a previous item.
28792
28793 The ability to supply a list of items after the slash is in some sense just a
28794 syntactic convenience. These two examples have the same effect:
28795 .code
28796 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28797 dnslists = black.list.tld/a.domain::b.domain
28798 .endd
28799 However, when the data for the list is obtained from a lookup, the second form
28800 is usually much more convenient. Consider this example:
28801 .code
28802 deny message  = The mail servers for the domain \
28803                 $sender_address_domain \
28804                 are listed at $dnslist_domain ($dnslist_value); \
28805                 see $dnslist_text.
28806      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28807                                    ${lookup dnsdb {>|mxh=\
28808                                    $sender_address_domain} }} }
28809 .endd
28810 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28811 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28812 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28813 of expanding the condition might be something like this:
28814 .code
28815 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28816 .endd
28817 Thus, this example checks whether or not the IP addresses of the sender
28818 domain's mail servers are on the Spamhaus black list.
28819
28820 The key that was used for a successful DNS list lookup is put into the variable
28821 &$dnslist_matched$& (see section &<<SECID204>>&).
28822
28823
28824
28825
28826 .section "Data returned by DNS lists" "SECID203"
28827 .cindex "DNS list" "data returned from"
28828 DNS lists are constructed using address records in the DNS. The original RBL
28829 just used the address 127.0.0.1 on the right hand side of each record, but the
28830 RBL+ list and some other lists use a number of values with different meanings.
28831 The values used on the RBL+ list are:
28832 .display
28833 127.1.0.1  RBL
28834 127.1.0.2  DUL
28835 127.1.0.3  DUL and RBL
28836 127.1.0.4  RSS
28837 127.1.0.5  RSS and RBL
28838 127.1.0.6  RSS and DUL
28839 127.1.0.7  RSS and DUL and RBL
28840 .endd
28841 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28842 different values. Some DNS lists may return more than one address record;
28843 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28844
28845
28846 .section "Variables set from DNS lists" "SECID204"
28847 .cindex "expansion" "variables, set from DNS list"
28848 .cindex "DNS list" "variables set from"
28849 .vindex "&$dnslist_domain$&"
28850 .vindex "&$dnslist_matched$&"
28851 .vindex "&$dnslist_text$&"
28852 .vindex "&$dnslist_value$&"
28853 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28854 the name of the overall domain that matched (for example,
28855 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28856 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28857 the DNS record. When the key is an IP address, it is not reversed in
28858 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28859 cases, for example:
28860 .code
28861 deny dnslists = spamhaus.example
28862 .endd
28863 the key is also available in another variable (in this case,
28864 &$sender_host_address$&). In more complicated cases, however, this is not true.
28865 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28866 might generate a dnslists lookup like this:
28867 .code
28868 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28869 .endd
28870 If this condition succeeds, the value in &$dnslist_matched$& might be
28871 &`192.168.6.7`& (for example).
28872
28873 If more than one address record is returned by the DNS lookup, all the IP
28874 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28875 The variable &$dnslist_text$& contains the contents of any associated TXT
28876 record. For lists such as RBL+ the TXT record for a merged entry is often not
28877 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28878 information.
28879
28880 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28881 &-- although these appear before the condition in the ACL, they are not
28882 expanded until after it has failed. For example:
28883 .code
28884 deny    hosts = !+local_networks
28885         message = $sender_host_address is listed \
28886                   at $dnslist_domain
28887         dnslists = rbl-plus.mail-abuse.example
28888 .endd
28889
28890
28891
28892 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28893 .cindex "DNS list" "matching specific returned data"
28894 You can add an equals sign and an IP address after a &%dnslists%& domain name
28895 in order to restrict its action to DNS records with a matching right hand side.
28896 For example,
28897 .code
28898 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28899 .endd
28900 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28901 any address record is considered to be a match. For the moment, we assume
28902 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28903 describes how multiple records are handled.
28904
28905 More than one IP address may be given for checking, using a comma as a
28906 separator. These are alternatives &-- if any one of them matches, the
28907 &%dnslists%& condition is true. For example:
28908 .code
28909 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28910 .endd
28911 If you want to specify a constraining address list and also specify names or IP
28912 addresses to be looked up, the constraining address list must be specified
28913 first. For example:
28914 .code
28915 deny dnslists = dsn.rfc-ignorant.org\
28916                 =127.0.0.2/$sender_address_domain
28917 .endd
28918
28919 If the character &`&&`& is used instead of &`=`&, the comparison for each
28920 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28921 In other words, the listed addresses are used as bit masks. The comparison is
28922 true if all the bits in the mask are present in the address that is being
28923 tested. For example:
28924 .code
28925 dnslists = a.b.c&0.0.0.3
28926 .endd
28927 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28928 want to test whether one bit or another bit is present (as opposed to both
28929 being present), you must use multiple values. For example:
28930 .code
28931 dnslists = a.b.c&0.0.0.1,0.0.0.2
28932 .endd
28933 matches if the final component of the address is an odd number or two times
28934 an odd number.
28935
28936
28937
28938 .section "Negated DNS matching conditions" "SECID205"
28939 You can supply a negative list of IP addresses as part of a &%dnslists%&
28940 condition. Whereas
28941 .code
28942 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28943 .endd
28944 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28945 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28946 .code
28947 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28948 .endd
28949 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28950 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28951 words, the result of the test is inverted if an exclamation mark appears before
28952 the &`=`& (or the &`&&`&) sign.
28953
28954 &*Note*&: This kind of negation is not the same as negation in a domain,
28955 host, or address list (which is why the syntax is different).
28956
28957 If you are using just one list, the negation syntax does not gain you much. The
28958 previous example is precisely equivalent to
28959 .code
28960 deny  dnslists = a.b.c
28961      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28962 .endd
28963 However, if you are using multiple lists, the negation syntax is clearer.
28964 Consider this example:
28965 .code
28966 deny  dnslists = sbl.spamhaus.org : \
28967                  list.dsbl.org : \
28968                  dnsbl.njabl.org!=127.0.0.3 : \
28969                  relays.ordb.org
28970 .endd
28971 Using only positive lists, this would have to be:
28972 .code
28973 deny  dnslists = sbl.spamhaus.org : \
28974                  list.dsbl.org
28975 deny  dnslists = dnsbl.njabl.org
28976      !dnslists = dnsbl.njabl.org=127.0.0.3
28977 deny  dnslists = relays.ordb.org
28978 .endd
28979 which is less clear, and harder to maintain.
28980
28981
28982
28983
28984 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28985 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28986 thereby providing more than one IP address. When an item in a &%dnslists%& list
28987 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28988 the match to specific results from the DNS lookup, there are two ways in which
28989 the checking can be handled. For example, consider the condition:
28990 .code
28991 dnslists = a.b.c=127.0.0.1
28992 .endd
28993 What happens if the DNS lookup for the incoming IP address yields both
28994 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28995 condition true because at least one given value was found, or is it false
28996 because at least one of the found values was not listed? And how does this
28997 affect negated conditions? Both possibilities are provided for with the help of
28998 additional separators &`==`& and &`=&&`&.
28999
29000 .ilist
29001 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29002 IP addresses matches one of the listed addresses. For the example above, the
29003 condition is true because 127.0.0.1 matches.
29004 .next
29005 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29006 looked up IP addresses matches one of the listed addresses. If the condition is
29007 changed to:
29008 .code
29009 dnslists = a.b.c==127.0.0.1
29010 .endd
29011 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29012 false because 127.0.0.2 is not listed. You would need to have:
29013 .code
29014 dnslists = a.b.c==127.0.0.1,127.0.0.2
29015 .endd
29016 for the condition to be true.
29017 .endlist
29018
29019 When &`!`& is used to negate IP address matching, it inverts the result, giving
29020 the precise opposite of the behaviour above. Thus:
29021 .ilist
29022 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29023 addresses matches one of the listed addresses. Consider:
29024 .code
29025 dnslists = a.b.c!&0.0.0.1
29026 .endd
29027 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29028 false because 127.0.0.1 matches.
29029 .next
29030 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29031 looked up IP address that does not match. Consider:
29032 .code
29033 dnslists = a.b.c!=&0.0.0.1
29034 .endd
29035 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29036 true, because 127.0.0.2 does not match. You would need to have:
29037 .code
29038 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29039 .endd
29040 for the condition to be false.
29041 .endlist
29042 When the DNS lookup yields only a single IP address, there is no difference
29043 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29044
29045
29046
29047
29048 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29049 .cindex "DNS list" "information from merged"
29050 When the facility for restricting the matching IP values in a DNS list is used,
29051 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29052 the true reason for rejection. This happens when lists are merged and the IP
29053 address in the A record is used to distinguish them; unfortunately there is
29054 only one TXT record. One way round this is not to use merged lists, but that
29055 can be inefficient because it requires multiple DNS lookups where one would do
29056 in the vast majority of cases when the host of interest is not on any of the
29057 lists.
29058
29059 A less inefficient way of solving this problem is available. If
29060 two domain names, comma-separated, are given, the second is used first to
29061 do an initial check, making use of any IP value restrictions that are set.
29062 If there is a match, the first domain is used, without any IP value
29063 restrictions, to get the TXT record. As a byproduct of this, there is also
29064 a check that the IP being tested is indeed on the first list. The first
29065 domain is the one that is put in &$dnslist_domain$&. For example:
29066 .code
29067 reject message  = \
29068          rejected because $sender_host_address is blacklisted \
29069          at $dnslist_domain\n$dnslist_text
29070        dnslists = \
29071          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29072          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29073 .endd
29074 For the first blacklist item, this starts by doing a lookup in
29075 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29076 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29077 value, and as long as something is found, it looks for the corresponding TXT
29078 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29079 The second blacklist item is processed similarly.
29080
29081 If you are interested in more than one merged list, the same list must be
29082 given several times, but because the results of the DNS lookups are cached,
29083 the DNS calls themselves are not repeated. For example:
29084 .code
29085 reject dnslists = \
29086          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29087          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29088          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29089          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29090 .endd
29091 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29092 values matches (or if no record is found), this is the only lookup that is
29093 done. Only if there is a match is one of the more specific lists consulted.
29094
29095
29096
29097 .section "DNS lists and IPv6" "SECTmorednslistslast"
29098 .cindex "IPv6" "DNS black lists"
29099 .cindex "DNS list" "IPv6 usage"
29100 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29101 nibble by nibble. For example, if the calling host's IP address is
29102 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29103 .code
29104 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29105   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29106 .endd
29107 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29108 lists contain wildcard records, intended for IPv4, that interact badly with
29109 IPv6. For example, the DNS entry
29110 .code
29111 *.3.some.list.example.    A    127.0.0.1
29112 .endd
29113 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29114 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29115
29116 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29117 &%condition%& condition, as in this example:
29118 .code
29119 deny   condition = ${if isip4{$sender_host_address}}
29120        dnslists  = some.list.example
29121 .endd
29122
29123 If an explicit key is being used for a DNS lookup and it may be an IPv6
29124 address you should specify alternate list separators for both the outer
29125 (DNS list name) list and inner (lookup keys) list:
29126 .code
29127        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29128 .endd
29129
29130 .section "Rate limiting incoming messages" "SECTratelimiting"
29131 .cindex "rate limiting" "client sending"
29132 .cindex "limiting client sending rates"
29133 .oindex "&%smtp_ratelimit_*%&"
29134 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29135 which clients can send email. This is more powerful than the
29136 &%smtp_ratelimit_*%& options, because those options control the rate of
29137 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29138 works across all connections (concurrent and sequential) from the same client
29139 host. The syntax of the &%ratelimit%& condition is:
29140 .display
29141 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29142 .endd
29143 If the average client sending rate is less than &'m'& messages per time
29144 period &'p'& then the condition is false; otherwise it is true.
29145
29146 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29147 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29148 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29149 of &'p'&.
29150
29151 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29152 time interval, for example, &`8h`& for eight hours. A larger time constant
29153 means that it takes Exim longer to forget a client's past behaviour. The
29154 parameter &'m'& is the maximum number of messages that a client is permitted to
29155 send in each time interval. It also specifies the number of messages permitted
29156 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29157 constant, you can allow a client to send more messages in a burst without
29158 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29159 both small, messages must be sent at an even rate.
29160
29161 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29162 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29163 when deploying the &%ratelimit%& ACL condition. The script prints usage
29164 instructions when it is run with no arguments.
29165
29166 The key is used to look up the data for calculating the client's average
29167 sending rate. This data is stored in Exim's spool directory, alongside the
29168 retry and other hints databases. The default key is &$sender_host_address$&,
29169 which means Exim computes the sending rate of each client host IP address.
29170 By changing the key you can change how Exim identifies clients for the purpose
29171 of ratelimiting. For example, to limit the sending rate of each authenticated
29172 user, independent of the computer they are sending from, set the key to
29173 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29174 example, &$authenticated_id$& is only meaningful if the client has
29175 authenticated (which you can check with the &%authenticated%& ACL condition).
29176
29177 The lookup key does not have to identify clients: If you want to limit the
29178 rate at which a recipient receives messages, you can use the key
29179 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29180 ACL.
29181
29182 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29183 specifies what Exim measures the rate of, for example messages or recipients
29184 or bytes. You can adjust the measurement using the &%unique=%& and/or
29185 &%count=%& options. You can also control when Exim updates the recorded rate
29186 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29187 separated by a slash, like the other parameters. They may appear in any order.
29188
29189 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29190 any options that alter the meaning of the stored data. The limit &'m'& is not
29191 stored, so you can alter the configured maximum rate and Exim will still
29192 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29193 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29194 behaviour. The lookup key is not affected by changes to the update mode and
29195 the &%count=%& option.
29196
29197
29198 .section "Ratelimit options for what is being measured" "ratoptmea"
29199 .cindex "rate limiting" "per_* options"
29200 The &%per_conn%& option limits the client's connection rate. It is not
29201 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29202 &%acl_not_smtp_start%& ACLs.
29203
29204 The &%per_mail%& option limits the client's rate of sending messages. This is
29205 the default if none of the &%per_*%& options is specified. It can be used in
29206 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29207 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29208
29209 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29210 the same ACLs as the &%per_mail%& option, though it is best to use this option
29211 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29212 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29213 in its MAIL command, which may be inaccurate or completely missing. You can
29214 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29215 in kilobytes, megabytes, or gigabytes, respectively.
29216
29217 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29218 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29219 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29220 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29221 ACLs the rate is updated with the total recipient count in one go. Note that
29222 in either case the rate limiting engine will see a message with many
29223 recipients as a large high-speed burst.
29224
29225 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29226 number of different recipients that the client has sent messages to in the
29227 last time period. That is, if the client repeatedly sends messages to the same
29228 recipient, its measured rate is not increased. This option can only be used in
29229 &%acl_smtp_rcpt%&.
29230
29231 The &%per_cmd%& option causes Exim to recompute the rate every time the
29232 condition is processed. This can be used to limit the rate of any SMTP
29233 command. If it is used in multiple ACLs it can limit the aggregate rate of
29234 multiple different commands.
29235
29236 The &%count=%& option can be used to alter how much Exim adds to the client's
29237 measured rate. For example, the &%per_byte%& option is equivalent to
29238 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29239 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29240 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29241
29242 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29243
29244
29245 .section "Ratelimit update modes" "ratoptupd"
29246 .cindex "rate limiting" "reading data without updating"
29247 You can specify one of three options with the &%ratelimit%& condition to
29248 control when its database is updated. This section describes the &%readonly%&
29249 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29250
29251 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29252 previously-computed rate to check against the limit.
29253
29254 For example, you can test the client's sending rate and deny it access (when
29255 it is too fast) in the connect ACL. If the client passes this check then it
29256 can go on to send a message, in which case its recorded rate will be updated
29257 in the MAIL ACL. Subsequent connections from the same client will check this
29258 new rate.
29259 .code
29260 acl_check_connect:
29261  deny ratelimit = 100 / 5m / readonly
29262     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29263                   (max $sender_rate_limit)
29264 # ...
29265 acl_check_mail:
29266  warn ratelimit = 100 / 5m / strict
29267     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29268                   (max $sender_rate_limit)
29269 .endd
29270
29271 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29272 processing a message then it may increase the client's measured rate more than
29273 it should. For example, this will happen if you check the &%per_rcpt%& option
29274 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29275 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29276 multiple update problems by using the &%readonly%& option on later ratelimit
29277 checks.
29278
29279 The &%per_*%& options described above do not make sense in some ACLs. If you
29280 use a &%per_*%& option in an ACL where it is not normally permitted then the
29281 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29282 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29283 next section) so you must specify the &%readonly%& option explicitly.
29284
29285
29286 .section "Ratelimit options for handling fast clients" "ratoptfast"
29287 .cindex "rate limiting" "strict and leaky modes"
29288 If a client's average rate is greater than the maximum, the rate limiting
29289 engine can react in two possible ways, depending on the presence of the
29290 &%strict%& or &%leaky%& update modes. This is independent of the other
29291 counter-measures (such as rejecting the message) that may be specified by the
29292 rest of the ACL.
29293
29294 The &%leaky%& (default) option means that the client's recorded rate is not
29295 updated if it is above the limit. The effect of this is that Exim measures the
29296 client's average rate of successfully sent email, which cannot be greater than
29297 the maximum allowed. If the client is over the limit it may suffer some
29298 counter-measures (as specified in the ACL), but it will still be able to send
29299 email at the configured maximum rate, whatever the rate of its attempts. This
29300 is generally the better choice if you have clients that retry automatically.
29301 For example, it does not prevent a sender with an over-aggressive retry rate
29302 from getting any email through.
29303
29304 The &%strict%& option means that the client's recorded rate is always
29305 updated. The effect of this is that Exim measures the client's average rate
29306 of attempts to send email, which can be much higher than the maximum it is
29307 actually allowed. If the client is over the limit it may be subjected to
29308 counter-measures by the ACL. It must slow down and allow sufficient time to
29309 pass that its computed rate falls below the maximum before it can send email
29310 again. The time (the number of smoothing periods) it must wait and not
29311 attempt to send mail can be calculated with this formula:
29312 .code
29313         ln(peakrate/maxrate)
29314 .endd
29315
29316
29317 .section "Limiting the rate of different events" "ratoptuniq"
29318 .cindex "rate limiting" "counting unique events"
29319 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29320 rate of different events. For example, the &%per_addr%& option uses this
29321 mechanism to count the number of different recipients that the client has
29322 sent messages to in the last time period; it is equivalent to
29323 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29324 measure the rate that a client uses different sender addresses with the
29325 options &`per_mail/unique=$sender_address`&.
29326
29327 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29328 has seen for that key. The whole set is thrown away when it is older than the
29329 rate smoothing period &'p'&, so each different event is counted at most once
29330 per period. In the &%leaky%& update mode, an event that causes the client to
29331 go over the limit is not added to the set, in the same way that the client's
29332 recorded rate is not updated in the same situation.
29333
29334 When you combine the &%unique=%& and &%readonly%& options, the specific
29335 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29336 rate.
29337
29338 The &%unique=%& mechanism needs more space in the ratelimit database than the
29339 other &%ratelimit%& options in order to store the event set. The number of
29340 unique values is potentially as large as the rate limit, so the extra space
29341 required increases with larger limits.
29342
29343 The uniqueification is not perfect: there is a small probability that Exim
29344 will think a new event has happened before. If the sender's rate is less than
29345 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29346 the measured rate can go above the limit, in which case Exim may under-count
29347 events by a significant margin. Fortunately, if the rate is high enough (2.7
29348 times the limit) that the false positive rate goes above 9%, then Exim will
29349 throw away the over-full event set before the measured rate falls below the
29350 limit. Therefore the only harm should be that exceptionally high sending rates
29351 are logged incorrectly; any countermeasures you configure will be as effective
29352 as intended.
29353
29354
29355 .section "Using rate limiting" "useratlim"
29356 Exim's other ACL facilities are used to define what counter-measures are taken
29357 when the rate limit is exceeded. This might be anything from logging a warning
29358 (for example, while measuring existing sending rates in order to define
29359 policy), through time delays to slow down fast senders, up to rejecting the
29360 message. For example:
29361 .code
29362 # Log all senders' rates
29363 warn ratelimit = 0 / 1h / strict
29364      log_message = Sender rate $sender_rate / $sender_rate_period
29365
29366 # Slow down fast senders; note the need to truncate $sender_rate
29367 # at the decimal point.
29368 warn ratelimit = 100 / 1h / per_rcpt / strict
29369      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29370                    $sender_rate_limit }s
29371
29372 # Keep authenticated users under control
29373 deny authenticated = *
29374      ratelimit = 100 / 1d / strict / $authenticated_id
29375
29376 # System-wide rate limit
29377 defer message = Sorry, too busy. Try again later.
29378      ratelimit = 10 / 1s / $primary_hostname
29379
29380 # Restrict incoming rate from each host, with a default
29381 # set using a macro and special cases looked up in a table.
29382 defer message = Sender rate exceeds $sender_rate_limit \
29383                messages per $sender_rate_period
29384      ratelimit = ${lookup {$sender_host_address} \
29385                    cdb {DB/ratelimits.cdb} \
29386                    {$value} {RATELIMIT} }
29387 .endd
29388 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29389 especially with the &%per_rcpt%& option, you may suffer from a performance
29390 bottleneck caused by locking on the ratelimit hints database. Apart from
29391 making your ACLs less complicated, you can reduce the problem by using a
29392 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29393 this means that Exim will lose its hints data after a reboot (including retry
29394 hints, the callout cache, and ratelimit data).
29395
29396
29397
29398 .section "Address verification" "SECTaddressverification"
29399 .cindex "verifying address" "options for"
29400 .cindex "policy control" "address verification"
29401 Several of the &%verify%& conditions described in section
29402 &<<SECTaclconditions>>& cause addresses to be verified. Section
29403 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29404 The verification conditions can be followed by options that modify the
29405 verification process. The options are separated from the keyword and from each
29406 other by slashes, and some of them contain parameters. For example:
29407 .code
29408 verify = sender/callout
29409 verify = recipient/defer_ok/callout=10s,defer_ok
29410 .endd
29411 The first stage of address verification, which always happens, is to run the
29412 address through the routers, in &"verify mode"&. Routers can detect the
29413 difference between verification and routing for delivery, and their actions can
29414 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29415 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29416 The available options are as follows:
29417
29418 .ilist
29419 If the &%callout%& option is specified, successful routing to one or more
29420 remote hosts is followed by a &"callout"& to those hosts as an additional
29421 check. Callouts and their sub-options are discussed in the next section.
29422 .next
29423 If there is a defer error while doing verification routing, the ACL
29424 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29425 options, the condition is forced to be true instead. Note that this is a main
29426 verification option as well as a suboption for callouts.
29427 .next
29428 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29429 discusses the reporting of sender address verification failures.
29430 .next
29431 The &%success_on_redirect%& option causes verification always to succeed
29432 immediately after a successful redirection. By default, if a redirection
29433 generates just one address, that address is also verified. See further
29434 discussion in section &<<SECTredirwhilveri>>&.
29435 .endlist
29436
29437 .cindex "verifying address" "differentiating failures"
29438 .vindex "&$recipient_verify_failure$&"
29439 .vindex "&$sender_verify_failure$&"
29440 .vindex "&$acl_verify_message$&"
29441 After an address verification failure, &$acl_verify_message$& contains the
29442 error message that is associated with the failure. It can be preserved by
29443 coding like this:
29444 .code
29445 warn  !verify = sender
29446        set acl_m0 = $acl_verify_message
29447 .endd
29448 If you are writing your own custom rejection message or log message when
29449 denying access, you can use this variable to include information about the
29450 verification failure.
29451
29452 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29453 appropriate) contains one of the following words:
29454
29455 .ilist
29456 &%qualify%&: The address was unqualified (no domain), and the message
29457 was neither local nor came from an exempted host.
29458 .next
29459 &%route%&: Routing failed.
29460 .next
29461 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29462 occurred at or before the MAIL command (that is, on initial
29463 connection, HELO, or MAIL).
29464 .next
29465 &%recipient%&: The RCPT command in a callout was rejected.
29466 .next
29467 &%postmaster%&: The postmaster check in a callout was rejected.
29468 .endlist
29469
29470 The main use of these variables is expected to be to distinguish between
29471 rejections of MAIL and rejections of RCPT in callouts.
29472
29473
29474
29475
29476 .section "Callout verification" "SECTcallver"
29477 .cindex "verifying address" "by callout"
29478 .cindex "callout" "verification"
29479 .cindex "SMTP" "callout verification"
29480 For non-local addresses, routing verifies the domain, but is unable to do any
29481 checking of the local part. There are situations where some means of verifying
29482 the local part is desirable. One way this can be done is to make an SMTP
29483 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29484 a subsequent host for a recipient address, to see if the host accepts the
29485 address. We use the term &'callout'& to cover both cases. Note that for a
29486 sender address, the callback is not to the client host that is trying to
29487 deliver the message, but to one of the hosts that accepts incoming mail for the
29488 sender's domain.
29489
29490 Exim does not do callouts by default. If you want them to happen, you must
29491 request them by setting appropriate options on the &%verify%& condition, as
29492 described below. This facility should be used with care, because it can add a
29493 lot of resource usage to the cost of verifying an address. However, Exim does
29494 cache the results of callouts, which helps to reduce the cost. Details of
29495 caching are in section &<<SECTcallvercache>>&.
29496
29497 Recipient callouts are usually used only between hosts that are controlled by
29498 the same administration. For example, a corporate gateway host could use
29499 callouts to check for valid recipients on an internal mailserver. A successful
29500 callout does not guarantee that a real delivery to the address would succeed;
29501 on the other hand, a failing callout does guarantee that a delivery would fail.
29502
29503 If the &%callout%& option is present on a condition that verifies an address, a
29504 second stage of verification occurs if the address is successfully routed to
29505 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29506 &(manualroute)& router, where the router specifies the hosts. However, if a
29507 router that does not set up hosts routes to an &(smtp)& transport with a
29508 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29509 &%hosts_override%& set, its hosts are always used, whether or not the router
29510 supplies a host list.
29511 Callouts are only supported on &(smtp)& transports.
29512
29513 The port that is used is taken from the transport, if it is specified and is a
29514 remote transport. (For routers that do verification only, no transport need be
29515 specified.) Otherwise, the default SMTP port is used. If a remote transport
29516 specifies an outgoing interface, this is used; otherwise the interface is not
29517 specified. Likewise, the text that is used for the HELO command is taken from
29518 the transport's &%helo_data%& option; if there is no transport, the value of
29519 &$smtp_active_hostname$& is used.
29520
29521 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29522 test whether a bounce message could be delivered to the sender address. The
29523 following SMTP commands are sent:
29524 .display
29525 &`HELO `&<&'local host name'&>
29526 &`MAIL FROM:<>`&
29527 &`RCPT TO:`&<&'the address to be tested'&>
29528 &`QUIT`&
29529 .endd
29530 LHLO is used instead of HELO if the transport's &%protocol%& option is
29531 set to &"lmtp"&.
29532
29533 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29534 settings.
29535
29536 A recipient callout check is similar. By default, it also uses an empty address
29537 for the sender. This default is chosen because most hosts do not make use of
29538 the sender address when verifying a recipient. Using the same address means
29539 that a single cache entry can be used for each recipient. Some sites, however,
29540 do make use of the sender address when verifying. These are catered for by the
29541 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29542
29543 If the response to the RCPT command is a 2&'xx'& code, the verification
29544 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29545 Exim tries the next host, if any. If there is a problem with all the remote
29546 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29547 &%callout%& option is given, in which case the condition is forced to succeed.
29548
29549 .cindex "SMTP" "output flushing, disabling for callout"
29550 A callout may take a little time. For this reason, Exim normally flushes SMTP
29551 output before performing a callout in an ACL, to avoid unexpected timeouts in
29552 clients when the SMTP PIPELINING extension is in use. The flushing can be
29553 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29554
29555
29556
29557
29558 .section "Additional parameters for callouts" "CALLaddparcall"
29559 .cindex "callout" "additional parameters for"
29560 The &%callout%& option can be followed by an equals sign and a number of
29561 optional parameters, separated by commas. For example:
29562 .code
29563 verify = recipient/callout=10s,defer_ok
29564 .endd
29565 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29566 separate verify options, is retained for backwards compatibility, but is now
29567 deprecated. The additional parameters for &%callout%& are as follows:
29568
29569
29570 .vlist
29571 .vitem <&'a&~time&~interval'&>
29572 .cindex "callout" "timeout, specifying"
29573 This specifies the timeout that applies for the callout attempt to each host.
29574 For example:
29575 .code
29576 verify = sender/callout=5s
29577 .endd
29578 The default is 30 seconds. The timeout is used for each response from the
29579 remote host. It is also used for the initial connection, unless overridden by
29580 the &%connect%& parameter.
29581
29582
29583 .vitem &*connect&~=&~*&<&'time&~interval'&>
29584 .cindex "callout" "connection timeout, specifying"
29585 This parameter makes it possible to set a different (usually smaller) timeout
29586 for making the SMTP connection. For example:
29587 .code
29588 verify = sender/callout=5s,connect=1s
29589 .endd
29590 If not specified, this timeout defaults to the general timeout value.
29591
29592 .vitem &*defer_ok*&
29593 .cindex "callout" "defer, action on"
29594 When this parameter is present, failure to contact any host, or any other kind
29595 of temporary error, is treated as success by the ACL. However, the cache is not
29596 updated in this circumstance.
29597
29598 .vitem &*fullpostmaster*&
29599 .cindex "callout" "full postmaster check"
29600 This operates like the &%postmaster%& option (see below), but if the check for
29601 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29602 accordance with the specification in RFC 2821. The RFC states that the
29603 unqualified address &'postmaster'& should be accepted.
29604
29605
29606 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29607 .cindex "callout" "sender when verifying header"
29608 When verifying addresses in header lines using the &%header_sender%&
29609 verification option, Exim behaves by default as if the addresses are envelope
29610 sender addresses from a message. Callout verification therefore tests to see
29611 whether a bounce message could be delivered, by using an empty address in the
29612 MAIL command. However, it is arguable that these addresses might never be used
29613 as envelope senders, and could therefore justifiably reject bounce messages
29614 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29615 address to use in the MAIL command. For example:
29616 .code
29617 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29618 .endd
29619 This parameter is available only for the &%header_sender%& verification option.
29620
29621
29622 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29623 .cindex "callout" "overall timeout, specifying"
29624 This parameter sets an overall timeout for performing a callout verification.
29625 For example:
29626 .code
29627 verify = sender/callout=5s,maxwait=30s
29628 .endd
29629 This timeout defaults to four times the callout timeout for individual SMTP
29630 commands. The overall timeout applies when there is more than one host that can
29631 be tried. The timeout is checked before trying the next host. This prevents
29632 very long delays if there are a large number of hosts and all are timing out
29633 (for example, when network connections are timing out).
29634
29635
29636 .vitem &*no_cache*&
29637 .cindex "callout" "cache, suppressing"
29638 .cindex "caching callout, suppressing"
29639 When this parameter is given, the callout cache is neither read nor updated.
29640
29641 .vitem &*postmaster*&
29642 .cindex "callout" "postmaster; checking"
29643 When this parameter is set, a successful callout check is followed by a similar
29644 check for the local part &'postmaster'& at the same domain. If this address is
29645 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29646 the postmaster check is recorded in a cache record; if it is a failure, this is
29647 used to fail subsequent callouts for the domain without a connection being
29648 made, until the cache record expires.
29649
29650 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29651 The postmaster check uses an empty sender in the MAIL command by default.
29652 You can use this parameter to do a postmaster check using a different address.
29653 For example:
29654 .code
29655 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29656 .endd
29657 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29658 one overrides. The &%postmaster%& parameter is equivalent to this example:
29659 .code
29660 require  verify = sender/callout=postmaster_mailfrom=
29661 .endd
29662 &*Warning*&: The caching arrangements for postmaster checking do not take
29663 account of the sender address. It is assumed that either the empty address or
29664 a fixed non-empty address will be used. All that Exim remembers is that the
29665 postmaster check for the domain succeeded or failed.
29666
29667
29668 .vitem &*random*&
29669 .cindex "callout" "&""random""& check"
29670 When this parameter is set, before doing the normal callout check, Exim does a
29671 check for a &"random"& local part at the same domain. The local part is not
29672 really random &-- it is defined by the expansion of the option
29673 &%callout_random_local_part%&, which defaults to
29674 .code
29675 $primary_hostname-$tod_epoch-testing
29676 .endd
29677 The idea here is to try to determine whether the remote host accepts all local
29678 parts without checking. If it does, there is no point in doing callouts for
29679 specific local parts. If the &"random"& check succeeds, the result is saved in
29680 a cache record, and used to force the current and subsequent callout checks to
29681 succeed without a connection being made, until the cache record expires.
29682
29683 .vitem &*use_postmaster*&
29684 .cindex "callout" "sender for recipient check"
29685 This parameter applies to recipient callouts only. For example:
29686 .code
29687 deny  !verify = recipient/callout=use_postmaster
29688 .endd
29689 .vindex "&$qualify_domain$&"
29690 It causes a non-empty postmaster address to be used in the MAIL command when
29691 performing the callout for the recipient, and also for a &"random"& check if
29692 that is configured. The local part of the address is &`postmaster`& and the
29693 domain is the contents of &$qualify_domain$&.
29694
29695 .vitem &*use_sender*&
29696 This option applies to recipient callouts only. For example:
29697 .code
29698 require  verify = recipient/callout=use_sender
29699 .endd
29700 It causes the message's actual sender address to be used in the MAIL
29701 command when performing the callout, instead of an empty address. There is no
29702 need to use this option unless you know that the called hosts make use of the
29703 sender when checking recipients. If used indiscriminately, it reduces the
29704 usefulness of callout caching.
29705 .endlist
29706
29707 If you use any of the parameters that set a non-empty sender for the MAIL
29708 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29709 &%use_sender%&), you should think about possible loops. Recipient checking is
29710 usually done between two hosts that are under the same management, and the host
29711 that receives the callouts is not normally configured to do callouts itself.
29712 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29713 these circumstances.
29714
29715 However, if you use a non-empty sender address for a callout to an arbitrary
29716 host, there is the likelihood that the remote host will itself initiate a
29717 callout check back to your host. As it is checking what appears to be a message
29718 sender, it is likely to use an empty address in MAIL, thus avoiding a
29719 callout loop. However, to be on the safe side it would be best to set up your
29720 own ACLs so that they do not do sender verification checks when the recipient
29721 is the address you use for header sender or postmaster callout checking.
29722
29723 Another issue to think about when using non-empty senders for callouts is
29724 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29725 by the sender/recipient combination; thus, for any given recipient, many more
29726 actual callouts are performed than when an empty sender or postmaster is used.
29727
29728
29729
29730
29731 .section "Callout caching" "SECTcallvercache"
29732 .cindex "hints database" "callout cache"
29733 .cindex "callout" "cache, description of"
29734 .cindex "caching" "callout"
29735 Exim caches the results of callouts in order to reduce the amount of resources
29736 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29737 option. A hints database called &"callout"& is used for the cache. Two
29738 different record types are used: one records the result of a callout check for
29739 a specific address, and the other records information that applies to the
29740 entire domain (for example, that it accepts the local part &'postmaster'&).
29741
29742 When an original callout fails, a detailed SMTP error message is given about
29743 the failure. However, for subsequent failures use the cache data, this message
29744 is not available.
29745
29746 The expiry times for negative and positive address cache records are
29747 independent, and can be set by the global options &%callout_negative_expire%&
29748 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29749
29750 If a host gives a negative response to an SMTP connection, or rejects any
29751 commands up to and including
29752 .code
29753 MAIL FROM:<>
29754 .endd
29755 (but not including the MAIL command with a non-empty address),
29756 any callout attempt is bound to fail. Exim remembers such failures in a
29757 domain cache record, which it uses to fail callouts for the domain without
29758 making new connections, until the domain record times out. There are two
29759 separate expiry times for domain cache records:
29760 &%callout_domain_negative_expire%& (default 3h) and
29761 &%callout_domain_positive_expire%& (default 7d).
29762
29763 Domain records expire when the negative expiry time is reached if callouts
29764 cannot be made for the domain, or if the postmaster check failed.
29765 Otherwise, they expire when the positive expiry time is reached. This
29766 ensures that, for example, a host that stops accepting &"random"& local parts
29767 will eventually be noticed.
29768
29769 The callout caching mechanism is based on the domain of the address that is
29770 being tested. If the domain routes to several hosts, it is assumed that their
29771 behaviour will be the same.
29772
29773
29774
29775 .section "Sender address verification reporting" "SECTsenaddver"
29776 .cindex "verifying" "suppressing error details"
29777 See section &<<SECTaddressverification>>& for a general discussion of
29778 verification. When sender verification fails in an ACL, the details of the
29779 failure are given as additional output lines before the 550 response to the
29780 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29781 you might see:
29782 .code
29783 MAIL FROM:<xyz@abc.example>
29784 250 OK
29785 RCPT TO:<pqr@def.example>
29786 550-Verification failed for <xyz@abc.example>
29787 550-Called:   192.168.34.43
29788 550-Sent:     RCPT TO:<xyz@abc.example>
29789 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29790 550 Sender verification failed
29791 .endd
29792 If more than one RCPT command fails in the same way, the details are given
29793 only for the first of them. However, some administrators do not want to send
29794 out this much information. You can suppress the details by adding
29795 &`/no_details`& to the ACL statement that requests sender verification. For
29796 example:
29797 .code
29798 verify = sender/no_details
29799 .endd
29800
29801 .section "Redirection while verifying" "SECTredirwhilveri"
29802 .cindex "verifying" "redirection while"
29803 .cindex "address redirection" "while verifying"
29804 A dilemma arises when a local address is redirected by aliasing or forwarding
29805 during verification: should the generated addresses themselves be verified,
29806 or should the successful expansion of the original address be enough to verify
29807 it? By default, Exim takes the following pragmatic approach:
29808
29809 .ilist
29810 When an incoming address is redirected to just one child address, verification
29811 continues with the child address, and if that fails to verify, the original
29812 verification also fails.
29813 .next
29814 When an incoming address is redirected to more than one child address,
29815 verification does not continue. A success result is returned.
29816 .endlist
29817
29818 This seems the most reasonable behaviour for the common use of aliasing as a
29819 way of redirecting different local parts to the same mailbox. It means, for
29820 example, that a pair of alias entries of the form
29821 .code
29822 A.Wol:   aw123
29823 aw123:   :fail: Gone away, no forwarding address
29824 .endd
29825 work as expected, with both local parts causing verification failure. When a
29826 redirection generates more than one address, the behaviour is more like a
29827 mailing list, where the existence of the alias itself is sufficient for
29828 verification to succeed.
29829
29830 It is possible, however, to change the default behaviour so that all successful
29831 redirections count as successful verifications, however many new addresses are
29832 generated. This is specified by the &%success_on_redirect%& verification
29833 option. For example:
29834 .code
29835 require verify = recipient/success_on_redirect/callout=10s
29836 .endd
29837 In this example, verification succeeds if a router generates a new address, and
29838 the callout does not occur, because no address was routed to a remote host.
29839
29840 When verification is being tested via the &%-bv%& option, the treatment of
29841 redirections is as just described, unless the &%-v%& or any debugging option is
29842 also specified. In that case, full verification is done for every generated
29843 address and a report is output for each of them.
29844
29845
29846
29847 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29848 .cindex "CSA" "verifying"
29849 Client SMTP Authorization is a system that allows a site to advertise
29850 which machines are and are not permitted to send email. This is done by placing
29851 special SRV records in the DNS; these are looked up using the client's HELO
29852 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29853 Authorization checks in Exim are performed by the ACL condition:
29854 .code
29855 verify = csa
29856 .endd
29857 This fails if the client is not authorized. If there is a DNS problem, or if no
29858 valid CSA SRV record is found, or if the client is authorized, the condition
29859 succeeds. These three cases can be distinguished using the expansion variable
29860 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29861 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29862 be likely to cause problems for legitimate email.
29863
29864 The error messages produced by the CSA code include slightly more
29865 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29866 looking up the CSA SRV record, or problems looking up the CSA target
29867 address record. There are four reasons for &$csa_status$& being &"fail"&:
29868
29869 .ilist
29870 The client's host name is explicitly not authorized.
29871 .next
29872 The client's IP address does not match any of the CSA target IP addresses.
29873 .next
29874 The client's host name is authorized but it has no valid target IP addresses
29875 (for example, the target's addresses are IPv6 and the client is using IPv4).
29876 .next
29877 The client's host name has no CSA SRV record but a parent domain has asserted
29878 that all subdomains must be explicitly authorized.
29879 .endlist
29880
29881 The &%csa%& verification condition can take an argument which is the domain to
29882 use for the DNS query. The default is:
29883 .code
29884 verify = csa/$sender_helo_name
29885 .endd
29886 This implementation includes an extension to CSA. If the query domain
29887 is an address literal such as [192.0.2.95], or if it is a bare IP
29888 address, Exim searches for CSA SRV records in the reverse DNS as if
29889 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29890 meaningful to say:
29891 .code
29892 verify = csa/$sender_host_address
29893 .endd
29894 In fact, this is the check that Exim performs if the client does not say HELO.
29895 This extension can be turned off by setting the main configuration option
29896 &%dns_csa_use_reverse%& to be false.
29897
29898 If a CSA SRV record is not found for the domain itself, a search
29899 is performed through its parent domains for a record which might be
29900 making assertions about subdomains. The maximum depth of this search is limited
29901 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29902 default. Exim does not look for CSA SRV records in a top level domain, so the
29903 default settings handle HELO domains as long as seven
29904 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29905 of legitimate HELO domains.
29906
29907 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29908 direct SRV lookups, this is not sufficient because of the extra parent domain
29909 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29910 addresses into lookups in the reverse DNS space. The result of a successful
29911 lookup such as:
29912 .code
29913 ${lookup dnsdb {csa=$sender_helo_name}}
29914 .endd
29915 has two space-separated fields: an authorization code and a target host name.
29916 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29917 authorization required but absent, or &"?"& for unknown.
29918
29919
29920
29921
29922 .section "Bounce address tag validation" "SECTverifyPRVS"
29923 .cindex "BATV, verifying"
29924 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29925 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29926 Genuine incoming bounce messages should therefore always be addressed to
29927 recipients that have a valid tag. This scheme is a way of detecting unwanted
29928 bounce messages caused by sender address forgeries (often called &"collateral
29929 spam"&), because the recipients of such messages do not include valid tags.
29930
29931 There are two expansion items to help with the implementation of the BATV
29932 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29933 the original envelope sender address by using a simple key to add a hash of the
29934 address and some time-based randomizing information. The &%prvs%& expansion
29935 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29936 The syntax of these expansion items is described in section
29937 &<<SECTexpansionitems>>&.
29938
29939 As an example, suppose the secret per-address keys are stored in an MySQL
29940 database. A query to look up the key for an address could be defined as a macro
29941 like this:
29942 .code
29943 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29944                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29945                 }{$value}}
29946 .endd
29947 Suppose also that the senders who make use of BATV are defined by an address
29948 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29949 use this:
29950 .code
29951 # Bounces: drop unsigned addresses for BATV senders
29952 deny message = This address does not send an unsigned reverse path
29953      senders = :
29954      recipients = +batv_senders
29955
29956 # Bounces: In case of prvs-signed address, check signature.
29957 deny message = Invalid reverse path signature.
29958      senders = :
29959      condition  = ${prvscheck {$local_part@$domain}\
29960                   {PRVSCHECK_SQL}{1}}
29961      !condition = $prvscheck_result
29962 .endd
29963 The first statement rejects recipients for bounce messages that are addressed
29964 to plain BATV sender addresses, because it is known that BATV senders do not
29965 send out messages with plain sender addresses. The second statement rejects
29966 recipients that are prvs-signed, but with invalid signatures (either because
29967 the key is wrong, or the signature has timed out).
29968
29969 A non-prvs-signed address is not rejected by the second statement, because the
29970 &%prvscheck%& expansion yields an empty string if its first argument is not a
29971 prvs-signed address, thus causing the &%condition%& condition to be false. If
29972 the first argument is a syntactically valid prvs-signed address, the yield is
29973 the third string (in this case &"1"&), whether or not the cryptographic and
29974 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29975 of the checks (empty for failure, &"1"& for success).
29976
29977 There is one more issue you must consider when implementing prvs-signing:
29978 you have to ensure that the routers accept prvs-signed addresses and
29979 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29980 router to remove the signature with a configuration along these lines:
29981 .code
29982 batv_redirect:
29983   driver = redirect
29984   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29985 .endd
29986 This works because, if the third argument of &%prvscheck%& is empty, the result
29987 of the expansion of a prvs-signed address is the decoded value of the original
29988 address. This router should probably be the first of your routers that handles
29989 local addresses.
29990
29991 To create BATV-signed addresses in the first place, a transport of this form
29992 can be used:
29993 .code
29994 external_smtp_batv:
29995   driver = smtp
29996   return_path = ${prvs {$return_path} \
29997                        {${lookup mysql{SELECT \
29998                        secret FROM batv_prvs WHERE \
29999                        sender='${quote_mysql:$sender_address}'} \
30000                        {$value}fail}}}
30001 .endd
30002 If no key can be found for the existing return path, no signing takes place.
30003
30004
30005
30006 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30007 .cindex "&ACL;" "relay control"
30008 .cindex "relaying" "control by ACL"
30009 .cindex "policy control" "relay control"
30010 An MTA is said to &'relay'& a message if it receives it from some host and
30011 delivers it directly to another host as a result of a remote address contained
30012 within it. Redirecting a local address via an alias or forward file and then
30013 passing the message on to another host is not relaying,
30014 .cindex "&""percent hack""&"
30015 but a redirection as a result of the &"percent hack"& is.
30016
30017 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30018 A host which is acting as a gateway or an MX backup is concerned with incoming
30019 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30020 a host which is acting as a smart host for a number of clients is concerned
30021 with outgoing relaying from those clients to the Internet at large. Often the
30022 same host is fulfilling both functions,
30023 . ///
30024 . as illustrated in the diagram below,
30025 . ///
30026 but in principle these two kinds of relaying are entirely independent. What is
30027 not wanted is the transmission of mail from arbitrary remote hosts through your
30028 system to arbitrary domains.
30029
30030
30031 You can implement relay control by means of suitable statements in the ACL that
30032 runs for each RCPT command. For convenience, it is often easiest to use
30033 Exim's named list facility to define the domains and hosts involved. For
30034 example, suppose you want to do the following:
30035
30036 .ilist
30037 Deliver a number of domains to mailboxes on the local host (or process them
30038 locally in some other way). Let's say these are &'my.dom1.example'& and
30039 &'my.dom2.example'&.
30040 .next
30041 Relay mail for a number of other domains for which you are the secondary MX.
30042 These might be &'friend1.example'& and &'friend2.example'&.
30043 .next
30044 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30045 Suppose your LAN is 192.168.45.0/24.
30046 .endlist
30047
30048
30049 In the main part of the configuration, you put the following definitions:
30050 .code
30051 domainlist local_domains    = my.dom1.example : my.dom2.example
30052 domainlist relay_to_domains = friend1.example : friend2.example
30053 hostlist   relay_from_hosts = 192.168.45.0/24
30054 .endd
30055 Now you can use these definitions in the ACL that is run for every RCPT
30056 command:
30057 .code
30058 acl_check_rcpt:
30059   accept domains = +local_domains : +relay_to_domains
30060   accept hosts   = +relay_from_hosts
30061 .endd
30062 The first statement accepts any RCPT command that contains an address in
30063 the local or relay domains. For any other domain, control passes to the second
30064 statement, which accepts the command only if it comes from one of the relay
30065 hosts. In practice, you will probably want to make your ACL more sophisticated
30066 than this, for example, by including sender and recipient verification. The
30067 default configuration includes a more comprehensive example, which is described
30068 in chapter &<<CHAPdefconfil>>&.
30069
30070
30071
30072 .section "Checking a relay configuration" "SECTcheralcon"
30073 .cindex "relaying" "checking control of"
30074 You can check the relay characteristics of your configuration in the same way
30075 that you can test any ACL behaviour for an incoming SMTP connection, by using
30076 the &%-bh%& option to run a fake SMTP session with which you interact.
30077
30078 For specifically testing for unwanted relaying, the host
30079 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30080 host from the host on which Exim is running, using the normal telnet port, you
30081 will see a normal telnet connection message and then quite a long delay. Be
30082 patient. The remote host is making an SMTP connection back to your host, and
30083 trying a number of common probes to test for open relay vulnerability. The
30084 results of the tests will eventually appear on your terminal.
30085 .ecindex IIDacl
30086
30087
30088
30089 . ////////////////////////////////////////////////////////////////////////////
30090 . ////////////////////////////////////////////////////////////////////////////
30091
30092 .chapter "Content scanning at ACL time" "CHAPexiscan"
30093 .scindex IIDcosca "content scanning" "at ACL time"
30094 The extension of Exim to include content scanning at ACL time, formerly known
30095 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30096 was integrated into the main source for Exim release 4.50, and Tom continues to
30097 maintain it. Most of the wording of this chapter is taken from Tom's
30098 specification.
30099
30100 It is also possible to scan the content of messages at other times. The
30101 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30102 scanning after all the ACLs have run. A transport filter can be used to scan
30103 messages at delivery time (see the &%transport_filter%& option, described in
30104 chapter &<<CHAPtransportgeneric>>&).
30105
30106 If you want to include the ACL-time content-scanning features when you compile
30107 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30108 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30109
30110 .ilist
30111 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30112 for all MIME parts for SMTP and non-SMTP messages, respectively.
30113 .next
30114 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30115 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30116 run at the end of message reception (the &%acl_smtp_data%& ACL).
30117 .next
30118 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30119 of messages, or parts of messages, for debugging purposes.
30120 .next
30121 Additional expansion variables that are set in the new ACL and by the new
30122 conditions.
30123 .next
30124 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30125 .endlist
30126
30127 There is another content-scanning configuration option for &_Local/Makefile_&,
30128 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30129 condition is compiled, in addition to all the other content-scanning features.
30130
30131 Content-scanning is continually evolving, and new features are still being
30132 added. While such features are still unstable and liable to incompatible
30133 changes, they are made available in Exim by setting options whose names begin
30134 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30135 this manual. You can find out about them by reading the file called
30136 &_doc/experimental.txt_&.
30137
30138 All the content-scanning facilities work on a MBOX copy of the message that is
30139 temporarily created in a file called:
30140 .display
30141 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30142 .endd
30143 The &_.eml_& extension is a friendly hint to virus scanners that they can
30144 expect an MBOX-like structure inside that file. The file is created when the
30145 first content scanning facility is called. Subsequent calls to content
30146 scanning conditions open the same file again. The directory is recursively
30147 removed when the &%acl_smtp_data%& ACL has finished running, unless
30148 .code
30149 control = no_mbox_unspool
30150 .endd
30151 has been encountered. When the MIME ACL decodes files, they are put into the
30152 same directory by default.
30153
30154
30155
30156 .section "Scanning for viruses" "SECTscanvirus"
30157 .cindex "virus scanning"
30158 .cindex "content scanning" "for viruses"
30159 .cindex "content scanning" "the &%malware%& condition"
30160 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30161 It supports a &"generic"& interface to scanners called via the shell, and
30162 specialized interfaces for &"daemon"& type virus scanners, which are resident
30163 in memory and thus are much faster.
30164
30165
30166 .oindex "&%av_scanner%&"
30167 You can set the &%av_scanner%& option in first part of the Exim configuration
30168 file to specify which scanner to use, together with any additional options that
30169 are needed. The basic syntax is as follows:
30170 .display
30171 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30172 .endd
30173 If you do not set &%av_scanner%&, it defaults to
30174 .code
30175 av_scanner = sophie:/var/run/sophie
30176 .endd
30177 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30178 before use.
30179 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30180 The following scanner types are supported in this release:
30181
30182 .vlist
30183 .vitem &%aveserver%&
30184 .cindex "virus scanners" "Kaspersky"
30185 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30186 at &url(http://www.kaspersky.com). This scanner type takes one option,
30187 which is the path to the daemon's UNIX socket. The default is shown in this
30188 example:
30189 .code
30190 av_scanner = aveserver:/var/run/aveserver
30191 .endd
30192
30193
30194 .vitem &%clamd%&
30195 .cindex "virus scanners" "clamd"
30196 This daemon-type scanner is GPL and free. You can get it at
30197 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30198 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30199 in the MIME ACL. This no longer believed to be necessary. One option is
30200 required: either the path and name of a UNIX socket file, or a hostname or IP
30201 number, and a port, separated by space, as in the second of these examples:
30202 .code
30203 av_scanner = clamd:/opt/clamd/socket
30204 av_scanner = clamd:192.0.2.3 1234
30205 av_scanner = clamd:192.0.2.3 1234:local
30206 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30207 .endd
30208 If the value of av_scanner points to a UNIX socket file or contains the local
30209 keyword, then the ClamAV interface will pass a filename containing the data
30210 to be scanned, which will should normally result in less I/O happening and be
30211 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30212 Exim does not assume that there is a common filesystem with the remote host.
30213 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30214 you be running a version of ClamAV prior to 0.95.
30215
30216 The final example shows that multiple TCP targets can be specified.  Exim will
30217 randomly use one for each incoming email (i.e. it load balances them).  Note
30218 that only TCP targets may be used if specifying a list of scanners; a UNIX
30219 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30220 unavailable, Exim will try the remaining one(s) until it finds one that works.
30221 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30222 not keep track of scanner state between multiple messages, and the scanner
30223 selection is random, so the message will get logged in the mainlog for each
30224 email that the down scanner gets chosen first (message wrapped to be readable):
30225 .code
30226 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30227    clamd: connection to localhost, port 3310 failed
30228    (Connection refused)
30229 .endd
30230
30231 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30232 contributing the code for this scanner.
30233
30234 .vitem &%cmdline%&
30235 .cindex "virus scanners" "command line interface"
30236 This is the keyword for the generic command line scanner interface. It can be
30237 used to attach virus scanners that are invoked from the shell. This scanner
30238 type takes 3 mandatory options:
30239
30240 .olist
30241 The full path and name of the scanner binary, with all command line options,
30242 and a placeholder (&`%s`&) for the directory to scan.
30243
30244 .next
30245 A regular expression to match against the STDOUT and STDERR output of the
30246 virus scanner. If the expression matches, a virus was found. You must make
30247 absolutely sure that this expression matches on &"virus found"&. This is called
30248 the &"trigger"& expression.
30249
30250 .next
30251 Another regular expression, containing exactly one pair of parentheses, to
30252 match the name of the virus found in the scanners output. This is called the
30253 &"name"& expression.
30254 .endlist olist
30255
30256 For example, Sophos Sweep reports a virus on a line like this:
30257 .code
30258 Virus 'W32/Magistr-B' found in file ./those.bat
30259 .endd
30260 For the trigger expression, we can match the phrase &"found in file"&. For the
30261 name expression, we want to extract the W32/Magistr-B string, so we can match
30262 for the single quotes left and right of it. Altogether, this makes the
30263 configuration setting:
30264 .code
30265 av_scanner = cmdline:\
30266              /path/to/sweep -ss -all -rec -archive %s:\
30267              found in file:'(.+)'
30268 .endd
30269 .vitem &%drweb%&
30270 .cindex "virus scanners" "DrWeb"
30271 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
30272 argument, either a full path to a UNIX socket, or an IP address and port
30273 separated by white space, as in these examples:
30274 .code
30275 av_scanner = drweb:/var/run/drwebd.sock
30276 av_scanner = drweb:192.168.2.20 31337
30277 .endd
30278 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30279 is used. Thanks to Alex Miller for contributing the code for this scanner.
30280
30281 .vitem &%fsecure%&
30282 .cindex "virus scanners" "F-Secure"
30283 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30284 argument which is the path to a UNIX socket. For example:
30285 .code
30286 av_scanner = fsecure:/path/to/.fsav
30287 .endd
30288 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30289 Thelmen for contributing the code for this scanner.
30290
30291 .vitem &%kavdaemon%&
30292 .cindex "virus scanners" "Kaspersky"
30293 This is the scanner daemon of Kaspersky Version 4. This version of the
30294 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30295 scanner type takes one option, which is the path to the daemon's UNIX socket.
30296 For example:
30297 .code
30298 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30299 .endd
30300 The default path is &_/var/run/AvpCtl_&.
30301
30302 .vitem &%mksd%&
30303 .cindex "virus scanners" "mksd"
30304 This is a daemon type scanner that is aimed mainly at Polish users, though some
30305 parts of documentation are now available in English. You can get it at
30306 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30307 the maximum number of processes used simultaneously to scan the attachments,
30308 provided that the demime facility is employed and also provided that mksd has
30309 been run with at least the same number of child processes. For example:
30310 .code
30311 av_scanner = mksd:2
30312 .endd
30313 You can safely omit this option (the default value is 1).
30314
30315 .vitem &%sock%&
30316 .cindex "virus scanners" "simple socket-connected"
30317 This is a general-purpose way of talking to simple scanner daemons
30318 running on the local machine.
30319 There are four options:
30320 an address (which may be an IP addres and port, or the path of a Unix socket),
30321 a commandline to send (may include a single %s which will be replaced with
30322 the path to the mail file to be scanned),
30323 an RE to trigger on from the returned data,
30324 an RE to extract malware_name from the returned data.
30325 For example:
30326 .code
30327 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30328 .endd
30329 Default for the socket specifier is &_/tmp/malware.sock_&.
30330 Default for the commandline is &_%s\n_&.
30331 Both regular-expressions are required.
30332
30333 .vitem &%sophie%&
30334 .cindex "virus scanners" "Sophos and Sophie"
30335 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30336 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30337 for this scanner type is the path to the UNIX socket that Sophie uses for
30338 client communication. For example:
30339 .code
30340 av_scanner = sophie:/tmp/sophie
30341 .endd
30342 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30343 the option.
30344 .endlist
30345
30346 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30347 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30348 ACL.
30349
30350 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30351 makes it possible to use different scanners. See further below for an example.
30352 The &%malware%& condition caches its results, so when you use it multiple times
30353 for the same message, the actual scanning process is only carried out once.
30354 However, using expandable items in &%av_scanner%& disables this caching, in
30355 which case each use of the &%malware%& condition causes a new scan of the
30356 message.
30357
30358 The &%malware%& condition takes a right-hand argument that is expanded before
30359 use. It can then be one of
30360
30361 .ilist
30362 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30363 The condition succeeds if a virus was found, and fail otherwise. This is the
30364 recommended usage.
30365 .next
30366 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30367 the condition fails immediately.
30368 .next
30369 A regular expression, in which case the message is scanned for viruses. The
30370 condition succeeds if a virus is found and its name matches the regular
30371 expression. This allows you to take special actions on certain types of virus.
30372 .endlist
30373
30374 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30375 even if there is a problem with the virus scanner. Otherwise, such a problem
30376 causes the ACL to defer.
30377
30378 .vindex "&$malware_name$&"
30379 When a virus is found, the condition sets up an expansion variable called
30380 &$malware_name$& that contains the name of the virus. You can use it in a
30381 &%message%& modifier that specifies the error returned to the sender, and/or in
30382 logging data.
30383
30384 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30385 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30386 &%malware%& condition.
30387
30388 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30389 imposed by your anti-virus scanner.
30390
30391 Here is a very simple scanning example:
30392 .code
30393 deny message = This message contains malware ($malware_name)
30394      demime = *
30395      malware = *
30396 .endd
30397 The next example accepts messages when there is a problem with the scanner:
30398 .code
30399 deny message = This message contains malware ($malware_name)
30400      demime = *
30401      malware = */defer_ok
30402 .endd
30403 The next example shows how to use an ACL variable to scan with both sophie and
30404 aveserver. It assumes you have set:
30405 .code
30406 av_scanner = $acl_m0
30407 .endd
30408 in the main Exim configuration.
30409 .code
30410 deny message = This message contains malware ($malware_name)
30411      set acl_m0 = sophie
30412      malware = *
30413
30414 deny message = This message contains malware ($malware_name)
30415      set acl_m0 = aveserver
30416      malware = *
30417 .endd
30418
30419
30420 .section "Scanning with SpamAssassin" "SECTscanspamass"
30421 .cindex "content scanning" "for spam"
30422 .cindex "spam scanning"
30423 .cindex "SpamAssassin"
30424 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30425 score and a report for the message. You can get SpamAssassin at
30426 &url(http://www.spamassassin.org), or, if you have a working Perl
30427 installation, you can use CPAN by running:
30428 .code
30429 perl -MCPAN -e 'install Mail::SpamAssassin'
30430 .endd
30431 SpamAssassin has its own set of configuration files. Please review its
30432 documentation to see how you can tweak it. The default installation should work
30433 nicely, however.
30434
30435 .oindex "&%spamd_address%&"
30436 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30437 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30438 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30439 part of the Exim configuration as follows (example):
30440 .code
30441 spamd_address = 192.168.99.45 387
30442 .endd
30443 You do not need to set this option if you use the default. As of version 2.60,
30444 &%spamd%& also supports communication over UNIX sockets. If you want to use
30445 these, supply &%spamd_address%& with an absolute file name instead of a
30446 address/port pair:
30447 .code
30448 spamd_address = /var/run/spamd_socket
30449 .endd
30450 You can have multiple &%spamd%& servers to improve scalability. These can
30451 reside on other hardware reachable over the network. To specify multiple
30452 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30453 option, separated with colons:
30454 .code
30455 spamd_address = 192.168.2.10 783 : \
30456                 192.168.2.11 783 : \
30457                 192.168.2.12 783
30458 .endd
30459 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30460 fashion. When a server fails to respond to the connection attempt, all other
30461 servers are tried until one succeeds. If no server responds, the &%spam%&
30462 condition defers.
30463
30464 &*Warning*&: It is not possible to use the UNIX socket connection method with
30465 multiple &%spamd%& servers.
30466
30467 The &%spamd_address%& variable is expanded before use if it starts with
30468 a dollar sign. In this case, the expansion may return a string that is
30469 used as the list so that multiple spamd servers can be the result of an
30470 expansion.
30471
30472 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30473 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30474 .code
30475 deny message = This message was classified as SPAM
30476      spam = joe
30477 .endd
30478 The right-hand side of the &%spam%& condition specifies a name. This is
30479 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30480 to scan using a specific profile, but rather use the SpamAssassin system-wide
30481 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30482 However, you must put something on the right-hand side.
30483
30484 The name allows you to use per-domain or per-user antispam profiles in
30485 principle, but this is not straightforward in practice, because a message may
30486 have multiple recipients, not necessarily all in the same domain. Because the
30487 &%spam%& condition has to be called from a DATA ACL in order to be able to
30488 read the contents of the message, the variables &$local_part$& and &$domain$&
30489 are not set.
30490
30491 The right-hand side of the &%spam%& condition is expanded before being used, so
30492 you can put lookups or conditions there. When the right-hand side evaluates to
30493 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30494
30495
30496 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30497 large ones may cause significant performance degradation. As most spam messages
30498 are quite small, it is recommended that you do not scan the big ones. For
30499 example:
30500 .code
30501 deny message = This message was classified as SPAM
30502      condition = ${if < {$message_size}{10K}}
30503      spam = nobody
30504 .endd
30505
30506 The &%spam%& condition returns true if the threshold specified in the user's
30507 SpamAssassin profile has been matched or exceeded. If you want to use the
30508 &%spam%& condition for its side effects (see the variables below), you can make
30509 it always return &"true"& by appending &`:true`& to the username.
30510
30511 .cindex "spam scanning" "returned variables"
30512 When the &%spam%& condition is run, it sets up a number of expansion
30513 variables. These variables are saved with the received message, thus they are
30514 available for use at delivery time.
30515
30516 .vlist
30517 .vitem &$spam_score$&
30518 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30519 for inclusion in log or reject messages.
30520
30521 .vitem &$spam_score_int$&
30522 The spam score of the message, multiplied by ten, as an integer value. For
30523 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30524 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30525 The integer value is useful for numeric comparisons in conditions.
30526
30527 .vitem &$spam_bar$&
30528 A string consisting of a number of &"+"& or &"-"& characters, representing the
30529 integer part of the spam score value. A spam score of 4.4 would have a
30530 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30531 headers, since MUAs can match on such strings.
30532
30533 .vitem &$spam_report$&
30534 A multiline text table, containing the full SpamAssassin report for the
30535 message. Useful for inclusion in headers or reject messages.
30536 .endlist
30537
30538 The &%spam%& condition caches its results unless expansion in
30539 spamd_address was used. If you call it again with the same user name, it
30540 does not scan again, but rather returns the same values as before.
30541
30542 The &%spam%& condition returns DEFER if there is any error while running
30543 the message through SpamAssassin or if the expansion of spamd_address
30544 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30545 statement block), append &`/defer_ok`& to the right-hand side of the
30546 spam condition, like this:
30547 .code
30548 deny message = This message was classified as SPAM
30549      spam    = joe/defer_ok
30550 .endd
30551 This causes messages to be accepted even if there is a problem with &%spamd%&.
30552
30553 Here is a longer, commented example of the use of the &%spam%&
30554 condition:
30555 .code
30556 # put headers in all messages (no matter if spam or not)
30557 warn  spam = nobody:true
30558       add_header = X-Spam-Score: $spam_score ($spam_bar)
30559       add_header = X-Spam-Report: $spam_report
30560
30561 # add second subject line with *SPAM* marker when message
30562 # is over threshold
30563 warn  spam = nobody
30564       add_header = Subject: *SPAM* $h_Subject:
30565
30566 # reject spam at high scores (> 12)
30567 deny  message = This message scored $spam_score spam points.
30568       spam = nobody:true
30569       condition = ${if >{$spam_score_int}{120}{1}{0}}
30570 .endd
30571
30572
30573
30574 .section "Scanning MIME parts" "SECTscanmimepart"
30575 .cindex "content scanning" "MIME parts"
30576 .cindex "MIME content scanning"
30577 .oindex "&%acl_smtp_mime%&"
30578 .oindex "&%acl_not_smtp_mime%&"
30579 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30580 each MIME part of an SMTP message, including multipart types, in the sequence
30581 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30582 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30583 options may both refer to the same ACL if you want the same processing in both
30584 cases.
30585
30586 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30587 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30588 the case of a non-SMTP message. However, a MIME ACL is called only if the
30589 message contains a &'Content-Type:'& header line. When a call to a MIME
30590 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30591 result code is sent to the client. In the case of an SMTP message, the
30592 &%acl_smtp_data%& ACL is not called when this happens.
30593
30594 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30595 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30596 condition to match against the raw MIME part. You can also use the
30597 &%mime_regex%& condition to match against the decoded MIME part (see section
30598 &<<SECTscanregex>>&).
30599
30600 At the start of a MIME ACL, a number of variables are set from the header
30601 information for the relevant MIME part. These are described below. The contents
30602 of the MIME part are not by default decoded into a disk file except for MIME
30603 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30604 part into a disk file, you can use the &%decode%& condition. The general
30605 syntax is:
30606 .display
30607 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30608 .endd
30609 The right hand side is expanded before use. After expansion,
30610 the value can be:
30611
30612 .olist
30613 &"0"& or &"false"&, in which case no decoding is done.
30614 .next
30615 The string &"default"&. In that case, the file is put in the temporary
30616 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30617 a sequential file name consisting of the message id and a sequence number. The
30618 full path and name is available in &$mime_decoded_filename$& after decoding.
30619 .next
30620 A full path name starting with a slash. If the full name is an existing
30621 directory, it is used as a replacement for the default directory. The filename
30622 is then sequentially assigned. If the path does not exist, it is used as
30623 the full path and file name.
30624 .next
30625 If the string does not start with a slash, it is used as the
30626 filename, and the default path is then used.
30627 .endlist
30628 The &%decode%& condition normally succeeds. It is only false for syntax
30629 errors or unusual circumstances such as memory shortages. You can easily decode
30630 a file with its original, proposed filename using
30631 .code
30632 decode = $mime_filename
30633 .endd
30634 However, you should keep in mind that &$mime_filename$& might contain
30635 anything. If you place files outside of the default path, they are not
30636 automatically unlinked.
30637
30638 For RFC822 attachments (these are messages attached to messages, with a
30639 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30640 as for the primary message, only that the &$mime_is_rfc822$& expansion
30641 variable is set (see below). Attached messages are always decoded to disk
30642 before being checked, and the files are unlinked once the check is done.
30643
30644 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30645 used to match regular expressions against raw and decoded MIME parts,
30646 respectively. They are described in section &<<SECTscanregex>>&.
30647
30648 .cindex "MIME content scanning" "returned variables"
30649 The following list describes all expansion variables that are
30650 available in the MIME ACL:
30651
30652 .vlist
30653 .vitem &$mime_boundary$&
30654 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30655 have a boundary string, which is stored in this variable. If the current part
30656 has no boundary parameter in the &'Content-Type:'& header, this variable
30657 contains the empty string.
30658
30659 .vitem &$mime_charset$&
30660 This variable contains the character set identifier, if one was found in the
30661 &'Content-Type:'& header. Examples for charset identifiers are:
30662 .code
30663 us-ascii
30664 gb2312 (Chinese)
30665 iso-8859-1
30666 .endd
30667 Please note that this value is not normalized, so you should do matches
30668 case-insensitively.
30669
30670 .vitem &$mime_content_description$&
30671 This variable contains the normalized content of the &'Content-Description:'&
30672 header. It can contain a human-readable description of the parts content. Some
30673 implementations repeat the filename for attachments here, but they are usually
30674 only used for display purposes.
30675
30676 .vitem &$mime_content_disposition$&
30677 This variable contains the normalized content of the &'Content-Disposition:'&
30678 header. You can expect strings like &"attachment"& or &"inline"& here.
30679
30680 .vitem &$mime_content_id$&
30681 This variable contains the normalized content of the &'Content-ID:'& header.
30682 This is a unique ID that can be used to reference a part from another part.
30683
30684 .vitem &$mime_content_size$&
30685 This variable is set only after the &%decode%& modifier (see above) has been
30686 successfully run. It contains the size of the decoded part in kilobytes. The
30687 size is always rounded up to full kilobytes, so only a completely empty part
30688 has a &$mime_content_size$& of zero.
30689
30690 .vitem &$mime_content_transfer_encoding$&
30691 This variable contains the normalized content of the
30692 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30693 type. Typical values are &"base64"& and &"quoted-printable"&.
30694
30695 .vitem &$mime_content_type$&
30696 If the MIME part has a &'Content-Type:'& header, this variable contains its
30697 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30698 are some examples of popular MIME types, as they may appear in this variable:
30699 .code
30700 text/plain
30701 text/html
30702 application/octet-stream
30703 image/jpeg
30704 audio/midi
30705 .endd
30706 If the MIME part has no &'Content-Type:'& header, this variable contains the
30707 empty string.
30708
30709 .vitem &$mime_decoded_filename$&
30710 This variable is set only after the &%decode%& modifier (see above) has been
30711 successfully run. It contains the full path and file name of the file
30712 containing the decoded data.
30713 .endlist
30714
30715 .cindex "RFC 2047"
30716 .vlist
30717 .vitem &$mime_filename$&
30718 This is perhaps the most important of the MIME variables. It contains a
30719 proposed filename for an attachment, if one was found in either the
30720 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30721 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30722 found, this variable contains the empty string.
30723
30724 .vitem &$mime_is_coverletter$&
30725 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30726 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30727 content in the cover letter, while not restricting attachments at all.
30728
30729 The variable contains 1 (true) for a MIME part believed to be part of the
30730 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30731 follows:
30732
30733 .olist
30734 The outermost MIME part of a message is always a cover letter.
30735
30736 .next
30737 If a multipart/alternative or multipart/related MIME part is a cover letter,
30738 so are all MIME subparts within that multipart.
30739
30740 .next
30741 If any other multipart is a cover letter, the first subpart is a cover letter,
30742 and the rest are attachments.
30743
30744 .next
30745 All parts contained within an attachment multipart are attachments.
30746 .endlist olist
30747
30748 As an example, the following will ban &"HTML mail"& (including that sent with
30749 alternative plain text), while allowing HTML files to be attached. HTML
30750 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30751 .code
30752 deny message = HTML mail is not accepted here
30753 !condition = $mime_is_rfc822
30754 condition = $mime_is_coverletter
30755 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30756 .endd
30757 .vitem &$mime_is_multipart$&
30758 This variable has the value 1 (true) when the current part has the main type
30759 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30760 Since multipart entities only serve as containers for other parts, you may not
30761 want to carry out specific actions on them.
30762
30763 .vitem &$mime_is_rfc822$&
30764 This variable has the value 1 (true) if the current part is not a part of the
30765 checked message itself, but part of an attached message. Attached message
30766 decoding is fully recursive.
30767
30768 .vitem &$mime_part_count$&
30769 This variable is a counter that is raised for each processed MIME part. It
30770 starts at zero for the very first part (which is usually a multipart). The
30771 counter is per-message, so it is reset when processing RFC822 attachments (see
30772 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30773 complete, so you can use it in the DATA ACL to determine the number of MIME
30774 parts of a message. For non-MIME messages, this variable contains the value -1.
30775 .endlist
30776
30777
30778
30779 .section "Scanning with regular expressions" "SECTscanregex"
30780 .cindex "content scanning" "with regular expressions"
30781 .cindex "regular expressions" "content scanning with"
30782 You can specify your own custom regular expression matches on the full body of
30783 the message, or on individual MIME parts.
30784
30785 The &%regex%& condition takes one or more regular expressions as arguments and
30786 matches them against the full message (when called in the DATA ACL) or a raw
30787 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30788 linewise, with a maximum line length of 32K characters. That means you cannot
30789 have multiline matches with the &%regex%& condition.
30790
30791 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30792 to 32K of decoded content (the whole content at once, not linewise). If the
30793 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30794 is decoded automatically when &%mime_regex%& is executed (using default path
30795 and filename values). If the decoded data is larger than  32K, only the first
30796 32K characters are checked.
30797
30798 The regular expressions are passed as a colon-separated list. To include a
30799 literal colon, you must double it. Since the whole right-hand side string is
30800 expanded before being used, you must also escape dollar signs and backslashes
30801 with more backslashes, or use the &`\N`& facility to disable expansion.
30802 Here is a simple example that contains two regular expressions:
30803 .code
30804 deny message = contains blacklisted regex ($regex_match_string)
30805      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30806 .endd
30807 The conditions returns true if any one of the regular expressions matches. The
30808 &$regex_match_string$& expansion variable is then set up and contains the
30809 matching regular expression.
30810
30811 &*Warning*&: With large messages, these conditions can be fairly
30812 CPU-intensive.
30813
30814
30815
30816
30817 .section "The demime condition" "SECTdemimecond"
30818 .cindex "content scanning" "MIME checking"
30819 .cindex "MIME content scanning"
30820 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30821 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30822 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30823 ACL functionality, but provides no additional facilities. Please note that this
30824 condition is deprecated and kept only for backward compatibility. You must set
30825 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30826 use the &%demime%& condition.
30827
30828 The &%demime%& condition unpacks MIME containers in the message. It detects
30829 errors in MIME containers and can match file extensions found in the message
30830 against a list. Using this facility produces files containing the unpacked MIME
30831 parts of the message in the temporary scan directory. If you do antivirus
30832 scanning, it is recommended that you use the &%demime%& condition before the
30833 antivirus (&%malware%&) condition.
30834
30835 On the right-hand side of the &%demime%& condition you can pass a
30836 colon-separated list of file extensions that it should match against. For
30837 example:
30838 .code
30839 deny message = Found blacklisted file attachment
30840      demime  = vbs:com:bat:pif:prf:lnk
30841 .endd
30842 If one of the file extensions is found, the condition is true, otherwise it is
30843 false. If there is a temporary error while demimeing (for example, &"disk
30844 full"&), the condition defers, and the message is temporarily rejected (unless
30845 the condition is on a &%warn%& verb).
30846
30847 The right-hand side is expanded before being treated as a list, so you can have
30848 conditions and lookups there. If it expands to an empty string, &"false"&, or
30849 zero (&"0"&), no demimeing is done and the condition is false.
30850
30851 The &%demime%& condition set the following variables:
30852
30853 .vlist
30854 .vitem &$demime_errorlevel$&
30855 .vindex "&$demime_errorlevel$&"
30856 When an error is detected in a MIME container, this variable contains the
30857 severity of the error, as an integer number. The higher the value, the more
30858 severe the error (the current maximum value is 3). If this variable is unset or
30859 zero, no error occurred.
30860
30861 .vitem &$demime_reason$&
30862 .vindex "&$demime_reason$&"
30863 When &$demime_errorlevel$& is greater than zero, this variable contains a
30864 human-readable text string describing the MIME error that occurred.
30865 .endlist
30866
30867 .vlist
30868 .vitem &$found_extension$&
30869 .vindex "&$found_extension$&"
30870 When the &%demime%& condition is true, this variable contains the file
30871 extension it found.
30872 .endlist
30873
30874 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30875 the &%demime%& condition, and are not changed on subsequent calls.
30876
30877 If you do not want to check for file extensions, but rather use the &%demime%&
30878 condition for unpacking or error checking purposes, pass &"*"& as the
30879 right-hand side value. Here is a more elaborate example of how to use this
30880 facility:
30881 .code
30882 # Reject messages with serious MIME container errors
30883 deny  message = Found MIME error ($demime_reason).
30884       demime = *
30885       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30886
30887 # Reject known virus spreading file extensions.
30888 # Accepting these is pretty much braindead.
30889 deny  message = contains $found_extension file (blacklisted).
30890       demime  = com:vbs:bat:pif:scr
30891
30892 # Freeze .exe and .doc files. Postmaster can
30893 # examine them and eventually thaw them.
30894 deny  log_message = Another $found_extension file.
30895       demime = exe:doc
30896       control = freeze
30897 .endd
30898 .ecindex IIDcosca
30899
30900
30901
30902
30903 . ////////////////////////////////////////////////////////////////////////////
30904 . ////////////////////////////////////////////////////////////////////////////
30905
30906 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30907          "Local scan function"
30908 .scindex IIDlosca "&[local_scan()]& function" "description of"
30909 .cindex "customizing" "input scan using C function"
30910 .cindex "policy control" "by local scan function"
30911 In these days of email worms, viruses, and ever-increasing spam, some sites
30912 want to apply a lot of checking to messages before accepting them.
30913
30914 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30915 passing messages to external virus and spam scanning software. You can also do
30916 a certain amount in Exim itself through string expansions and the &%condition%&
30917 condition in the ACL that runs after the SMTP DATA command or the ACL for
30918 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30919
30920 To allow for further customization to a site's own requirements, there is the
30921 possibility of linking Exim with a private message scanning function, written
30922 in C. If you want to run code that is written in something other than C, you
30923 can of course use a little C stub to call it.
30924
30925 The local scan function is run once for every incoming message, at the point
30926 when Exim is just about to accept the message.
30927 It can therefore be used to control non-SMTP messages from local processes as
30928 well as messages arriving via SMTP.
30929
30930 Exim applies a timeout to calls of the local scan function, and there is an
30931 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30932 Zero means &"no timeout"&.
30933 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30934 before calling the local scan function, so that the most common types of crash
30935 are caught. If the timeout is exceeded or one of those signals is caught, the
30936 incoming message is rejected with a temporary error if it is an SMTP message.
30937 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30938 code. The incident is logged on the main and reject logs.
30939
30940
30941
30942 .section "Building Exim to use a local scan function" "SECID207"
30943 .cindex "&[local_scan()]& function" "building Exim to use"
30944 To make use of the local scan function feature, you must tell Exim where your
30945 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30946 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30947 directory, so you might set
30948 .code
30949 LOCAL_SCAN_SOURCE=Local/local_scan.c
30950 .endd
30951 for example. The function must be called &[local_scan()]&. It is called by
30952 Exim after it has received a message, when the success return code is about to
30953 be sent. This is after all the ACLs have been run. The return code from your
30954 function controls whether the message is actually accepted or not. There is a
30955 commented template function (that just accepts the message) in the file
30956 _src/local_scan.c_.
30957
30958 If you want to make use of Exim's run time configuration file to set options
30959 for your &[local_scan()]& function, you must also set
30960 .code
30961 LOCAL_SCAN_HAS_OPTIONS=yes
30962 .endd
30963 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30964
30965
30966
30967
30968 .section "API for local_scan()" "SECTapiforloc"
30969 .cindex "&[local_scan()]& function" "API description"
30970 You must include this line near the start of your code:
30971 .code
30972 #include "local_scan.h"
30973 .endd
30974 This header file defines a number of variables and other values, and the
30975 prototype for the function itself. Exim is coded to use unsigned char values
30976 almost exclusively, and one of the things this header defines is a shorthand
30977 for &`unsigned char`& called &`uschar`&.
30978 It also contains the following macro definitions, to simplify casting character
30979 strings and pointers to character strings:
30980 .code
30981 #define CS   (char *)
30982 #define CCS  (const char *)
30983 #define CSS  (char **)
30984 #define US   (unsigned char *)
30985 #define CUS  (const unsigned char *)
30986 #define USS  (unsigned char **)
30987 .endd
30988 The function prototype for &[local_scan()]& is:
30989 .code
30990 extern int local_scan(int fd, uschar **return_text);
30991 .endd
30992 The arguments are as follows:
30993
30994 .ilist
30995 &%fd%& is a file descriptor for the file that contains the body of the message
30996 (the -D file). The file is open for reading and writing, but updating it is not
30997 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30998
30999 The descriptor is positioned at character 19 of the file, which is the first
31000 character of the body itself, because the first 19 characters are the message
31001 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31002 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31003 case this changes in some future version.
31004 .next
31005 &%return_text%& is an address which you can use to return a pointer to a text
31006 string at the end of the function. The value it points to on entry is NULL.
31007 .endlist
31008
31009 The function must return an &%int%& value which is one of the following macros:
31010
31011 .vlist
31012 .vitem &`LOCAL_SCAN_ACCEPT`&
31013 .vindex "&$local_scan_data$&"
31014 The message is accepted. If you pass back a string of text, it is saved with
31015 the message, and made available in the variable &$local_scan_data$&. No
31016 newlines are permitted (if there are any, they are turned into spaces) and the
31017 maximum length of text is 1000 characters.
31018
31019 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31020 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31021 queued without immediate delivery, and is frozen.
31022
31023 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31024 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31025 queued without immediate delivery.
31026
31027 .vitem &`LOCAL_SCAN_REJECT`&
31028 The message is rejected; the returned text is used as an error message which is
31029 passed back to the sender and which is also logged. Newlines are permitted &--
31030 they cause a multiline response for SMTP rejections, but are converted to
31031 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31032 used.
31033
31034 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31035 The message is temporarily rejected; the returned text is used as an error
31036 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31037 problem"& is used.
31038
31039 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31040 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31041 message is not written to the reject log. It has the effect of unsetting the
31042 &%rejected_header%& log selector for just this rejection. If
31043 &%rejected_header%& is already unset (see the discussion of the
31044 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31045 same as LOCAL_SCAN_REJECT.
31046
31047 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31048 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31049 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31050 .endlist
31051
31052 If the message is not being received by interactive SMTP, rejections are
31053 reported by writing to &%stderr%& or by sending an email, as configured by the
31054 &%-oe%& command line options.
31055
31056
31057
31058 .section "Configuration options for local_scan()" "SECTconoptloc"
31059 .cindex "&[local_scan()]& function" "configuration options"
31060 It is possible to have option settings in the main configuration file
31061 that set values in static variables in the &[local_scan()]& module. If you
31062 want to do this, you must have the line
31063 .code
31064 LOCAL_SCAN_HAS_OPTIONS=yes
31065 .endd
31066 in your &_Local/Makefile_& when you build Exim. (This line is in
31067 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31068 file, you must define static variables to hold the option values, and a table
31069 to define them.
31070
31071 The table must be a vector called &%local_scan_options%&, of type
31072 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31073 and a pointer to the variable that holds the value. The entries must appear in
31074 alphabetical order. Following &%local_scan_options%& you must also define a
31075 variable called &%local_scan_options_count%& that contains the number of
31076 entries in the table. Here is a short example, showing two kinds of option:
31077 .code
31078 static int my_integer_option = 42;
31079 static uschar *my_string_option = US"a default string";
31080
31081 optionlist local_scan_options[] = {
31082   { "my_integer", opt_int,       &my_integer_option },
31083   { "my_string",  opt_stringptr, &my_string_option }
31084 };
31085
31086 int local_scan_options_count =
31087   sizeof(local_scan_options)/sizeof(optionlist);
31088 .endd
31089 The values of the variables can now be changed from Exim's runtime
31090 configuration file by including a local scan section as in this example:
31091 .code
31092 begin local_scan
31093 my_integer = 99
31094 my_string = some string of text...
31095 .endd
31096 The available types of option data are as follows:
31097
31098 .vlist
31099 .vitem &*opt_bool*&
31100 This specifies a boolean (true/false) option. The address should point to a
31101 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31102 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31103 whether such a variable has been set at all, you can initialize it to
31104 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31105 values.)
31106
31107 .vitem &*opt_fixed*&
31108 This specifies a fixed point number, such as is used for load averages.
31109 The address should point to a variable of type &`int`&. The value is stored
31110 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31111
31112 .vitem &*opt_int*&
31113 This specifies an integer; the address should point to a variable of type
31114 &`int`&. The value may be specified in any of the integer formats accepted by
31115 Exim.
31116
31117 .vitem &*opt_mkint*&
31118 This is the same as &%opt_int%&, except that when such a value is output in a
31119 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31120 printed with the suffix K or M.
31121
31122 .vitem &*opt_octint*&
31123 This also specifies an integer, but the value is always interpreted as an
31124 octal integer, whether or not it starts with the digit zero, and it is
31125 always output in octal.
31126
31127 .vitem &*opt_stringptr*&
31128 This specifies a string value; the address must be a pointer to a
31129 variable that points to a string (for example, of type &`uschar *`&).
31130
31131 .vitem &*opt_time*&
31132 This specifies a time interval value. The address must point to a variable of
31133 type &`int`&. The value that is placed there is a number of seconds.
31134 .endlist
31135
31136 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31137 out the values of all the &[local_scan()]& options.
31138
31139
31140
31141 .section "Available Exim variables" "SECID208"
31142 .cindex "&[local_scan()]& function" "available Exim variables"
31143 The header &_local_scan.h_& gives you access to a number of C variables. These
31144 are the only ones that are guaranteed to be maintained from release to release.
31145 Note, however, that you can obtain the value of any Exim expansion variable,
31146 including &$recipients$&, by calling &'expand_string()'&. The exported
31147 C variables are as follows:
31148
31149 .vlist
31150 .vitem &*int&~body_linecount*&
31151 This variable contains the number of lines in the message's body.
31152
31153 .vitem &*int&~body_zerocount*&
31154 This variable contains the number of binary zero bytes in the message's body.
31155
31156 .vitem &*unsigned&~int&~debug_selector*&
31157 This variable is set to zero when no debugging is taking place. Otherwise, it
31158 is a bitmap of debugging selectors. Two bits are identified for use in
31159 &[local_scan()]&; they are defined as macros:
31160
31161 .ilist
31162 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31163 testing option that is not privileged &-- any caller may set it. All the
31164 other selector bits can be set only by admin users.
31165
31166 .next
31167 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31168 by the &`+local_scan`& debug selector. It is not included in the default set
31169 of debugging bits.
31170 .endlist ilist
31171
31172 Thus, to write to the debugging output only when &`+local_scan`& has been
31173 selected, you should use code like this:
31174 .code
31175 if ((debug_selector & D_local_scan) != 0)
31176   debug_printf("xxx", ...);
31177 .endd
31178 .vitem &*uschar&~*expand_string_message*&
31179 After a failing call to &'expand_string()'& (returned value NULL), the
31180 variable &%expand_string_message%& contains the error message, zero-terminated.
31181
31182 .vitem &*header_line&~*header_list*&
31183 A pointer to a chain of header lines. The &%header_line%& structure is
31184 discussed below.
31185
31186 .vitem &*header_line&~*header_last*&
31187 A pointer to the last of the header lines.
31188
31189 .vitem &*uschar&~*headers_charset*&
31190 The value of the &%headers_charset%& configuration option.
31191
31192 .vitem &*BOOL&~host_checking*&
31193 This variable is TRUE during a host checking session that is initiated by the
31194 &%-bh%& command line option.
31195
31196 .vitem &*uschar&~*interface_address*&
31197 The IP address of the interface that received the message, as a string. This
31198 is NULL for locally submitted messages.
31199
31200 .vitem &*int&~interface_port*&
31201 The port on which this message was received. When testing with the &%-bh%&
31202 command line option, the value of this variable is -1 unless a port has been
31203 specified via the &%-oMi%& option.
31204
31205 .vitem &*uschar&~*message_id*&
31206 This variable contains Exim's message id for the incoming message (the value of
31207 &$message_exim_id$&) as a zero-terminated string.
31208
31209 .vitem &*uschar&~*received_protocol*&
31210 The name of the protocol by which the message was received.
31211
31212 .vitem &*int&~recipients_count*&
31213 The number of accepted recipients.
31214
31215 .vitem &*recipient_item&~*recipients_list*&
31216 .cindex "recipient" "adding in local scan"
31217 .cindex "recipient" "removing in local scan"
31218 The list of accepted recipients, held in a vector of length
31219 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31220 can add additional recipients by calling &'receive_add_recipient()'& (see
31221 below). You can delete recipients by removing them from the vector and
31222 adjusting the value in &%recipients_count%&. In particular, by setting
31223 &%recipients_count%& to zero you remove all recipients. If you then return the
31224 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31225 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31226 and then call &'receive_add_recipient()'& as often as needed.
31227
31228 .vitem &*uschar&~*sender_address*&
31229 The envelope sender address. For bounce messages this is the empty string.
31230
31231 .vitem &*uschar&~*sender_host_address*&
31232 The IP address of the sending host, as a string. This is NULL for
31233 locally-submitted messages.
31234
31235 .vitem &*uschar&~*sender_host_authenticated*&
31236 The name of the authentication mechanism that was used, or NULL if the message
31237 was not received over an authenticated SMTP connection.
31238
31239 .vitem &*uschar&~*sender_host_name*&
31240 The name of the sending host, if known.
31241
31242 .vitem &*int&~sender_host_port*&
31243 The port on the sending host.
31244
31245 .vitem &*BOOL&~smtp_input*&
31246 This variable is TRUE for all SMTP input, including BSMTP.
31247
31248 .vitem &*BOOL&~smtp_batched_input*&
31249 This variable is TRUE for BSMTP input.
31250
31251 .vitem &*int&~store_pool*&
31252 The contents of this variable control which pool of memory is used for new
31253 requests. See section &<<SECTmemhanloc>>& for details.
31254 .endlist
31255
31256
31257 .section "Structure of header lines" "SECID209"
31258 The &%header_line%& structure contains the members listed below.
31259 You can add additional header lines by calling the &'header_add()'& function
31260 (see below). You can cause header lines to be ignored (deleted) by setting
31261 their type to *.
31262
31263
31264 .vlist
31265 .vitem &*struct&~header_line&~*next*&
31266 A pointer to the next header line, or NULL for the last line.
31267
31268 .vitem &*int&~type*&
31269 A code identifying certain headers that Exim recognizes. The codes are printing
31270 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31271 Notice in particular that any header line whose type is * is not transmitted
31272 with the message. This flagging is used for header lines that have been
31273 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31274 lines.) Effectively, * means &"deleted"&.
31275
31276 .vitem &*int&~slen*&
31277 The number of characters in the header line, including the terminating and any
31278 internal newlines.
31279
31280 .vitem &*uschar&~*text*&
31281 A pointer to the text of the header. It always ends with a newline, followed by
31282 a zero byte. Internal newlines are preserved.
31283 .endlist
31284
31285
31286
31287 .section "Structure of recipient items" "SECID210"
31288 The &%recipient_item%& structure contains these members:
31289
31290 .vlist
31291 .vitem &*uschar&~*address*&
31292 This is a pointer to the recipient address as it was received.
31293
31294 .vitem &*int&~pno*&
31295 This is used in later Exim processing when top level addresses are created by
31296 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31297 and must always contain -1 at this stage.
31298
31299 .vitem &*uschar&~*errors_to*&
31300 If this value is not NULL, bounce messages caused by failing to deliver to the
31301 recipient are sent to the address it contains. In other words, it overrides the
31302 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31303 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31304 an unqualified address, Exim qualifies it using the domain from
31305 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31306 is NULL for all recipients.
31307 .endlist
31308
31309
31310
31311 .section "Available Exim functions" "SECID211"
31312 .cindex "&[local_scan()]& function" "available Exim functions"
31313 The header &_local_scan.h_& gives you access to a number of Exim functions.
31314 These are the only ones that are guaranteed to be maintained from release to
31315 release:
31316
31317 .vlist
31318 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31319        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31320
31321 This function creates a child process that runs the command specified by
31322 &%argv%&. The environment for the process is specified by &%envp%&, which can
31323 be NULL if no environment variables are to be passed. A new umask is supplied
31324 for the process in &%newumask%&.
31325
31326 Pipes to the standard input and output of the new process are set up
31327 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31328 standard error is cloned to the standard output. If there are any file
31329 descriptors &"in the way"& in the new process, they are closed. If the final
31330 argument is TRUE, the new process is made into a process group leader.
31331
31332 The function returns the pid of the new process, or -1 if things go wrong.
31333
31334 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31335 This function waits for a child process to terminate, or for a timeout (in
31336 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31337 return value is as follows:
31338
31339 .ilist
31340 >= 0
31341
31342 The process terminated by a normal exit and the value is the process
31343 ending status.
31344
31345 .next
31346 < 0 and > &--256
31347
31348 The process was terminated by a signal and the value is the negation of the
31349 signal number.
31350
31351 .next
31352 &--256
31353
31354 The process timed out.
31355 .next
31356 &--257
31357
31358 The was some other error in wait(); &%errno%& is still set.
31359 .endlist
31360
31361 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31362 This function provide you with a means of submitting a new message to
31363 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31364 want, but this packages it all up for you.) The function creates a pipe,
31365 forks a subprocess that is running
31366 .code
31367 exim -t -oem -oi -f <>
31368 .endd
31369 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31370 that is connected to the standard input. The yield of the function is the PID
31371 of the subprocess. You can then write a message to the file descriptor, with
31372 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31373
31374 When you have finished, call &'child_close()'& to wait for the process to
31375 finish and to collect its ending status. A timeout value of zero is usually
31376 fine in this circumstance. Unless you have made a mistake with the recipient
31377 addresses, you should get a return code of zero.
31378
31379
31380 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31381        *sender_authentication)*&
31382 This function is a more sophisticated version of &'child_open()'&. The command
31383 that it runs is:
31384 .display
31385 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31386 .endd
31387 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31388
31389
31390 .vitem &*void&~debug_printf(char&~*,&~...)*&
31391 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31392 output is written to the standard error stream. If no debugging is selected,
31393 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31394 conditional on the &`local_scan`& debug selector by coding like this:
31395 .code
31396 if ((debug_selector & D_local_scan) != 0)
31397   debug_printf("xxx", ...);
31398 .endd
31399
31400 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31401 This is an interface to Exim's string expansion code. The return value is the
31402 expanded string, or NULL if there was an expansion failure.
31403 The C variable &%expand_string_message%& contains an error message after an
31404 expansion failure. If expansion does not change the string, the return value is
31405 the pointer to the input string. Otherwise, the return value points to a new
31406 block of memory that was obtained by a call to &'store_get()'&. See section
31407 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31408
31409 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31410 This function allows you to an add additional header line at the end of the
31411 existing ones. The first argument is the type, and should normally be a space
31412 character. The second argument is a format string and any number of
31413 substitution arguments as for &[sprintf()]&. You may include internal newlines
31414 if you want, and you must ensure that the string ends with a newline.
31415
31416 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31417         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31418 This function adds a new header line at a specified point in the header
31419 chain. The header itself is specified as for &'header_add()'&.
31420
31421 If &%name%& is NULL, the new header is added at the end of the chain if
31422 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31423 NULL, the header lines are searched for the first non-deleted header that
31424 matches the name. If one is found, the new header is added before it if
31425 &%after%& is false. If &%after%& is true, the new header is added after the
31426 found header and any adjacent subsequent ones with the same name (even if
31427 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31428 option controls where the header is added. If it is true, addition is at the
31429 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31430 headers, or at the top if there are no &'Received:'& headers, you could use
31431 .code
31432 header_add_at_position(TRUE, US"Received", TRUE,
31433   ' ', "X-xxx: ...");
31434 .endd
31435 Normally, there is always at least one non-deleted &'Received:'& header, but
31436 there may not be if &%received_header_text%& expands to an empty string.
31437
31438
31439 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31440 This function removes header lines. If &%occurrence%& is zero or negative, all
31441 occurrences of the header are removed. If occurrence is greater than zero, that
31442 particular instance of the header is removed. If no header(s) can be found that
31443 match the specification, the function does nothing.
31444
31445
31446 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31447         int&~length,&~BOOL&~notdel)*&"
31448 This function tests whether the given header has the given name. It is not just
31449 a string comparison, because white space is permitted between the name and the
31450 colon. If the &%notdel%& argument is true, a false return is forced for all
31451 &"deleted"& headers; otherwise they are not treated specially. For example:
31452 .code
31453 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31454 .endd
31455 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31456 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31457 This function base64-encodes a string, which is passed by address and length.
31458 The text may contain bytes of any value, including zero. The result is passed
31459 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31460 zero-terminated.
31461
31462 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31463 This function decodes a base64-encoded string. Its arguments are a
31464 zero-terminated base64-encoded string and the address of a variable that is set
31465 to point to the result, which is in dynamic memory. The length of the decoded
31466 string is the yield of the function. If the input is invalid base64 data, the
31467 yield is -1. A zero byte is added to the end of the output string to make it
31468 easy to interpret as a C string (assuming it contains no zeros of its own). The
31469 added zero byte is not included in the returned count.
31470
31471 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31472 This function checks for a match in a domain list. Domains are always
31473 matched caselessly. The return value is one of the following:
31474 .display
31475 &`OK     `& match succeeded
31476 &`FAIL   `& match failed
31477 &`DEFER  `& match deferred
31478 .endd
31479 DEFER is usually caused by some kind of lookup defer, such as the
31480 inability to contact a database.
31481
31482 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31483         BOOL&~caseless)*&"
31484 This function checks for a match in a local part list. The third argument
31485 controls case-sensitivity. The return values are as for
31486 &'lss_match_domain()'&.
31487
31488 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31489         BOOL&~caseless)*&"
31490 This function checks for a match in an address list. The third argument
31491 controls the case-sensitivity of the local part match. The domain is always
31492 matched caselessly. The return values are as for &'lss_match_domain()'&.
31493
31494 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31495         uschar&~*list)*&"
31496 This function checks for a match in a host list. The most common usage is
31497 expected to be
31498 .code
31499 lss_match_host(sender_host_name, sender_host_address, ...)
31500 .endd
31501 .vindex "&$sender_host_address$&"
31502 An empty address field matches an empty item in the host list. If the host name
31503 is NULL, the name corresponding to &$sender_host_address$& is automatically
31504 looked up if a host name is required to match an item in the list. The return
31505 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31506 returns ERROR in the case when it had to look up a host name, but the lookup
31507 failed.
31508
31509 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31510         *format,&~...)*&"
31511 This function writes to Exim's log files. The first argument should be zero (it
31512 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31513 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31514 them. It specifies to which log or logs the message is written. The remaining
31515 arguments are a format and relevant insertion arguments. The string should not
31516 contain any newlines, not even at the end.
31517
31518
31519 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31520 This function adds an additional recipient to the message. The first argument
31521 is the recipient address. If it is unqualified (has no domain), it is qualified
31522 with the &%qualify_recipient%& domain. The second argument must always be -1.
31523
31524 This function does not allow you to specify a private &%errors_to%& address (as
31525 described with the structure of &%recipient_item%& above), because it pre-dates
31526 the addition of that field to the structure. However, it is easy to add such a
31527 value afterwards. For example:
31528 .code
31529  receive_add_recipient(US"monitor@mydom.example", -1);
31530  recipients_list[recipients_count-1].errors_to =
31531    US"postmaster@mydom.example";
31532 .endd
31533
31534 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31535 This is a convenience function to remove a named recipient from the list of
31536 recipients. It returns true if a recipient was removed, and false if no
31537 matching recipient could be found. The argument must be a complete email
31538 address.
31539 .endlist
31540
31541
31542 .cindex "RFC 2047"
31543 .vlist
31544 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31545   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31546 This function decodes strings that are encoded according to RFC 2047. Typically
31547 these are the contents of header lines. First, each &"encoded word"& is decoded
31548 from the Q or B encoding into a byte-string. Then, if provided with the name of
31549 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31550 made  to translate the result to the named character set. If this fails, the
31551 binary string is returned with an error message.
31552
31553 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31554 maximum MIME word length is enforced. The third argument is the target
31555 encoding, or NULL if no translation is wanted.
31556
31557 .cindex "binary zero" "in RFC 2047 decoding"
31558 .cindex "RFC 2047" "binary zero in"
31559 If a binary zero is encountered in the decoded string, it is replaced by the
31560 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31561 not be 0 because header lines are handled as zero-terminated strings.
31562
31563 The function returns the result of processing the string, zero-terminated; if
31564 &%lenptr%& is not NULL, the length of the result is set in the variable to
31565 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31566
31567 If an error is encountered, the function returns NULL and uses the &%error%&
31568 argument to return an error message. The variable pointed to by &%error%& is
31569 set to NULL if there is no error; it may be set non-NULL even when the function
31570 returns a non-NULL value if decoding was successful, but there was a problem
31571 with translation.
31572
31573
31574 .vitem &*int&~smtp_fflush(void)*&
31575 This function is used in conjunction with &'smtp_printf()'&, as described
31576 below.
31577
31578 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31579 The arguments of this function are like &[printf()]&; it writes to the SMTP
31580 output stream. You should use this function only when there is an SMTP output
31581 stream, that is, when the incoming message is being received via interactive
31582 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31583 is FALSE. If you want to test for an incoming message from another host (as
31584 opposed to a local process that used the &%-bs%& command line option), you can
31585 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31586 is involved.
31587
31588 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31589 output function, so it can be used for all forms of SMTP connection.
31590
31591 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31592 must start with an appropriate response code: 550 if you are going to return
31593 LOCAL_SCAN_REJECT, 451 if you are going to return
31594 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31595 initial lines of a multi-line response, the code must be followed by a hyphen
31596 to indicate that the line is not the final response line. You must also ensure
31597 that the lines you write terminate with CRLF. For example:
31598 .code
31599 smtp_printf("550-this is some extra info\r\n");
31600 return LOCAL_SCAN_REJECT;
31601 .endd
31602 Note that you can also create multi-line responses by including newlines in
31603 the data returned via the &%return_text%& argument. The added value of using
31604 &'smtp_printf()'& is that, for instance, you could introduce delays between
31605 multiple output lines.
31606
31607 The &'smtp_printf()'& function does not return any error indication, because it
31608 does not automatically flush pending output, and therefore does not test
31609 the state of the stream. (In the main code of Exim, flushing and error
31610 detection is done when Exim is ready for the next SMTP input command.) If
31611 you want to flush the output and check for an error (for example, the
31612 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31613 arguments. It flushes the output stream, and returns a non-zero value if there
31614 is an error.
31615
31616 .vitem &*void&~*store_get(int)*&
31617 This function accesses Exim's internal store (memory) manager. It gets a new
31618 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31619 runs out of memory. See the next section for a discussion of memory handling.
31620
31621 .vitem &*void&~*store_get_perm(int)*&
31622 This function is like &'store_get()'&, but it always gets memory from the
31623 permanent pool. See the next section for a discussion of memory handling.
31624
31625 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31626 See below.
31627
31628 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31629 See below.
31630
31631 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31632 These three functions create strings using Exim's dynamic memory facilities.
31633 The first makes a copy of an entire string. The second copies up to a maximum
31634 number of characters, indicated by the second argument. The third uses a format
31635 and insertion arguments to create a new string. In each case, the result is a
31636 pointer to a new string in the current memory pool. See the next section for
31637 more discussion.
31638 .endlist
31639
31640
31641
31642 .section "More about Exim's memory handling" "SECTmemhanloc"
31643 .cindex "&[local_scan()]& function" "memory handling"
31644 No function is provided for freeing memory, because that is never needed.
31645 The dynamic memory that Exim uses when receiving a message is automatically
31646 recycled if another message is received by the same process (this applies only
31647 to incoming SMTP connections &-- other input methods can supply only one
31648 message at a time). After receiving the last message, a reception process
31649 terminates.
31650
31651 Because it is recycled, the normal dynamic memory cannot be used for holding
31652 data that must be preserved over a number of incoming messages on the same SMTP
31653 connection. However, Exim in fact uses two pools of dynamic memory; the second
31654 one is not recycled, and can be used for this purpose.
31655
31656 If you want to allocate memory that remains available for subsequent messages
31657 in the same SMTP connection, you should set
31658 .code
31659 store_pool = POOL_PERM
31660 .endd
31661 before calling the function that does the allocation. There is no need to
31662 restore the value if you do not need to; however, if you do want to revert to
31663 the normal pool, you can either restore the previous value of &%store_pool%& or
31664 set it explicitly to POOL_MAIN.
31665
31666 The pool setting applies to all functions that get dynamic memory, including
31667 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31668 There is also a convenience function called &'store_get_perm()'& that gets a
31669 block of memory from the permanent pool while preserving the value of
31670 &%store_pool%&.
31671 .ecindex IIDlosca
31672
31673
31674
31675
31676 . ////////////////////////////////////////////////////////////////////////////
31677 . ////////////////////////////////////////////////////////////////////////////
31678
31679 .chapter "System-wide message filtering" "CHAPsystemfilter"
31680 .scindex IIDsysfil1 "filter" "system filter"
31681 .scindex IIDsysfil2 "filtering all mail"
31682 .scindex IIDsysfil3 "system filter"
31683 The previous chapters (on ACLs and the local scan function) describe checks
31684 that can be applied to messages before they are accepted by a host. There is
31685 also a mechanism for checking messages once they have been received, but before
31686 they are delivered. This is called the &'system filter'&.
31687
31688 The system filter operates in a similar manner to users' filter files, but it
31689 is run just once per message (however many recipients the message has).
31690 It should not normally be used as a substitute for routing, because &%deliver%&
31691 commands in a system router provide new envelope recipient addresses.
31692 The system filter must be an Exim filter. It cannot be a Sieve filter.
31693
31694 The system filter is run at the start of a delivery attempt, before any routing
31695 is done. If a message fails to be completely delivered at the first attempt,
31696 the system filter is run again at the start of every retry.
31697 If you want your filter to do something only once per message, you can make use
31698 of the &%first_delivery%& condition in an &%if%& command in the filter to
31699 prevent it happening on retries.
31700
31701 .vindex "&$domain$&"
31702 .vindex "&$local_part$&"
31703 &*Warning*&: Because the system filter runs just once, variables that are
31704 specific to individual recipient addresses, such as &$local_part$& and
31705 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31706 you want to run a centrally-specified filter for each recipient address
31707 independently, you can do so by setting up a suitable &(redirect)& router, as
31708 described in section &<<SECTperaddfil>>& below.
31709
31710
31711 .section "Specifying a system filter" "SECID212"
31712 .cindex "uid (user id)" "system filter"
31713 .cindex "gid (group id)" "system filter"
31714 The name of the file that contains the system filter must be specified by
31715 setting &%system_filter%&. If you want the filter to run under a uid and gid
31716 other than root, you must also set &%system_filter_user%& and
31717 &%system_filter_group%& as appropriate. For example:
31718 .code
31719 system_filter = /etc/mail/exim.filter
31720 system_filter_user = exim
31721 .endd
31722 If a system filter generates any deliveries directly to files or pipes (via the
31723 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31724 specified by setting &%system_filter_file_transport%& and
31725 &%system_filter_pipe_transport%&, respectively. Similarly,
31726 &%system_filter_reply_transport%& must be set to handle any messages generated
31727 by the &%reply%& command.
31728
31729
31730 .section "Testing a system filter" "SECID213"
31731 You can run simple tests of a system filter in the same way as for a user
31732 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31733 are permitted only in system filters are recognized.
31734
31735 If you want to test the combined effect of a system filter and a user filter,
31736 you can use both &%-bF%& and &%-bf%& on the same command line.
31737
31738
31739
31740 .section "Contents of a system filter" "SECID214"
31741 The language used to specify system filters is the same as for users' filter
31742 files. It is described in the separate end-user document &'Exim's interface to
31743 mail filtering'&. However, there are some additional features that are
31744 available only in system filters; these are described in subsequent sections.
31745 If they are encountered in a user's filter file or when testing with &%-bf%&,
31746 they cause errors.
31747
31748 .cindex "frozen messages" "manual thaw; testing in filter"
31749 There are two special conditions which, though available in users' filter
31750 files, are designed for use in system filters. The condition &%first_delivery%&
31751 is true only for the first attempt at delivering a message, and
31752 &%manually_thawed%& is true only if the message has been frozen, and
31753 subsequently thawed by an admin user. An explicit forced delivery counts as a
31754 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31755
31756 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31757 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31758 succeed, it will not be tried again.
31759 If you want Exim to retry an unseen delivery until it succeeds, you should
31760 arrange to set it up every time the filter runs.
31761
31762 When a system filter finishes running, the values of the variables &$n0$& &--
31763 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31764 users' filter files. Thus a system filter can, for example, set up &"scores"&
31765 to which users' filter files can refer.
31766
31767
31768
31769 .section "Additional variable for system filters" "SECID215"
31770 .vindex "&$recipients$&"
31771 The expansion variable &$recipients$&, containing a list of all the recipients
31772 of the message (separated by commas and white space), is available in system
31773 filters. It is not available in users' filters for privacy reasons.
31774
31775
31776
31777 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31778 .cindex "freezing messages"
31779 .cindex "message" "freezing"
31780 .cindex "message" "forced failure"
31781 .cindex "&%fail%&" "in system filter"
31782 .cindex "&%freeze%& in system filter"
31783 .cindex "&%defer%& in system filter"
31784 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31785 always available in system filters, but are not normally enabled in users'
31786 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31787 for the &(redirect)& router.) These commands can optionally be followed by the
31788 word &%text%& and a string containing an error message, for example:
31789 .code
31790 fail text "this message looks like spam to me"
31791 .endd
31792 The keyword &%text%& is optional if the next character is a double quote.
31793
31794 The &%defer%& command defers delivery of the original recipients of the
31795 message. The &%fail%& command causes all the original recipients to be failed,
31796 and a bounce message to be created. The &%freeze%& command suspends all
31797 delivery attempts for the original recipients. In all cases, any new deliveries
31798 that are specified by the filter are attempted as normal after the filter has
31799 run.
31800
31801 The &%freeze%& command is ignored if the message has been manually unfrozen and
31802 not manually frozen since. This means that automatic freezing by a system
31803 filter can be used as a way of checking out suspicious messages. If a message
31804 is found to be all right, manually unfreezing it allows it to be delivered.
31805
31806 .cindex "log" "&%fail%& command log line"
31807 .cindex "&%fail%&" "log line; reducing"
31808 The text given with a fail command is used as part of the bounce message as
31809 well as being written to the log. If the message is quite long, this can fill
31810 up a lot of log space when such failures are common. To reduce the size of the
31811 log message, Exim interprets the text in a special way if it starts with the
31812 two characters &`<<`& and contains &`>>`& later. The text between these two
31813 strings is written to the log, and the rest of the text is used in the bounce
31814 message. For example:
31815 .code
31816 fail "<<filter test 1>>Your message is rejected \
31817      because it contains attachments that we are \
31818      not prepared to receive."
31819 .endd
31820
31821 .cindex "loop" "caused by &%fail%&"
31822 Take great care with the &%fail%& command when basing the decision to fail on
31823 the contents of the message, because the bounce message will of course include
31824 the contents of the original message and will therefore trigger the &%fail%&
31825 command again (causing a mail loop) unless steps are taken to prevent this.
31826 Testing the &%error_message%& condition is one way to prevent this. You could
31827 use, for example
31828 .code
31829 if $message_body contains "this is spam" and not error_message
31830 then fail text "spam is not wanted here" endif
31831 .endd
31832 though of course that might let through unwanted bounce messages. The
31833 alternative is clever checking of the body and/or headers to detect bounces
31834 generated by the filter.
31835
31836 The interpretation of a system filter file ceases after a
31837 &%defer%&,
31838 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31839 set up earlier in the filter file are honoured, so you can use a sequence such
31840 as
31841 .code
31842 mail ...
31843 freeze
31844 .endd
31845 to send a specified message when the system filter is freezing (or deferring or
31846 failing) a message. The normal deliveries for the message do not, of course,
31847 take place.
31848
31849
31850
31851 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31852 .cindex "header lines" "adding; in system filter"
31853 .cindex "header lines" "removing; in system filter"
31854 .cindex "filter" "header lines; adding/removing"
31855 Two filter commands that are available only in system filters are:
31856 .code
31857 headers add <string>
31858 headers remove <string>
31859 .endd
31860 The argument for the &%headers add%& is a string that is expanded and then
31861 added to the end of the message's headers. It is the responsibility of the
31862 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31863 space is ignored, and if the string is otherwise empty, or if the expansion is
31864 forced to fail, the command has no effect.
31865
31866 You can use &"\n"& within the string, followed by white space, to specify
31867 continued header lines. More than one header may be added in one command by
31868 including &"\n"& within the string without any following white space. For
31869 example:
31870 .code
31871 headers add "X-header-1: ....\n  \
31872              continuation of X-header-1 ...\n\
31873              X-header-2: ...."
31874 .endd
31875 Note that the header line continuation white space after the first newline must
31876 be placed before the backslash that continues the input string, because white
31877 space after input continuations is ignored.
31878
31879 The argument for &%headers remove%& is a colon-separated list of header names.
31880 This command applies only to those headers that are stored with the message;
31881 those that are added at delivery time (such as &'Envelope-To:'& and
31882 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31883 header with the same name, they are all removed.
31884
31885 The &%headers%& command in a system filter makes an immediate change to the set
31886 of header lines that was received with the message (with possible additions
31887 from ACL processing). Subsequent commands in the system filter operate on the
31888 modified set, which also forms the basis for subsequent message delivery.
31889 Unless further modified during routing or transporting, this set of headers is
31890 used for all recipients of the message.
31891
31892 During routing and transporting, the variables that refer to the contents of
31893 header lines refer only to those lines that are in this set. Thus, header lines
31894 that are added by a system filter are visible to users' filter files and to all
31895 routers and transports. This contrasts with the manipulation of header lines by
31896 routers and transports, which is not immediate, but which instead is saved up
31897 until the message is actually being written (see section
31898 &<<SECTheadersaddrem>>&).
31899
31900 If the message is not delivered at the first attempt, header lines that were
31901 added by the system filter are stored with the message, and so are still
31902 present at the next delivery attempt. Header lines that were removed are still
31903 present, but marked &"deleted"& so that they are not transported with the
31904 message. For this reason, it is usual to make the &%headers%& command
31905 conditional on &%first_delivery%& so that the set of header lines is not
31906 modified more than once.
31907
31908 Because header modification in a system filter acts immediately, you have to
31909 use an indirect approach if you want to modify the contents of a header line.
31910 For example:
31911 .code
31912 headers add "Old-Subject: $h_subject:"
31913 headers remove "Subject"
31914 headers add "Subject: new subject (was: $h_old-subject:)"
31915 headers remove "Old-Subject"
31916 .endd
31917
31918
31919
31920 .section "Setting an errors address in a system filter" "SECID217"
31921 .cindex "envelope sender"
31922 In a system filter, if a &%deliver%& command is followed by
31923 .code
31924 errors_to <some address>
31925 .endd
31926 in order to change the envelope sender (and hence the error reporting) for that
31927 delivery, any address may be specified. (In a user filter, only the current
31928 user's address can be set.) For example, if some mail is being monitored, you
31929 might use
31930 .code
31931 unseen deliver monitor@spying.example errors_to root@local.example
31932 .endd
31933 to take a copy which would not be sent back to the normal error reporting
31934 address if its delivery failed.
31935
31936
31937
31938 .section "Per-address filtering" "SECTperaddfil"
31939 .vindex "&$domain$&"
31940 .vindex "&$local_part$&"
31941 In contrast to the system filter, which is run just once per message for each
31942 delivery attempt, it is also possible to set up a system-wide filtering
31943 operation that runs once for each recipient address. In this case, variables
31944 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31945 filter file could be made dependent on them. This is an example of a router
31946 which implements such a filter:
31947 .code
31948 central_filter:
31949   check_local_user
31950   driver = redirect
31951   domains = +local_domains
31952   file = /central/filters/$local_part
31953   no_verify
31954   allow_filter
31955   allow_freeze
31956 .endd
31957 The filter is run in a separate process under its own uid. Therefore, either
31958 &%check_local_user%& must be set (as above), in which case the filter is run as
31959 the local user, or the &%user%& option must be used to specify which user to
31960 use. If both are set, &%user%& overrides.
31961
31962 Care should be taken to ensure that none of the commands in the filter file
31963 specify a significant delivery if the message is to go on to be delivered to
31964 its intended recipient. The router will not then claim to have dealt with the
31965 address, so it will be passed on to subsequent routers to be delivered in the
31966 normal way.
31967 .ecindex IIDsysfil1
31968 .ecindex IIDsysfil2
31969 .ecindex IIDsysfil3
31970
31971
31972
31973
31974
31975
31976 . ////////////////////////////////////////////////////////////////////////////
31977 . ////////////////////////////////////////////////////////////////////////////
31978
31979 .chapter "Message processing" "CHAPmsgproc"
31980 .scindex IIDmesproc "message" "general processing"
31981 Exim performs various transformations on the sender and recipient addresses of
31982 all messages that it handles, and also on the messages' header lines. Some of
31983 these are optional and configurable, while others always take place. All of
31984 this processing, except rewriting as a result of routing, and the addition or
31985 removal of header lines while delivering, happens when a message is received,
31986 before it is placed on Exim's queue.
31987
31988 Some of the automatic processing takes place by default only for
31989 &"locally-originated"& messages. This adjective is used to describe messages
31990 that are not received over TCP/IP, but instead are passed to an Exim process on
31991 its standard input. This includes the interactive &"local SMTP"& case that is
31992 set up by the &%-bs%& command line option.
31993
31994 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31995 or ::1) are not considered to be locally-originated. Exim does not treat the
31996 loopback interface specially in any way.
31997
31998 If you want the loopback interface to be treated specially, you must ensure
31999 that there are appropriate entries in your ACLs.
32000
32001
32002
32003
32004 .section "Submission mode for non-local messages" "SECTsubmodnon"
32005 .cindex "message" "submission"
32006 .cindex "submission mode"
32007 Processing that happens automatically for locally-originated messages (unless
32008 &%suppress_local_fixups%& is set) can also be requested for messages that are
32009 received over TCP/IP. The term &"submission mode"& is used to describe this
32010 state. Submission mode is set by the modifier
32011 .code
32012 control = submission
32013 .endd
32014 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32015 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32016 a local submission, and is normally used when the source of the message is
32017 known to be an MUA running on a client host (as opposed to an MTA). For
32018 example, to set submission mode for messages originating on the IPv4 loopback
32019 interface, you could include the following in the MAIL ACL:
32020 .code
32021 warn  hosts = 127.0.0.1
32022       control = submission
32023 .endd
32024 .cindex "&%sender_retain%& submission option"
32025 There are some options that can be used when setting submission mode. A slash
32026 is used to separate options. For example:
32027 .code
32028 control = submission/sender_retain
32029 .endd
32030 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32031 true and &%local_from_check%& false for the current incoming message. The first
32032 of these allows an existing &'Sender:'& header in the message to remain, and
32033 the second suppresses the check to ensure that &'From:'& matches the
32034 authenticated sender. With this setting, Exim still fixes up messages by adding
32035 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32036 attempt to check sender authenticity in header lines.
32037
32038 When &%sender_retain%& is not set, a submission mode setting may specify a
32039 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32040 example:
32041 .code
32042 control = submission/domain=some.domain
32043 .endd
32044 The domain may be empty. How this value is used is described in sections
32045 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32046 that allows you to specify the user's full name for inclusion in a created
32047 &'Sender:'& or &'From:'& header line. For example:
32048 .code
32049 accept authenticated = *
32050        control = submission/domain=wonderland.example/\
32051                             name=${lookup {$authenticated_id} \
32052                                    lsearch {/etc/exim/namelist}}
32053 .endd
32054 Because the name may contain any characters, including slashes, the &%name%&
32055 option must be given last. The remainder of the string is used as the name. For
32056 the example above, if &_/etc/exim/namelist_& contains:
32057 .code
32058 bigegg:  Humpty Dumpty
32059 .endd
32060 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32061 line would be:
32062 .code
32063 Sender: Humpty Dumpty <bigegg@wonderland.example>
32064 .endd
32065 .cindex "return path" "in submission mode"
32066 By default, submission mode forces the return path to the same address as is
32067 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32068 specified, the return path is also left unchanged.
32069
32070 &*Note*&: The changes caused by submission mode take effect after the predata
32071 ACL. This means that any sender checks performed before the fix-ups use the
32072 untrusted sender address specified by the user, not the trusted sender address
32073 specified by submission mode. Although this might be slightly unexpected, it
32074 does mean that you can configure ACL checks to spot that a user is trying to
32075 spoof another's address.
32076
32077 .section "Line endings" "SECTlineendings"
32078 .cindex "line endings"
32079 .cindex "carriage return"
32080 .cindex "linefeed"
32081 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32082 linefeed) is the line ending for messages transmitted over the Internet using
32083 SMTP over TCP/IP. However, within individual operating systems, different
32084 conventions are used. For example, Unix-like systems use just LF, but others
32085 use CRLF or just CR.
32086
32087 Exim was designed for Unix-like systems, and internally, it stores messages
32088 using the system's convention of a single LF as a line terminator. When
32089 receiving a message, all line endings are translated to this standard format.
32090 Originally, it was thought that programs that passed messages directly to an
32091 MTA within an operating system would use that system's convention. Experience
32092 has shown that this is not the case; for example, there are Unix applications
32093 that use CRLF in this circumstance. For this reason, and for compatibility with
32094 other MTAs, the way Exim handles line endings for all messages is now as
32095 follows:
32096
32097 .ilist
32098 LF not preceded by CR is treated as a line ending.
32099 .next
32100 CR is treated as a line ending; if it is immediately followed by LF, the LF
32101 is ignored.
32102 .next
32103 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32104 nor a local message in the state where a line containing only a dot is a
32105 terminator.
32106 .next
32107 If a bare CR is encountered within a header line, an extra space is added after
32108 the line terminator so as not to end the header line. The reasoning behind this
32109 is that bare CRs in header lines are most likely either to be mistakes, or
32110 people trying to play silly games.
32111 .next
32112 If the first header line received in a message ends with CRLF, a subsequent
32113 bare LF in a header line is treated in the same way as a bare CR in a header
32114 line.
32115 .endlist
32116
32117
32118
32119
32120
32121 .section "Unqualified addresses" "SECID218"
32122 .cindex "unqualified addresses"
32123 .cindex "address" "qualification"
32124 By default, Exim expects every envelope address it receives from an external
32125 host to be fully qualified. Unqualified addresses cause negative responses to
32126 SMTP commands. However, because SMTP is used as a means of transporting
32127 messages from MUAs running on personal workstations, there is sometimes a
32128 requirement to accept unqualified addresses from specific hosts or IP networks.
32129
32130 Exim has two options that separately control which hosts may send unqualified
32131 sender or recipient addresses in SMTP commands, namely
32132 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32133 cases, if an unqualified address is accepted, it is qualified by adding the
32134 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32135
32136 .oindex "&%qualify_domain%&"
32137 .oindex "&%qualify_recipient%&"
32138 Unqualified addresses in header lines are automatically qualified for messages
32139 that are locally originated, unless the &%-bnq%& option is given on the command
32140 line. For messages received over SMTP, unqualified addresses in header lines
32141 are qualified only if unqualified addresses are permitted in SMTP commands. In
32142 other words, such qualification is also controlled by
32143 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32144
32145
32146
32147
32148 .section "The UUCP From line" "SECID219"
32149 .cindex "&""From""& line"
32150 .cindex "UUCP" "&""From""& line"
32151 .cindex "sender" "address"
32152 .oindex "&%uucp_from_pattern%&"
32153 .oindex "&%uucp_from_sender%&"
32154 .cindex "envelope sender"
32155 .cindex "Sendmail compatibility" "&""From""& line"
32156 Messages that have come from UUCP (and some other applications) often begin
32157 with a line containing the envelope sender and a timestamp, following the word
32158 &"From"&. Examples of two common formats are:
32159 .code
32160 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32161 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32162 .endd
32163 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32164 Exim recognizes such lines at the start of messages that are submitted to it
32165 via the command line (that is, on the standard input). It does not recognize
32166 such lines in incoming SMTP messages, unless the sending host matches
32167 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32168 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32169 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32170 default value matches the two common cases shown above and puts the address
32171 that follows &"From"& into &$1$&.
32172
32173 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32174 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32175 a trusted user, the message's sender address is constructed by expanding the
32176 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32177 then parsed as an RFC 2822 address. If there is no domain, the local part is
32178 qualified with &%qualify_domain%& unless it is the empty string. However, if
32179 the command line &%-f%& option is used, it overrides the &"From"& line.
32180
32181 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32182 sender address is not changed. This is also the case for incoming SMTP messages
32183 that are permitted to contain &"From"& lines.
32184
32185 Only one &"From"& line is recognized. If there is more than one, the second is
32186 treated as a data line that starts the body of the message, as it is not valid
32187 as a header line. This also happens if a &"From"& line is present in an
32188 incoming SMTP message from a source that is not permitted to send them.
32189
32190
32191
32192 .section "Resent- header lines" "SECID220"
32193 .cindex "&%Resent-%& header lines"
32194 RFC 2822 makes provision for sets of header lines starting with the string
32195 &`Resent-`& to be added to a message when it is resent by the original
32196 recipient to somebody else. These headers are &'Resent-Date:'&,
32197 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32198 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32199
32200 .blockquote
32201 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32202 processing of replies or other such automatic actions on messages.'&
32203 .endblockquote
32204
32205 This leaves things a bit vague as far as other processing actions such as
32206 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32207 follows:
32208
32209 .ilist
32210 A &'Resent-From:'& line that just contains the login id of the submitting user
32211 is automatically rewritten in the same way as &'From:'& (see below).
32212 .next
32213 If there's a rewriting rule for a particular header line, it is also applied to
32214 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32215 &'From:'& also rewrites &'Resent-From:'&.
32216 .next
32217 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32218 also removed.
32219 .next
32220 For a locally-submitted message,
32221 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32222 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32223 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32224 included in log lines in this case.
32225 .next
32226 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32227 &%Resent-%& header lines are present.
32228 .endlist
32229
32230
32231
32232
32233 .section "The Auto-Submitted: header line" "SECID221"
32234 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32235 includes the header line:
32236 .code
32237 Auto-Submitted: auto-replied
32238 .endd
32239
32240 .section "The Bcc: header line" "SECID222"
32241 .cindex "&'Bcc:'& header line"
32242 If Exim is called with the &%-t%& option, to take recipient addresses from a
32243 message's header, it removes any &'Bcc:'& header line that may exist (after
32244 extracting its addresses). If &%-t%& is not present on the command line, any
32245 existing &'Bcc:'& is not removed.
32246
32247
32248 .section "The Date: header line" "SECID223"
32249 .cindex "&'Date:'& header line"
32250 If a locally-generated or submission-mode message has no &'Date:'& header line,
32251 Exim adds one, using the current date and time, unless the
32252 &%suppress_local_fixups%& control has been specified.
32253
32254 .section "The Delivery-date: header line" "SECID224"
32255 .cindex "&'Delivery-date:'& header line"
32256 .oindex "&%delivery_date_remove%&"
32257 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32258 set. Exim can be configured to add them to the final delivery of messages. (See
32259 the generic &%delivery_date_add%& transport option.) They should not be present
32260 in messages in transit. If the &%delivery_date_remove%& configuration option is
32261 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32262 messages.
32263
32264
32265 .section "The Envelope-to: header line" "SECID225"
32266 .cindex "&'Envelope-to:'& header line"
32267 .oindex "&%envelope_to_remove%&"
32268 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32269 Exim can be configured to add them to the final delivery of messages. (See the
32270 generic &%envelope_to_add%& transport option.) They should not be present in
32271 messages in transit. If the &%envelope_to_remove%& configuration option is set
32272 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32273 messages.
32274
32275
32276 .section "The From: header line" "SECTthefrohea"
32277 .cindex "&'From:'& header line"
32278 .cindex "Sendmail compatibility" "&""From""& line"
32279 .cindex "message" "submission"
32280 .cindex "submission mode"
32281 If a submission-mode message does not contain a &'From:'& header line, Exim
32282 adds one if either of the following conditions is true:
32283
32284 .ilist
32285 The envelope sender address is not empty (that is, this is not a bounce
32286 message). The added header line copies the envelope sender address.
32287 .next
32288 .vindex "&$authenticated_id$&"
32289 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32290 .olist
32291 .vindex "&$qualify_domain$&"
32292 If no domain is specified by the submission control, the local part is
32293 &$authenticated_id$& and the domain is &$qualify_domain$&.
32294 .next
32295 If a non-empty domain is specified by the submission control, the local
32296 part is &$authenticated_id$&, and the domain is the specified domain.
32297 .next
32298 If an empty domain is specified by the submission control,
32299 &$authenticated_id$& is assumed to be the complete address.
32300 .endlist
32301 .endlist
32302
32303 A non-empty envelope sender takes precedence.
32304
32305 If a locally-generated incoming message does not contain a &'From:'& header
32306 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32307 containing the sender's address. The calling user's login name and full name
32308 are used to construct the address, as described in section &<<SECTconstr>>&.
32309 They are obtained from the password data by calling &[getpwuid()]& (but see the
32310 &%unknown_login%& configuration option). The address is qualified with
32311 &%qualify_domain%&.
32312
32313 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32314 &'From:'& header line containing just the unqualified login name of the calling
32315 user, this is replaced by an address containing the user's login name and full
32316 name as described in section &<<SECTconstr>>&.
32317
32318
32319 .section "The Message-ID: header line" "SECID226"
32320 .cindex "&'Message-ID:'& header line"
32321 .cindex "message" "submission"
32322 .oindex "&%message_id_header_text%&"
32323 If a locally-generated or submission-mode incoming message does not contain a
32324 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32325 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32326 to the message. If there are any &'Resent-:'& headers in the message, it
32327 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32328 message id, preceded by the letter E to ensure it starts with a letter, and
32329 followed by @ and the primary host name. Additional information can be included
32330 in this header line by setting the &%message_id_header_text%& and/or
32331 &%message_id_header_domain%& options.
32332
32333
32334 .section "The Received: header line" "SECID227"
32335 .cindex "&'Received:'& header line"
32336 A &'Received:'& header line is added at the start of every message. The
32337 contents are defined by the &%received_header_text%& configuration option, and
32338 Exim automatically adds a semicolon and a timestamp to the configured string.
32339
32340 The &'Received:'& header is generated as soon as the message's header lines
32341 have been received. At this stage, the timestamp in the &'Received:'& header
32342 line is the time that the message started to be received. This is the value
32343 that is seen by the DATA ACL and by the &[local_scan()]& function.
32344
32345 Once a message is accepted, the timestamp in the &'Received:'& header line is
32346 changed to the time of acceptance, which is (apart from a small delay while the
32347 -H spool file is written) the earliest time at which delivery could start.
32348
32349
32350 .section "The References: header line" "SECID228"
32351 .cindex "&'References:'& header line"
32352 Messages created by the &(autoreply)& transport include a &'References:'&
32353 header line. This is constructed according to the rules that are described in
32354 section 3.64 of RFC 2822 (which states that replies should contain such a
32355 header line), and section 3.14 of RFC 3834 (which states that automatic
32356 responses are not different in this respect). However, because some mail
32357 processing software does not cope well with very long header lines, no more
32358 than 12 message IDs are copied from the &'References:'& header line in the
32359 incoming message. If there are more than 12, the first one and then the final
32360 11 are copied, before adding the message ID of the incoming message.
32361
32362
32363
32364 .section "The Return-path: header line" "SECID229"
32365 .cindex "&'Return-path:'& header line"
32366 .oindex "&%return_path_remove%&"
32367 &'Return-path:'& header lines are defined as something an MTA may insert when
32368 it does the final delivery of messages. (See the generic &%return_path_add%&
32369 transport option.) Therefore, they should not be present in messages in
32370 transit. If the &%return_path_remove%& configuration option is set (the
32371 default), Exim removes &'Return-path:'& header lines from incoming messages.
32372
32373
32374
32375 .section "The Sender: header line" "SECTthesenhea"
32376 .cindex "&'Sender:'& header line"
32377 .cindex "message" "submission"
32378 For a locally-originated message from an untrusted user, Exim may remove an
32379 existing &'Sender:'& header line, and it may add a new one. You can modify
32380 these actions by setting the &%local_sender_retain%& option true, the
32381 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32382 control setting.
32383
32384 When a local message is received from an untrusted user and
32385 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32386 control has not been set, a check is made to see if the address given in the
32387 &'From:'& header line is the correct (local) sender of the message. The address
32388 that is expected has the login name as the local part and the value of
32389 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32390 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32391 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32392 line is added to the message.
32393
32394 If you set &%local_from_check%& false, this checking does not occur. However,
32395 the removal of an existing &'Sender:'& line still happens, unless you also set
32396 &%local_sender_retain%& to be true. It is not possible to set both of these
32397 options true at the same time.
32398
32399 .cindex "submission mode"
32400 By default, no processing of &'Sender:'& header lines is done for messages
32401 received over TCP/IP or for messages submitted by trusted users. However, when
32402 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32403 not specified on the submission control, the following processing takes place:
32404
32405 .vindex "&$authenticated_id$&"
32406 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32407 authenticated, and &$authenticated_id$& is not empty, a sender address is
32408 created as follows:
32409
32410 .ilist
32411 .vindex "&$qualify_domain$&"
32412 If no domain is specified by the submission control, the local part is
32413 &$authenticated_id$& and the domain is &$qualify_domain$&.
32414 .next
32415 If a non-empty domain is specified by the submission control, the local part
32416 is &$authenticated_id$&, and the domain is the specified domain.
32417 .next
32418 If an empty domain is specified by the submission control,
32419 &$authenticated_id$& is assumed to be the complete address.
32420 .endlist
32421
32422 This address is compared with the address in the &'From:'& header line. If they
32423 are different, a &'Sender:'& header line containing the created address is
32424 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32425 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32426
32427 .cindex "return path" "created from &'Sender:'&"
32428 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32429 the message (the envelope sender address) is changed to be the same address,
32430 except in the case of submission mode when &%sender_retain%& is specified.
32431
32432
32433
32434 .section "Adding and removing header lines in routers and transports" &&&
32435          "SECTheadersaddrem"
32436 .cindex "header lines" "adding; in router or transport"
32437 .cindex "header lines" "removing; in router or transport"
32438 When a message is delivered, the addition and removal of header lines can be
32439 specified in a system filter, or on any of the routers and transports that
32440 process the message. Section &<<SECTaddremheasys>>& contains details about
32441 modifying headers in a system filter. Header lines can also be added in an ACL
32442 as a message is received (see section &<<SECTaddheadacl>>&).
32443
32444 In contrast to what happens in a system filter, header modifications that are
32445 specified on routers and transports apply only to the particular recipient
32446 addresses that are being processed by those routers and transports. These
32447 changes do not actually take place until a copy of the message is being
32448 transported. Therefore, they do not affect the basic set of header lines, and
32449 they do not affect the values of the variables that refer to header lines.
32450
32451 &*Note*&: In particular, this means that any expansions in the configuration of
32452 the transport cannot refer to the modified header lines, because such
32453 expansions all occur before the message is actually transported.
32454
32455 For both routers and transports, the argument of a &%headers_add%&
32456 option must be in the form of one or more RFC 2822 header lines, separated by
32457 newlines (coded as &"\n"&). For example:
32458 .code
32459 headers_add = X-added-header: added by $primary_hostname\n\
32460               X-added-second: another added header line
32461 .endd
32462 Exim does not check the syntax of these added header lines.
32463
32464 Multiple &%headers_add%& options for a single router or transport can be
32465 specified; the values will append to a single list of header lines.
32466 Each header-line is separately expanded.
32467
32468 The argument of a &%headers_remove%& option must consist of a colon-separated
32469 list of header names. This is confusing, because header names themselves are
32470 often terminated by colons. In this case, the colons are the list separators,
32471 not part of the names. For example:
32472 .code
32473 headers_remove = return-receipt-to:acknowledge-to
32474 .endd
32475
32476 Multiple &%headers_remove%& options for a single router or transport can be
32477 specified; the arguments will append to a single header-names list.
32478 Each item is separately expanded.
32479
32480 When &%headers_add%& or &%headers_remove%& is specified on a router,
32481 items are expanded at routing time,
32482 and then associated with all addresses that are
32483 accepted by that router, and also with any new addresses that it generates. If
32484 an address passes through several routers as a result of aliasing or
32485 forwarding, the changes are cumulative.
32486
32487 .oindex "&%unseen%&"
32488 However, this does not apply to multiple routers that result from the use of
32489 the &%unseen%& option. Any header modifications that were specified by the
32490 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32491
32492 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32493 settings cannot be delivered together in a batch, so a transport is always
32494 dealing with a set of addresses that have the same header-processing
32495 requirements.
32496
32497 The transport starts by writing the original set of header lines that arrived
32498 with the message, possibly modified by the system filter. As it writes out
32499 these lines, it consults the list of header names that were attached to the
32500 recipient address(es) by &%headers_remove%& options in routers, and it also
32501 consults the transport's own &%headers_remove%& option. Header lines whose
32502 names are on either of these lists are not written out. If there are multiple
32503 instances of any listed header, they are all skipped.
32504
32505 After the remaining original header lines have been written, new header
32506 lines that were specified by routers' &%headers_add%& options are written, in
32507 the order in which they were attached to the address. These are followed by any
32508 header lines specified by the transport's &%headers_add%& option.
32509
32510 This way of handling header line modifications in routers and transports has
32511 the following consequences:
32512
32513 .ilist
32514 The original set of header lines, possibly modified by the system filter,
32515 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32516 to it, at all times.
32517 .next
32518 Header lines that are added by a router's
32519 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32520 expansion syntax in subsequent routers or the transport.
32521 .next
32522 Conversely, header lines that are specified for removal by &%headers_remove%&
32523 in a router remain visible to subsequent routers and the transport.
32524 .next
32525 Headers added to an address by &%headers_add%& in a router cannot be removed by
32526 a later router or by a transport.
32527 .next
32528 An added header can refer to the contents of an original header that is to be
32529 removed, even it has the same name as the added header. For example:
32530 .code
32531 headers_remove = subject
32532 headers_add = Subject: new subject (was: $h_subject:)
32533 .endd
32534 .endlist
32535
32536 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32537 for a &(redirect)& router that has the &%one_time%& option set.
32538
32539
32540
32541
32542
32543 .section "Constructed addresses" "SECTconstr"
32544 .cindex "address" "constructed"
32545 .cindex "constructed address"
32546 When Exim constructs a sender address for a locally-generated message, it uses
32547 the form
32548 .display
32549 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32550 .endd
32551 For example:
32552 .code
32553 Zaphod Beeblebrox <zaphod@end.univ.example>
32554 .endd
32555 The user name is obtained from the &%-F%& command line option if set, or
32556 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32557 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32558 ampersand character, this is replaced by the login name with the first letter
32559 upper cased, as is conventional in a number of operating systems. See the
32560 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32561 The &%unknown_username%& option can be used to specify user names in cases when
32562 there is no password file entry.
32563
32564 .cindex "RFC 2047"
32565 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32566 parts of it if necessary. In addition, if it contains any non-printing
32567 characters, it is encoded as described in RFC 2047, which defines a way of
32568 including non-ASCII characters in header lines. The value of the
32569 &%headers_charset%& option specifies the name of the encoding that is used (the
32570 characters are assumed to be in this encoding). The setting of
32571 &%print_topbitchars%& controls whether characters with the top bit set (that
32572 is, with codes greater than 127) count as printing characters or not.
32573
32574
32575
32576 .section "Case of local parts" "SECID230"
32577 .cindex "case of local parts"
32578 .cindex "local part" "case of"
32579 RFC 2822 states that the case of letters in the local parts of addresses cannot
32580 be assumed to be non-significant. Exim preserves the case of local parts of
32581 addresses, but by default it uses a lower-cased form when it is routing,
32582 because on most Unix systems, usernames are in lower case and case-insensitive
32583 routing is required. However, any particular router can be made to use the
32584 original case for local parts by setting the &%caseful_local_part%& generic
32585 router option.
32586
32587 .cindex "mixed-case login names"
32588 If you must have mixed-case user names on your system, the best way to proceed,
32589 assuming you want case-independent handling of incoming email, is to set up
32590 your first router to convert incoming local parts in your domains to the
32591 correct case by means of a file lookup. For example:
32592 .code
32593 correct_case:
32594   driver = redirect
32595   domains = +local_domains
32596   data = ${lookup{$local_part}cdb\
32597               {/etc/usercased.cdb}{$value}fail}\
32598               @$domain
32599 .endd
32600 For this router, the local part is forced to lower case by the default action
32601 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32602 up a new local part in the correct case. If you then set &%caseful_local_part%&
32603 on any subsequent routers which process your domains, they will operate on
32604 local parts with the correct case in a case-sensitive manner.
32605
32606
32607
32608 .section "Dots in local parts" "SECID231"
32609 .cindex "dot" "in local part"
32610 .cindex "local part" "dots in"
32611 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32612 part may not begin or end with a dot, nor have two consecutive dots in the
32613 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32614 empty components for compatibility.
32615
32616
32617
32618 .section "Rewriting addresses" "SECID232"
32619 .cindex "rewriting" "addresses"
32620 Rewriting of sender and recipient addresses, and addresses in headers, can
32621 happen automatically, or as the result of configuration options, as described
32622 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32623 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32624
32625 Automatic rewriting includes qualification, as mentioned above. The other case
32626 in which it can happen is when an incomplete non-local domain is given. The
32627 routing process may cause this to be expanded into the full domain name. For
32628 example, a header such as
32629 .code
32630 To: hare@teaparty
32631 .endd
32632 might get rewritten as
32633 .code
32634 To: hare@teaparty.wonderland.fict.example
32635 .endd
32636 Rewriting as a result of routing is the one kind of message processing that
32637 does not happen at input time, as it cannot be done until the address has
32638 been routed.
32639
32640 Strictly, one should not do &'any'& deliveries of a message until all its
32641 addresses have been routed, in case any of the headers get changed as a
32642 result of routing. However, doing this in practice would hold up many
32643 deliveries for unreasonable amounts of time, just because one address could not
32644 immediately be routed. Exim therefore does not delay other deliveries when
32645 routing of one or more addresses is deferred.
32646 .ecindex IIDmesproc
32647
32648
32649
32650 . ////////////////////////////////////////////////////////////////////////////
32651 . ////////////////////////////////////////////////////////////////////////////
32652
32653 .chapter "SMTP processing" "CHAPSMTP"
32654 .scindex IIDsmtpproc1 "SMTP" "processing details"
32655 .scindex IIDsmtpproc2 "LMTP" "processing details"
32656 Exim supports a number of different ways of using the SMTP protocol, and its
32657 LMTP variant, which is an interactive protocol for transferring messages into a
32658 closed mail store application. This chapter contains details of how SMTP is
32659 processed. For incoming mail, the following are available:
32660
32661 .ilist
32662 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32663 .next
32664 SMTP over the standard input and output (the &%-bs%& option);
32665 .next
32666 Batched SMTP on the standard input (the &%-bS%& option).
32667 .endlist
32668
32669 For mail delivery, the following are available:
32670
32671 .ilist
32672 SMTP over TCP/IP (the &(smtp)& transport);
32673 .next
32674 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32675 &"lmtp"&);
32676 .next
32677 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32678 transport);
32679 .next
32680 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32681 the &%use_bsmtp%& option set).
32682 .endlist
32683
32684 &'Batched SMTP'& is the name for a process in which batches of messages are
32685 stored in or read from files (or pipes), in a format in which SMTP commands are
32686 used to contain the envelope information.
32687
32688
32689
32690 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32691 .cindex "SMTP" "outgoing over TCP/IP"
32692 .cindex "outgoing SMTP over TCP/IP"
32693 .cindex "LMTP" "over TCP/IP"
32694 .cindex "outgoing LMTP over TCP/IP"
32695 .cindex "EHLO"
32696 .cindex "HELO"
32697 .cindex "SIZE option on MAIL command"
32698 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32699 The &%protocol%& option selects which protocol is to be used, but the actual
32700 processing is the same in both cases.
32701
32702 If, in response to its EHLO command, Exim is told that the SIZE
32703 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32704 command. The value of <&'n'&> is the message size plus the value of the
32705 &%size_addition%& option (default 1024) to allow for additions to the message
32706 such as per-transport header lines, or changes made in a
32707 .cindex "transport" "filter"
32708 .cindex "filter" "transport filter"
32709 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32710 suppressed.
32711
32712 If the remote server advertises support for PIPELINING, Exim uses the
32713 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32714 required for the transaction.
32715
32716 If the remote server advertises support for the STARTTLS command, and Exim
32717 was built to support TLS encryption, it tries to start a TLS session unless the
32718 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32719 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32720 is called for verification.
32721
32722 If the remote server advertises support for the AUTH command, Exim scans
32723 the authenticators configuration for any suitable client settings, as described
32724 in chapter &<<CHAPSMTPAUTH>>&.
32725
32726 .cindex "carriage return"
32727 .cindex "linefeed"
32728 Responses from the remote host are supposed to be terminated by CR followed by
32729 LF. However, there are known to be hosts that do not send CR characters, so in
32730 order to be able to interwork with such hosts, Exim treats LF on its own as a
32731 line terminator.
32732
32733 If a message contains a number of different addresses, all those with the same
32734 characteristics (for example, the same envelope sender) that resolve to the
32735 same set of hosts, in the same order, are sent in a single SMTP transaction,
32736 even if they are for different domains, unless there are more than the setting
32737 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32738 they are split into groups containing no more than &%max_rcpt%&s addresses
32739 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32740 in parallel sessions. The order of hosts with identical MX values is not
32741 significant when checking whether addresses can be batched in this way.
32742
32743 When the &(smtp)& transport suffers a temporary failure that is not
32744 message-related, Exim updates its transport-specific database, which contains
32745 records indexed by host name that remember which messages are waiting for each
32746 particular host. It also updates the retry database with new retry times.
32747
32748 .cindex "hints database" "retry keys"
32749 Exim's retry hints are based on host name plus IP address, so if one address of
32750 a multi-homed host is broken, it will soon be skipped most of the time.
32751 See the next section for more detail about error handling.
32752
32753 .cindex "SMTP" "passed connection"
32754 .cindex "SMTP" "batching over TCP/IP"
32755 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32756 looks in the hints database for the transport to see if there are any queued
32757 messages waiting for the host to which it is connected. If it finds one, it
32758 creates a new Exim process using the &%-MC%& option (which can only be used by
32759 a process running as root or the Exim user) and passes the TCP/IP socket to it
32760 so that it can deliver another message using the same socket. The new process
32761 does only those deliveries that are routed to the connected host, and may in
32762 turn pass the socket on to a third process, and so on.
32763
32764 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32765 limit the number of messages sent down a single TCP/IP connection.
32766
32767 .cindex "asterisk" "after IP address"
32768 The second and subsequent messages delivered down an existing connection are
32769 identified in the main log by the addition of an asterisk after the closing
32770 square bracket of the IP address.
32771
32772
32773
32774
32775 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32776 .cindex "error" "in outgoing SMTP"
32777 .cindex "SMTP" "errors in outgoing"
32778 .cindex "host" "error"
32779 Three different kinds of error are recognized for outgoing SMTP: host errors,
32780 message errors, and recipient errors.
32781
32782 .vlist
32783 .vitem "&*Host errors*&"
32784 A host error is not associated with a particular message or with a
32785 particular recipient of a message. The host errors are:
32786
32787 .ilist
32788 Connection refused or timed out,
32789 .next
32790 Any error response code on connection,
32791 .next
32792 Any error response code to EHLO or HELO,
32793 .next
32794 Loss of connection at any time, except after &"."&,
32795 .next
32796 I/O errors at any time,
32797 .next
32798 Timeouts during the session, other than in response to MAIL, RCPT or
32799 the &"."& at the end of the data.
32800 .endlist ilist
32801
32802 For a host error, a permanent error response on connection, or in response to
32803 EHLO, causes all addresses routed to the host to be failed. Any other host
32804 error causes all addresses to be deferred, and retry data to be created for the
32805 host. It is not tried again, for any message, until its retry time arrives. If
32806 the current set of addresses are not all delivered in this run (to some
32807 alternative host), the message is added to the list of those waiting for this
32808 host, so if it is still undelivered when a subsequent successful delivery is
32809 made to the host, it will be sent down the same SMTP connection.
32810
32811 .vitem "&*Message errors*&"
32812 .cindex "message" "error"
32813 A message error is associated with a particular message when sent to a
32814 particular host, but not with a particular recipient of the message. The
32815 message errors are:
32816
32817 .ilist
32818 Any error response code to MAIL, DATA, or the &"."& that terminates
32819 the data,
32820 .next
32821 Timeout after MAIL,
32822 .next
32823 Timeout or loss of connection after the &"."& that terminates the data. A
32824 timeout after the DATA command itself is treated as a host error, as is loss of
32825 connection at any other time.
32826 .endlist ilist
32827
32828 For a message error, a permanent error response (5&'xx'&) causes all addresses
32829 to be failed, and a delivery error report to be returned to the sender. A
32830 temporary error response (4&'xx'&), or one of the timeouts, causes all
32831 addresses to be deferred. Retry data is not created for the host, but instead,
32832 a retry record for the combination of host plus message id is created. The
32833 message is not added to the list of those waiting for this host. This ensures
32834 that the failing message will not be sent to this host again until the retry
32835 time arrives. However, other messages that are routed to the host are not
32836 affected, so if it is some property of the message that is causing the error,
32837 it will not stop the delivery of other mail.
32838
32839 If the remote host specified support for the SIZE parameter in its response
32840 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32841 over-large message will cause a message error because the error arrives as a
32842 response to MAIL.
32843
32844 .vitem "&*Recipient errors*&"
32845 .cindex "recipient" "error"
32846 A recipient error is associated with a particular recipient of a message. The
32847 recipient errors are:
32848
32849 .ilist
32850 Any error response to RCPT,
32851 .next
32852 Timeout after RCPT.
32853 .endlist
32854
32855 For a recipient error, a permanent error response (5&'xx'&) causes the
32856 recipient address to be failed, and a bounce message to be returned to the
32857 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32858 address to be deferred, and routing retry data to be created for it. This is
32859 used to delay processing of the address in subsequent queue runs, until its
32860 routing retry time arrives. This applies to all messages, but because it
32861 operates only in queue runs, one attempt will be made to deliver a new message
32862 to the failing address before the delay starts to operate. This ensures that,
32863 if the failure is really related to the message rather than the recipient
32864 (&"message too big for this recipient"& is a possible example), other messages
32865 have a chance of getting delivered. If a delivery to the address does succeed,
32866 the retry information gets cleared, so all stuck messages get tried again, and
32867 the retry clock is reset.
32868
32869 The message is not added to the list of those waiting for this host. Use of the
32870 host for other messages is unaffected, and except in the case of a timeout,
32871 other recipients are processed independently, and may be successfully delivered
32872 in the current SMTP session. After a timeout it is of course impossible to
32873 proceed with the session, so all addresses get deferred. However, those other
32874 than the one that failed do not suffer any subsequent retry delays. Therefore,
32875 if one recipient is causing trouble, the others have a chance of getting
32876 through when a subsequent delivery attempt occurs before the failing
32877 recipient's retry time.
32878 .endlist
32879
32880 In all cases, if there are other hosts (or IP addresses) available for the
32881 current set of addresses (for example, from multiple MX records), they are
32882 tried in this run for any undelivered addresses, subject of course to their
32883 own retry data. In other words, recipient error retry data does not take effect
32884 until the next delivery attempt.
32885
32886 Some hosts have been observed to give temporary error responses to every
32887 MAIL command at certain times (&"insufficient space"& has been seen). It
32888 would be nice if such circumstances could be recognized, and defer data for the
32889 host itself created, but this is not possible within the current Exim design.
32890 What actually happens is that retry data for every (host, message) combination
32891 is created.
32892
32893 The reason that timeouts after MAIL and RCPT are treated specially is that
32894 these can sometimes arise as a result of the remote host's verification
32895 procedures. Exim makes this assumption, and treats them as if a temporary error
32896 response had been received. A timeout after &"."& is treated specially because
32897 it is known that some broken implementations fail to recognize the end of the
32898 message if the last character of the last line is a binary zero. Thus, it is
32899 helpful to treat this case as a message error.
32900
32901 Timeouts at other times are treated as host errors, assuming a problem with the
32902 host, or the connection to it. If a timeout after MAIL, RCPT,
32903 or &"."& is really a connection problem, the assumption is that at the next try
32904 the timeout is likely to occur at some other point in the dialogue, causing it
32905 then to be treated as a host error.
32906
32907 There is experimental evidence that some MTAs drop the connection after the
32908 terminating &"."& if they do not like the contents of the message for some
32909 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32910 should be given. That is why Exim treats this case as a message rather than a
32911 host error, in order not to delay other messages to the same host.
32912
32913
32914
32915
32916 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32917 .cindex "SMTP" "incoming over TCP/IP"
32918 .cindex "incoming SMTP over TCP/IP"
32919 .cindex "inetd"
32920 .cindex "daemon"
32921 Incoming SMTP messages can be accepted in one of two ways: by running a
32922 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32923 &_/etc/inetd.conf_& should be like this:
32924 .code
32925 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32926 .endd
32927 Exim distinguishes between this case and the case of a locally running user
32928 agent using the &%-bs%& option by checking whether or not the standard input is
32929 a socket. When it is, either the port must be privileged (less than 1024), or
32930 the caller must be root or the Exim user. If any other user passes a socket
32931 with an unprivileged port number, Exim prints a message on the standard error
32932 stream and exits with an error code.
32933
32934 By default, Exim does not make a log entry when a remote host connects or
32935 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32936 unexpected. It can be made to write such log entries by setting the
32937 &%smtp_connection%& log selector.
32938
32939 .cindex "carriage return"
32940 .cindex "linefeed"
32941 Commands from the remote host are supposed to be terminated by CR followed by
32942 LF. However, there are known to be hosts that do not send CR characters. In
32943 order to be able to interwork with such hosts, Exim treats LF on its own as a
32944 line terminator.
32945 Furthermore, because common code is used for receiving messages from all
32946 sources, a CR on its own is also interpreted as a line terminator. However, the
32947 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32948
32949 .cindex "EHLO" "invalid data"
32950 .cindex "HELO" "invalid data"
32951 One area that sometimes gives rise to problems concerns the EHLO or
32952 HELO commands. Some clients send syntactically invalid versions of these
32953 commands, which Exim rejects by default. (This is nothing to do with verifying
32954 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32955 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32956 match the broken hosts that send invalid commands.
32957
32958 .cindex "SIZE option on MAIL command"
32959 .cindex "MAIL" "SIZE option"
32960 The amount of disk space available is checked whenever SIZE is received on
32961 a MAIL command, independently of whether &%message_size_limit%& or
32962 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32963 false. A temporary error is given if there is not enough space. If
32964 &%check_spool_space%& is set, the check is for that amount of space plus the
32965 value given with SIZE, that is, it checks that the addition of the incoming
32966 message will not reduce the space below the threshold.
32967
32968 When a message is successfully received, Exim includes the local message id in
32969 its response to the final &"."& that terminates the data. If the remote host
32970 logs this text it can help with tracing what has happened to a message.
32971
32972 The Exim daemon can limit the number of simultaneous incoming connections it is
32973 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32974 number of simultaneous incoming connections from a single remote host (see the
32975 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32976 rejected using the SMTP temporary error code 421.
32977
32978 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32979 subprocess has finished, as this can get lost at busy times. Instead, it looks
32980 for completed subprocesses every time it wakes up. Provided there are other
32981 things happening (new incoming calls, starts of queue runs), completed
32982 processes will be noticed and tidied away. On very quiet systems you may
32983 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32984 it will be noticed when the daemon next wakes up.
32985
32986 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32987 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32988 high system load &-- for details see the &%smtp_accept_reserve%&,
32989 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32990 applies in both the daemon and &'inetd'& cases.
32991
32992 Exim normally starts a delivery process for each message received, though this
32993 can be varied by means of the &%-odq%& command line option and the
32994 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32995 number of simultaneously running delivery processes started in this way from
32996 SMTP input can be limited by the &%smtp_accept_queue%& and
32997 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32998 subsequently received messages are just put on the input queue without starting
32999 a delivery process.
33000
33001 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33002 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33003 started up from the &'inetd'& daemon, because in that case each connection is
33004 handled by an entirely independent Exim process. Control by load average is,
33005 however, available with &'inetd'&.
33006
33007 Exim can be configured to verify addresses in incoming SMTP commands as they
33008 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33009 to rewrite addresses at this time &-- before any syntax checking is done. See
33010 section &<<SECTrewriteS>>&.
33011
33012 Exim can also be configured to limit the rate at which a client host submits
33013 MAIL and RCPT commands in a single SMTP session. See the
33014 &%smtp_ratelimit_hosts%& option.
33015
33016
33017
33018 .section "Unrecognized SMTP commands" "SECID234"
33019 .cindex "SMTP" "unrecognized commands"
33020 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33021 commands during a single SMTP connection, it drops the connection after sending
33022 the error response to the last command. The default value for
33023 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33024 abuse that subvert web servers into making connections to SMTP ports; in these
33025 circumstances, a number of non-SMTP lines are sent first.
33026
33027
33028 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33029 .cindex "SMTP" "syntax errors"
33030 .cindex "SMTP" "protocol errors"
33031 A syntax error is detected if an SMTP command is recognized, but there is
33032 something syntactically wrong with its data, for example, a malformed email
33033 address in a RCPT command. Protocol errors include invalid command
33034 sequencing such as RCPT before MAIL. If Exim receives more than
33035 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33036 drops the connection after sending the error response to the last command. The
33037 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33038 broken clients that loop sending bad commands (yes, it has been seen).
33039
33040
33041
33042 .section "Use of non-mail SMTP commands" "SECID236"
33043 .cindex "SMTP" "non-mail commands"
33044 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33045 DATA. Exim counts such commands, and drops the connection if there are too
33046 many of them in a single SMTP session. This action catches some
33047 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33048 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33049 defines what &"too many"& means. Its default value is 10.
33050
33051 When a new message is expected, one occurrence of RSET is not counted. This
33052 allows a client to send one RSET between messages (this is not necessary,
33053 but some clients do it). Exim also allows one uncounted occurrence of HELO
33054 or EHLO, and one occurrence of STARTTLS between messages. After
33055 starting up a TLS session, another EHLO is expected, and so it too is not
33056 counted.
33057
33058 The first occurrence of AUTH in a connection, or immediately following
33059 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33060 RCPT, DATA, and QUIT are counted.
33061
33062 You can control which hosts are subject to the limit set by
33063 &%smtp_accept_max_nonmail%& by setting
33064 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33065 the limit apply to all hosts. This option means that you can exclude any
33066 specific badly-behaved hosts that you have to live with.
33067
33068
33069
33070
33071 .section "The VRFY and EXPN commands" "SECID237"
33072 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33073 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33074 appropriate) in order to decide whether the command should be accepted or not.
33075 If no ACL is defined, the command is rejected.
33076
33077 .cindex "VRFY" "processing"
33078 When VRFY is accepted, it runs exactly the same code as when Exim is
33079 called with the &%-bv%& option.
33080
33081 .cindex "EXPN" "processing"
33082 When EXPN is accepted, a single-level expansion of the address is done.
33083 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33084 than a verification (the &%-bv%& option). If an unqualified local part is given
33085 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33086 of VRFY and EXPN commands are logged on the main and reject logs, and
33087 VRFY verification failures are logged on the main log for consistency with
33088 RCPT failures.
33089
33090
33091
33092 .section "The ETRN command" "SECTETRN"
33093 .cindex "ETRN" "processing"
33094 RFC 1985 describes an SMTP command called ETRN that is designed to
33095 overcome the security problems of the TURN command (which has fallen into
33096 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33097 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33098 should be accepted or not. If no ACL is defined, the command is rejected.
33099
33100 The ETRN command is concerned with &"releasing"& messages that are awaiting
33101 delivery to certain hosts. As Exim does not organize its message queue by host,
33102 the only form of ETRN that is supported by default is the one where the
33103 text starts with the &"#"& prefix, in which case the remainder of the text is
33104 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33105 the &%-R%& option to happen, with the remainder of the ETRN text as its
33106 argument. For example,
33107 .code
33108 ETRN #brigadoon
33109 .endd
33110 runs the command
33111 .code
33112 exim -R brigadoon
33113 .endd
33114 which causes a delivery attempt on all messages with undelivered addresses
33115 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33116 default), Exim prevents the simultaneous execution of more than one queue run
33117 for the same argument string as a result of an ETRN command. This stops
33118 a misbehaving client from starting more than one queue runner at once.
33119
33120 .cindex "hints database" "ETRN serialization"
33121 Exim implements the serialization by means of a hints database in which a
33122 record is written whenever a process is started by ETRN, and deleted when
33123 the process completes. However, Exim does not keep the SMTP session waiting for
33124 the ETRN process to complete. Once ETRN is accepted, the client is sent
33125 a &"success"& return code. Obviously there is scope for hints records to get
33126 left lying around if there is a system or program crash. To guard against this,
33127 Exim ignores any records that are more than six hours old.
33128
33129 .oindex "&%smtp_etrn_command%&"
33130 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33131 used. This specifies a command that is run whenever ETRN is received,
33132 whatever the form of its argument. For
33133 example:
33134 .code
33135 smtp_etrn_command = /etc/etrn_command $domain \
33136                     $sender_host_address
33137 .endd
33138 .vindex "&$domain$&"
33139 The string is split up into arguments which are independently expanded. The
33140 expansion variable &$domain$& is set to the argument of the ETRN command,
33141 and no syntax checking is done on the contents of this argument. Exim does not
33142 wait for the command to complete, so its status code is not checked. Exim runs
33143 under its own uid and gid when receiving incoming SMTP, so it is not possible
33144 for it to change them before running the command.
33145
33146
33147
33148 .section "Incoming local SMTP" "SECID238"
33149 .cindex "SMTP" "local incoming"
33150 Some user agents use SMTP to pass messages to their local MTA using the
33151 standard input and output, as opposed to passing the envelope on the command
33152 line and writing the message to the standard input. This is supported by the
33153 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33154 messages over TCP/IP (including the use of ACLs), except that the envelope
33155 sender given in a MAIL command is ignored unless the caller is trusted. In
33156 an ACL you can detect this form of SMTP input by testing for an empty host
33157 identification. It is common to have this as the first line in the ACL that
33158 runs for RCPT commands:
33159 .code
33160 accept hosts = :
33161 .endd
33162 This accepts SMTP messages from local processes without doing any other tests.
33163
33164
33165
33166 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33167 .cindex "SMTP" "batched outgoing"
33168 .cindex "batched SMTP output"
33169 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33170 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33171 be output in BSMTP format. No SMTP responses are possible for this form of
33172 delivery. All it is doing is using SMTP commands as a way of transmitting the
33173 envelope along with the message.
33174
33175 The message is written to the file or pipe preceded by the SMTP commands
33176 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33177 the message that start with a dot have an extra dot added. The SMTP command
33178 HELO is not normally used. If it is required, the &%message_prefix%& option
33179 can be used to specify it.
33180
33181 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33182 one recipient address at a time by default. However, you can arrange for them
33183 to handle several addresses at once by setting the &%batch_max%& option. When
33184 this is done for BSMTP, messages may contain multiple RCPT commands. See
33185 chapter &<<CHAPbatching>>& for more details.
33186
33187 .vindex "&$host$&"
33188 When one or more addresses are routed to a BSMTP transport by a router that
33189 sets up a host list, the name of the first host on the list is available to the
33190 transport in the variable &$host$&. Here is an example of such a transport and
33191 router:
33192 .code
33193 begin routers
33194 route_append:
33195   driver = manualroute
33196   transport = smtp_appendfile
33197   route_list = domain.example  batch.host.example
33198
33199 begin transports
33200 smtp_appendfile:
33201   driver = appendfile
33202   directory = /var/bsmtp/$host
33203   batch_max = 1000
33204   use_bsmtp
33205   user = exim
33206 .endd
33207 This causes messages addressed to &'domain.example'& to be written in BSMTP
33208 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33209 message (unless there are more than 1000 recipients).
33210
33211
33212
33213 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33214 .cindex "SMTP" "batched incoming"
33215 .cindex "batched SMTP input"
33216 The &%-bS%& command line option causes Exim to accept one or more messages by
33217 reading SMTP on the standard input, but to generate no responses. If the caller
33218 is trusted, the senders in the MAIL commands are believed; otherwise the
33219 sender is always the caller of Exim. Unqualified senders and receivers are not
33220 rejected (there seems little point) but instead just get qualified. HELO
33221 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33222 as NOOP; QUIT quits.
33223
33224 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33225 ACL is run in the same way as for non-SMTP local input.
33226
33227 If an error is detected while reading a message, including a missing &"."& at
33228 the end, Exim gives up immediately. It writes details of the error to the
33229 standard output in a stylized way that the calling program should be able to
33230 make some use of automatically, for example:
33231 .code
33232 554 Unexpected end of file
33233 Transaction started in line 10
33234 Error detected in line 14
33235 .endd
33236 It writes a more verbose version, for human consumption, to the standard error
33237 file, for example:
33238 .code
33239 An error was detected while processing a file of BSMTP input.
33240 The error message was:
33241
33242 501 '>' missing at end of address
33243
33244 The SMTP transaction started in line 10.
33245 The error was detected in line 12.
33246 The SMTP command at fault was:
33247
33248 rcpt to:<malformed@in.com.plete
33249
33250 1 previous message was successfully processed.
33251 The rest of the batch was abandoned.
33252 .endd
33253 The return code from Exim is zero only if there were no errors. It is 1 if some
33254 messages were accepted before an error was detected, and 2 if no messages were
33255 accepted.
33256 .ecindex IIDsmtpproc1
33257 .ecindex IIDsmtpproc2
33258
33259
33260
33261 . ////////////////////////////////////////////////////////////////////////////
33262 . ////////////////////////////////////////////////////////////////////////////
33263
33264 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33265          "Customizing messages"
33266 When a message fails to be delivered, or remains on the queue for more than a
33267 configured amount of time, Exim sends a message to the original sender, or
33268 to an alternative configured address. The text of these messages is built into
33269 the code of Exim, but it is possible to change it, either by adding a single
33270 string, or by replacing each of the paragraphs by text supplied in a file.
33271
33272 The &'From:'& and &'To:'& header lines are automatically generated; you can
33273 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33274 option. Exim also adds the line
33275 .code
33276 Auto-Submitted: auto-generated
33277 .endd
33278 to all warning and bounce messages,
33279
33280
33281 .section "Customizing bounce messages" "SECID239"
33282 .cindex "customizing" "bounce message"
33283 .cindex "bounce message" "customizing"
33284 If &%bounce_message_text%& is set, its contents are included in the default
33285 message immediately after &"This message was created automatically by mail
33286 delivery software."& The string is not expanded. It is not used if
33287 &%bounce_message_file%& is set.
33288
33289 When &%bounce_message_file%& is set, it must point to a template file for
33290 constructing error messages. The file consists of a series of text items,
33291 separated by lines consisting of exactly four asterisks. If the file cannot be
33292 opened, default text is used and a message is written to the main and panic
33293 logs. If any text item in the file is empty, default text is used for that
33294 item.
33295
33296 .vindex "&$bounce_recipient$&"
33297 .vindex "&$bounce_return_size_limit$&"
33298 Each item of text that is read from the file is expanded, and there are two
33299 expansion variables which can be of use here: &$bounce_recipient$& is set to
33300 the recipient of an error message while it is being created, and
33301 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33302 option, rounded to a whole number.
33303
33304 The items must appear in the file in the following order:
33305
33306 .ilist
33307 The first item is included in the headers, and should include at least a
33308 &'Subject:'& header. Exim does not check the syntax of these headers.
33309 .next
33310 The second item forms the start of the error message. After it, Exim lists the
33311 failing addresses with their error messages.
33312 .next
33313 The third item is used to introduce any text from pipe transports that is to be
33314 returned to the sender. It is omitted if there is no such text.
33315 .next
33316 The fourth item is used to introduce the copy of the message that is returned
33317 as part of the error report.
33318 .next
33319 The fifth item is added after the fourth one if the returned message is
33320 truncated because it is bigger than &%return_size_limit%&.
33321 .next
33322 The sixth item is added after the copy of the original message.
33323 .endlist
33324
33325 The default state (&%bounce_message_file%& unset) is equivalent to the
33326 following file, in which the sixth item is empty. The &'Subject:'& and some
33327 other lines have been split in order to fit them on the page:
33328 .code
33329 Subject: Mail delivery failed
33330   ${if eq{$sender_address}{$bounce_recipient}
33331   {: returning message to sender}}
33332 ****
33333 This message was created automatically by mail delivery software.
33334
33335 A message ${if eq{$sender_address}{$bounce_recipient}
33336   {that you sent }{sent by
33337
33338 <$sender_address>
33339
33340 }}could not be delivered to all of its recipients.
33341 This is a permanent error. The following address(es) failed:
33342 ****
33343 The following text was generated during the delivery attempt(s):
33344 ****
33345 ------ This is a copy of the message, including all the headers.
33346   ------
33347 ****
33348 ------ The body of the message is $message_size characters long;
33349   only the first
33350 ------ $bounce_return_size_limit or so are included here.
33351 ****
33352 .endd
33353 .section "Customizing warning messages" "SECTcustwarn"
33354 .cindex "customizing" "warning message"
33355 .cindex "warning of delay" "customizing the message"
33356 The option &%warn_message_file%& can be pointed at a template file for use when
33357 warnings about message delays are created. In this case there are only three
33358 text sections:
33359
33360 .ilist
33361 The first item is included in the headers, and should include at least a
33362 &'Subject:'& header. Exim does not check the syntax of these headers.
33363 .next
33364 The second item forms the start of the warning message. After it, Exim lists
33365 the delayed addresses.
33366 .next
33367 The third item then ends the message.
33368 .endlist
33369
33370 The default state is equivalent to the following file, except that some lines
33371 have been split here, in order to fit them on the page:
33372 .code
33373 Subject: Warning: message $message_exim_id delayed
33374   $warn_message_delay
33375 ****
33376 This message was created automatically by mail delivery software.
33377
33378 A message ${if eq{$sender_address}{$warn_message_recipients}
33379 {that you sent }{sent by
33380
33381 <$sender_address>
33382
33383 }}has not been delivered to all of its recipients after
33384 more than $warn_message_delay on the queue on $primary_hostname.
33385
33386 The message identifier is:     $message_exim_id
33387 The subject of the message is: $h_subject
33388 The date of the message is:    $h_date
33389
33390 The following address(es) have not yet been delivered:
33391 ****
33392 No action is required on your part. Delivery attempts will
33393 continue for some time, and this warning may be repeated at
33394 intervals if the message remains undelivered. Eventually the
33395 mail delivery software will give up, and when that happens,
33396 the message will be returned to you.
33397 .endd
33398 .vindex "&$warn_message_delay$&"
33399 .vindex "&$warn_message_recipients$&"
33400 However, in the default state the subject and date lines are omitted if no
33401 appropriate headers exist. During the expansion of this file,
33402 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33403 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33404 of recipients for the warning message. There may be more than one if there are
33405 multiple addresses with different &%errors_to%& settings on the routers that
33406 handled them.
33407
33408
33409
33410
33411 . ////////////////////////////////////////////////////////////////////////////
33412 . ////////////////////////////////////////////////////////////////////////////
33413
33414 .chapter "Some common configuration settings" "CHAPcomconreq"
33415 This chapter discusses some configuration settings that seem to be fairly
33416 common. More examples and discussion can be found in the Exim book.
33417
33418
33419
33420 .section "Sending mail to a smart host" "SECID240"
33421 .cindex "smart host" "example router"
33422 If you want to send all mail for non-local domains to a &"smart host"&, you
33423 should replace the default &(dnslookup)& router with a router which does the
33424 routing explicitly:
33425 .code
33426 send_to_smart_host:
33427   driver = manualroute
33428   route_list = !+local_domains smart.host.name
33429   transport = remote_smtp
33430 .endd
33431 You can use the smart host's IP address instead of the name if you wish.
33432 If you are using Exim only to submit messages to a smart host, and not for
33433 receiving incoming messages, you can arrange for it to do the submission
33434 synchronously by setting the &%mua_wrapper%& option (see chapter
33435 &<<CHAPnonqueueing>>&).
33436
33437
33438
33439
33440 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33441 .cindex "mailing lists"
33442 Exim can be used to run simple mailing lists, but for large and/or complicated
33443 requirements, the use of additional specialized mailing list software such as
33444 Majordomo or Mailman is recommended.
33445
33446 The &(redirect)& router can be used to handle mailing lists where each list
33447 is maintained in a separate file, which can therefore be managed by an
33448 independent manager. The &%domains%& router option can be used to run these
33449 lists in a separate domain from normal mail. For example:
33450 .code
33451 lists:
33452   driver = redirect
33453   domains = lists.example
33454   file = /usr/lists/$local_part
33455   forbid_pipe
33456   forbid_file
33457   errors_to = $local_part-request@lists.example
33458   no_more
33459 .endd
33460 This router is skipped for domains other than &'lists.example'&. For addresses
33461 in that domain, it looks for a file that matches the local part. If there is no
33462 such file, the router declines, but because &%no_more%& is set, no subsequent
33463 routers are tried, and so the whole delivery fails.
33464
33465 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33466 expanded into a file name or a pipe delivery, which is usually inappropriate in
33467 a mailing list.
33468
33469 .oindex "&%errors_to%&"
33470 The &%errors_to%& option specifies that any delivery errors caused by addresses
33471 taken from a mailing list are to be sent to the given address rather than the
33472 original sender of the message. However, before acting on this, Exim verifies
33473 the error address, and ignores it if verification fails.
33474
33475 For example, using the configuration above, mail sent to
33476 &'dicts@lists.example'& is passed on to those addresses contained in
33477 &_/usr/lists/dicts_&, with error reports directed to
33478 &'dicts-request@lists.example'&, provided that this address can be verified.
33479 There could be a file called &_/usr/lists/dicts-request_& containing
33480 the address(es) of this particular list's manager(s), but other approaches,
33481 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33482 or &%local_part_suffix%& options) to handle addresses of the form
33483 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33484
33485
33486
33487 .section "Syntax errors in mailing lists" "SECID241"
33488 .cindex "mailing lists" "syntax errors in"
33489 If an entry in redirection data contains a syntax error, Exim normally defers
33490 delivery of the original address. That means that a syntax error in a mailing
33491 list holds up all deliveries to the list. This may not be appropriate when a
33492 list is being maintained automatically from data supplied by users, and the
33493 addresses are not rigorously checked.
33494
33495 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33496 entries that fail to parse, noting the incident in the log. If in addition
33497 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33498 whenever a broken address is skipped. It is usually appropriate to set
33499 &%syntax_errors_to%& to the same address as &%errors_to%&.
33500
33501
33502
33503 .section "Re-expansion of mailing lists" "SECID242"
33504 .cindex "mailing lists" "re-expansion of"
33505 Exim remembers every individual address to which a message has been delivered,
33506 in order to avoid duplication, but it normally stores only the original
33507 recipient addresses with a message. If all the deliveries to a mailing list
33508 cannot be done at the first attempt, the mailing list is re-expanded when the
33509 delivery is next tried. This means that alterations to the list are taken into
33510 account at each delivery attempt, so addresses that have been added to
33511 the list since the message arrived will therefore receive a copy of the
33512 message, even though it pre-dates their subscription.
33513
33514 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33515 on the &(redirect)& router. If this is done, any addresses generated by the
33516 router that fail to deliver at the first attempt are added to the message as
33517 &"top level"& addresses, and the parent address that generated them is marked
33518 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33519 subsequent delivery attempts. The disadvantage of this is that if any of the
33520 failing addresses are incorrect, correcting them in the file has no effect on
33521 pre-existing messages.
33522
33523 The original top-level address is remembered with each of the generated
33524 addresses, and is output in any log messages. However, any intermediate parent
33525 addresses are not recorded. This makes a difference to the log only if the
33526 &%all_parents%& selector is set, but for mailing lists there is normally only
33527 one level of expansion anyway.
33528
33529
33530
33531 .section "Closed mailing lists" "SECID243"
33532 .cindex "mailing lists" "closed"
33533 The examples so far have assumed open mailing lists, to which anybody may
33534 send mail. It is also possible to set up closed lists, where mail is accepted
33535 from specified senders only. This is done by making use of the generic
33536 &%senders%& option to restrict the router that handles the list.
33537
33538 The following example uses the same file as a list of recipients and as a list
33539 of permitted senders. It requires three routers:
33540 .code
33541 lists_request:
33542   driver = redirect
33543   domains = lists.example
33544   local_part_suffix = -request
33545   file = /usr/lists/$local_part$local_part_suffix
33546   no_more
33547
33548 lists_post:
33549   driver = redirect
33550   domains = lists.example
33551   senders = ${if exists {/usr/lists/$local_part}\
33552              {lsearch;/usr/lists/$local_part}{*}}
33553   file = /usr/lists/$local_part
33554   forbid_pipe
33555   forbid_file
33556   errors_to = $local_part-request@lists.example
33557   no_more
33558
33559 lists_closed:
33560   driver = redirect
33561   domains = lists.example
33562   allow_fail
33563   data = :fail: $local_part@lists.example is a closed mailing list
33564 .endd
33565 All three routers have the same &%domains%& setting, so for any other domains,
33566 they are all skipped. The first router runs only if the local part ends in
33567 &%-request%&. It handles messages to the list manager(s) by means of an open
33568 mailing list.
33569
33570 The second router runs only if the &%senders%& precondition is satisfied. It
33571 checks for the existence of a list that corresponds to the local part, and then
33572 checks that the sender is on the list by means of a linear search. It is
33573 necessary to check for the existence of the file before trying to search it,
33574 because otherwise Exim thinks there is a configuration error. If the file does
33575 not exist, the expansion of &%senders%& is *, which matches all senders. This
33576 means that the router runs, but because there is no list, declines, and
33577 &%no_more%& ensures that no further routers are run. The address fails with an
33578 &"unrouteable address"& error.
33579
33580 The third router runs only if the second router is skipped, which happens when
33581 a mailing list exists, but the sender is not on it. This router forcibly fails
33582 the address, giving a suitable error message.
33583
33584
33585
33586
33587 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33588 .cindex "VERP"
33589 .cindex "Variable Envelope Return Paths"
33590 .cindex "envelope sender"
33591 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33592 are a way of helping mailing list administrators discover which subscription
33593 address is the cause of a particular delivery failure. The idea is to encode
33594 the original recipient address in the outgoing envelope sender address, so that
33595 if the message is forwarded by another host and then subsequently bounces, the
33596 original recipient can be extracted from the recipient address of the bounce.
33597
33598 .oindex &%errors_to%&
33599 .oindex &%return_path%&
33600 Envelope sender addresses can be modified by Exim using two different
33601 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33602 list examples), or the &%return_path%& option on a transport. The second of
33603 these is effective only if the message is successfully delivered to another
33604 host; it is not used for errors detected on the local host (see the description
33605 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33606 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33607 .code
33608 verp_smtp:
33609   driver = smtp
33610   max_rcpt = 1
33611   return_path = \
33612     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33613       {$1-request+$local_part=$domain@your.dom.example}fail}
33614 .endd
33615 This has the effect of rewriting the return path (envelope sender) on outgoing
33616 SMTP messages, if the local part of the original return path ends in
33617 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33618 local part and domain of the recipient into the return path. Suppose, for
33619 example, that a message whose return path has been set to
33620 &'somelist-request@your.dom.example'& is sent to
33621 &'subscriber@other.dom.example'&. In the transport, the return path is
33622 rewritten as
33623 .code
33624 somelist-request+subscriber=other.dom.example@your.dom.example
33625 .endd
33626 .vindex "&$local_part$&"
33627 For this to work, you must tell Exim to send multiple copies of messages that
33628 have more than one recipient, so that each copy has just one recipient. This is
33629 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33630 might be sent to several different recipients in the same domain, in which case
33631 &$local_part$& is not available in the transport, because it is not unique.
33632
33633 Unless your host is doing nothing but mailing list deliveries, you should
33634 probably use a separate transport for the VERP deliveries, so as not to use
33635 extra resources in making one-per-recipient copies for other deliveries. This
33636 can easily be done by expanding the &%transport%& option in the router:
33637 .code
33638 dnslookup:
33639   driver = dnslookup
33640   domains = ! +local_domains
33641   transport = \
33642     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33643       {verp_smtp}{remote_smtp}}
33644   no_more
33645 .endd
33646 If you want to change the return path using &%errors_to%& in a router instead
33647 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33648 routers that handle mailing list addresses. This will ensure that all delivery
33649 errors, including those detected on the local host, are sent to the VERP
33650 address.
33651
33652 On a host that does no local deliveries and has no manual routing, only the
33653 &(dnslookup)& router needs to be changed. A special transport is not needed for
33654 SMTP deliveries. Every mailing list recipient has its own return path value,
33655 and so Exim must hand them to the transport one at a time. Here is an example
33656 of a &(dnslookup)& router that implements VERP:
33657 .code
33658 verp_dnslookup:
33659   driver = dnslookup
33660   domains = ! +local_domains
33661   transport = remote_smtp
33662   errors_to = \
33663     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33664      {$1-request+$local_part=$domain@your.dom.example}fail}
33665   no_more
33666 .endd
33667 Before you start sending out messages with VERPed return paths, you must also
33668 configure Exim to accept the bounce messages that come back to those paths.
33669 Typically this is done by setting a &%local_part_suffix%& option for a
33670 router, and using this to route the messages to wherever you want to handle
33671 them.
33672
33673 The overhead incurred in using VERP depends very much on the size of the
33674 message, the number of recipient addresses that resolve to the same remote
33675 host, and the speed of the connection over which the message is being sent. If
33676 a lot of addresses resolve to the same host and the connection is slow, sending
33677 a separate copy of the message for each address may take substantially longer
33678 than sending a single copy with many recipients (for which VERP cannot be
33679 used).
33680
33681
33682
33683
33684
33685
33686 .section "Virtual domains" "SECTvirtualdomains"
33687 .cindex "virtual domains"
33688 .cindex "domain" "virtual"
33689 The phrase &'virtual domain'& is unfortunately used with two rather different
33690 meanings:
33691
33692 .ilist
33693 A domain for which there are no real mailboxes; all valid local parts are
33694 aliases for other email addresses. Common examples are organizational
33695 top-level domains and &"vanity"& domains.
33696 .next
33697 One of a number of independent domains that are all handled by the same host,
33698 with mailboxes on that host, but where the mailbox owners do not necessarily
33699 have login accounts on that host.
33700 .endlist
33701
33702 The first usage is probably more common, and does seem more &"virtual"& than
33703 the second. This kind of domain can be handled in Exim with a straightforward
33704 aliasing router. One approach is to create a separate alias file for each
33705 virtual domain. Exim can test for the existence of the alias file to determine
33706 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33707 to a router of this form:
33708 .code
33709 virtual:
33710   driver = redirect
33711   domains = dsearch;/etc/mail/virtual
33712   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33713   no_more
33714 .endd
33715 The &%domains%& option specifies that the router is to be skipped, unless there
33716 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33717 domain that is being processed. When the router runs, it looks up the local
33718 part in the file to find a new address (or list of addresses). The &%no_more%&
33719 setting ensures that if the lookup fails (leading to &%data%& being an empty
33720 string), Exim gives up on the address without trying any subsequent routers.
33721
33722 This one router can handle all the virtual domains because the alias file names
33723 follow a fixed pattern. Permissions can be arranged so that appropriate people
33724 can edit the different alias files. A successful aliasing operation results in
33725 a new envelope recipient address, which is then routed from scratch.
33726
33727 The other kind of &"virtual"& domain can also be handled in a straightforward
33728 way. One approach is to create a file for each domain containing a list of
33729 valid local parts, and use it in a router like this:
33730 .code
33731 my_domains:
33732   driver = accept
33733   domains = dsearch;/etc/mail/domains
33734   local_parts = lsearch;/etc/mail/domains/$domain
33735   transport = my_mailboxes
33736 .endd
33737 The address is accepted if there is a file for the domain, and the local part
33738 can be found in the file. The &%domains%& option is used to check for the
33739 file's existence because &%domains%& is tested before the &%local_parts%&
33740 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33741 because that option is tested after &%local_parts%&. The transport is as
33742 follows:
33743 .code
33744 my_mailboxes:
33745   driver = appendfile
33746   file = /var/mail/$domain/$local_part
33747   user = mail
33748 .endd
33749 This uses a directory of mailboxes for each domain. The &%user%& setting is
33750 required, to specify which uid is to be used for writing to the mailboxes.
33751
33752 The configuration shown here is just one example of how you might support this
33753 requirement. There are many other ways this kind of configuration can be set
33754 up, for example, by using a database instead of separate files to hold all the
33755 information about the domains.
33756
33757
33758
33759 .section "Multiple user mailboxes" "SECTmulbox"
33760 .cindex "multiple mailboxes"
33761 .cindex "mailbox" "multiple"
33762 .cindex "local part" "prefix"
33763 .cindex "local part" "suffix"
33764 Heavy email users often want to operate with multiple mailboxes, into which
33765 incoming mail is automatically sorted. A popular way of handling this is to
33766 allow users to use multiple sender addresses, so that replies can easily be
33767 identified. Users are permitted to add prefixes or suffixes to their local
33768 parts for this purpose. The wildcard facility of the generic router options
33769 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33770 example, consider this router:
33771 .code
33772 userforward:
33773   driver = redirect
33774   check_local_user
33775   file = $home/.forward
33776   local_part_suffix = -*
33777   local_part_suffix_optional
33778   allow_filter
33779 .endd
33780 .vindex "&$local_part_suffix$&"
33781 It runs a user's &_.forward_& file for all local parts of the form
33782 &'username-*'&. Within the filter file the user can distinguish different
33783 cases by testing the variable &$local_part_suffix$&. For example:
33784 .code
33785 if $local_part_suffix contains -special then
33786 save /home/$local_part/Mail/special
33787 endif
33788 .endd
33789 If the filter file does not exist, or does not deal with such addresses, they
33790 fall through to subsequent routers, and, assuming no subsequent use of the
33791 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33792 control over which suffixes are valid.
33793
33794 Alternatively, a suffix can be used to trigger the use of a different
33795 &_.forward_& file &-- which is the way a similar facility is implemented in
33796 another MTA:
33797 .code
33798 userforward:
33799   driver = redirect
33800   check_local_user
33801   file = $home/.forward$local_part_suffix
33802   local_part_suffix = -*
33803   local_part_suffix_optional
33804   allow_filter
33805 .endd
33806 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33807 example, &_.forward-special_& is used. Once again, if the appropriate file
33808 does not exist, or does not deal with the address, it is passed on to
33809 subsequent routers, which could, if required, look for an unqualified
33810 &_.forward_& file to use as a default.
33811
33812
33813
33814 .section "Simplified vacation processing" "SECID244"
33815 .cindex "vacation processing"
33816 The traditional way of running the &'vacation'& program is for a user to set up
33817 a pipe command in a &_.forward_& file
33818 (see section &<<SECTspecitredli>>& for syntax details).
33819 This is prone to error by inexperienced users. There are two features of Exim
33820 that can be used to make this process simpler for users:
33821
33822 .ilist
33823 A local part prefix such as &"vacation-"& can be specified on a router which
33824 can cause the message to be delivered directly to the &'vacation'& program, or
33825 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33826 &_.forward_& file are then much simpler. For example:
33827 .code
33828 spqr, vacation-spqr
33829 .endd
33830 .next
33831 The &%require_files%& generic router option can be used to trigger a
33832 vacation delivery by checking for the existence of a certain file in the
33833 user's home directory. The &%unseen%& generic option should also be used, to
33834 ensure that the original delivery also proceeds. In this case, all the user has
33835 to do is to create a file called, say, &_.vacation_&, containing a vacation
33836 message.
33837 .endlist
33838
33839 Another advantage of both these methods is that they both work even when the
33840 use of arbitrary pipes by users is locked out.
33841
33842
33843
33844 .section "Taking copies of mail" "SECID245"
33845 .cindex "message" "copying every"
33846 Some installations have policies that require archive copies of all messages to
33847 be made. A single copy of each message can easily be taken by an appropriate
33848 command in a system filter, which could, for example, use a different file for
33849 each day's messages.
33850
33851 There is also a shadow transport mechanism that can be used to take copies of
33852 messages that are successfully delivered by local transports, one copy per
33853 delivery. This could be used, &'inter alia'&, to implement automatic
33854 notification of delivery by sites that insist on doing such things.
33855
33856
33857
33858 .section "Intermittently connected hosts" "SECID246"
33859 .cindex "intermittently connected hosts"
33860 It has become quite common (because it is cheaper) for hosts to connect to the
33861 Internet periodically rather than remain connected all the time. The normal
33862 arrangement is that mail for such hosts accumulates on a system that is
33863 permanently connected.
33864
33865 Exim was designed for use on permanently connected hosts, and so it is not
33866 particularly well-suited to use in an intermittently connected environment.
33867 Nevertheless there are some features that can be used.
33868
33869
33870 .section "Exim on the upstream server host" "SECID247"
33871 It is tempting to arrange for incoming mail for the intermittently connected
33872 host to remain on Exim's queue until the client connects. However, this
33873 approach does not scale very well. Two different kinds of waiting message are
33874 being mixed up in the same queue &-- those that cannot be delivered because of
33875 some temporary problem, and those that are waiting for their destination host
33876 to connect. This makes it hard to manage the queue, as well as wasting
33877 resources, because each queue runner scans the entire queue.
33878
33879 A better approach is to separate off those messages that are waiting for an
33880 intermittently connected host. This can be done by delivering these messages
33881 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33882 format, from where they are transmitted by other software when their
33883 destination connects. This makes it easy to collect all the mail for one host
33884 in a single directory, and to apply local timeout rules on a per-message basis
33885 if required.
33886
33887 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33888 you are doing this, you should configure Exim with a long retry period for the
33889 intermittent host. For example:
33890 .code
33891 cheshire.wonderland.fict.example    *   F,5d,24h
33892 .endd
33893 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33894 which messages it has queued up for that host. Once the intermittent host comes
33895 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33896 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33897 causes all the queued up messages to be delivered, often down a single SMTP
33898 connection. While the host remains connected, any new messages get delivered
33899 immediately.
33900
33901 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33902 issued with a different IP address each time it connects, Exim's retry
33903 mechanisms on the holding host get confused, because the IP address is normally
33904 used as part of the key string for holding retry information. This can be
33905 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33906 Since this has disadvantages for permanently connected hosts, it is best to
33907 arrange a separate transport for the intermittently connected ones.
33908
33909
33910
33911 .section "Exim on the intermittently connected client host" "SECID248"
33912 The value of &%smtp_accept_queue_per_connection%& should probably be
33913 increased, or even set to zero (that is, disabled) on the intermittently
33914 connected host, so that all incoming messages down a single connection get
33915 delivered immediately.
33916
33917 .cindex "SMTP" "passed connection"
33918 .cindex "SMTP" "multiple deliveries"
33919 .cindex "multiple SMTP deliveries"
33920 Mail waiting to be sent from an intermittently connected host will probably
33921 not have been routed, because without a connection DNS lookups are not
33922 possible. This means that if a normal queue run is done at connection time,
33923 each message is likely to be sent in a separate SMTP session. This can be
33924 avoided by starting the queue run with a command line option beginning with
33925 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33926 first pass, routing is done but no deliveries take place. The second pass is a
33927 normal queue run; since all the messages have been previously routed, those
33928 destined for the same host are likely to get sent as multiple deliveries in a
33929 single SMTP connection.
33930
33931
33932
33933 . ////////////////////////////////////////////////////////////////////////////
33934 . ////////////////////////////////////////////////////////////////////////////
33935
33936 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33937          "Exim as a non-queueing client"
33938 .cindex "client, non-queueing"
33939 .cindex "smart host" "suppressing queueing"
33940 On a personal computer, it is a common requirement for all
33941 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33942 configured to operate that way, for all the popular operating systems.
33943 However, there are some MUAs for Unix-like systems that cannot be so
33944 configured: they submit messages using the command line interface of
33945 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33946 messages this way.
33947
33948 If the personal computer runs continuously, there is no problem, because it can
33949 run a conventional MTA that handles delivery to the smart host, and deal with
33950 any delays via its queueing mechanism. However, if the computer does not run
33951 continuously or runs different operating systems at different times, queueing
33952 email is not desirable.
33953
33954 There is therefore a requirement for something that can provide the
33955 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33956 any queueing or retrying facilities. Furthermore, the delivery to the smart
33957 host should be synchronous, so that if it fails, the sending MUA is immediately
33958 informed. In other words, we want something that extends an MUA that submits
33959 to a local MTA via the command line so that it behaves like one that submits
33960 to a remote smart host using TCP/SMTP.
33961
33962 There are a number of applications (for example, there is one called &'ssmtp'&)
33963 that do this job. However, people have found them to be lacking in various
33964 ways. For instance, you might want to allow aliasing and forwarding to be done
33965 before sending a message to the smart host.
33966
33967 Exim already had the necessary infrastructure for doing this job. Just a few
33968 tweaks were needed to make it behave as required, though it is somewhat of an
33969 overkill to use a fully-featured MTA for this purpose.
33970
33971 .oindex "&%mua_wrapper%&"
33972 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33973 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33974 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33975 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33976 compatible router and transport configuration. Typically there will be just one
33977 router and one transport, sending everything to a smart host.
33978
33979 When run in MUA wrapping mode, the behaviour of Exim changes in the
33980 following ways:
33981
33982 .ilist
33983 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33984 In other words, the only way to submit messages is via the command line.
33985 .next
33986 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33987 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33988 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33989 does not finish until the delivery attempt is complete. If the delivery is
33990 successful, a zero return code is given.
33991 .next
33992 Address redirection is permitted, but the final routing for all addresses must
33993 be to the same remote transport, and to the same list of hosts. Furthermore,
33994 the return address (envelope sender) must be the same for all recipients, as
33995 must any added or deleted header lines. In other words, it must be possible to
33996 deliver the message in a single SMTP transaction, however many recipients there
33997 are.
33998 .next
33999 If these conditions are not met, or if routing any address results in a
34000 failure or defer status, or if Exim is unable to deliver all the recipients
34001 successfully to one of the smart hosts, delivery of the entire message fails.
34002 .next
34003 Because no queueing is allowed, all failures are treated as permanent; there
34004 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34005 smart host. Furthermore, because only a single yes/no response can be given to
34006 the caller, it is not possible to deliver to some recipients and not others. If
34007 there is an error (temporary or permanent) for any recipient, all are failed.
34008 .next
34009 If more than one smart host is listed, Exim will try another host after a
34010 connection failure or a timeout, in the normal way. However, if this kind of
34011 failure happens for all the hosts, the delivery fails.
34012 .next
34013 When delivery fails, an error message is written to the standard error stream
34014 (as well as to Exim's log), and Exim exits to the caller with a return code
34015 value 1. The message is expunged from Exim's spool files. No bounce messages
34016 are ever generated.
34017 .next
34018 No retry data is maintained, and any retry rules are ignored.
34019 .next
34020 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34021 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34022 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34023 .endlist
34024
34025 The overall effect is that Exim makes a single synchronous attempt to deliver
34026 the message, failing if there is any kind of problem. Because no local
34027 deliveries are done and no daemon can be run, Exim does not need root
34028 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34029 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34030 the advantages and disadvantages of running without root privilege.
34031
34032
34033
34034
34035 . ////////////////////////////////////////////////////////////////////////////
34036 . ////////////////////////////////////////////////////////////////////////////
34037
34038 .chapter "Log files" "CHAPlog"
34039 .scindex IIDloggen "log" "general description"
34040 .cindex "log" "types of"
34041 Exim writes three different logs, referred to as the main log, the reject log,
34042 and the panic log:
34043
34044 .ilist
34045 .cindex "main log"
34046 The main log records the arrival of each message and each delivery in a single
34047 line in each case. The format is as compact as possible, in an attempt to keep
34048 down the size of log files. Two-character flag sequences make it easy to pick
34049 out these lines. A number of other events are recorded in the main log. Some of
34050 them are optional, in which case the &%log_selector%& option controls whether
34051 they are included or not. A Perl script called &'eximstats'&, which does simple
34052 analysis of main log files, is provided in the Exim distribution (see section
34053 &<<SECTmailstat>>&).
34054 .next
34055 .cindex "reject log"
34056 The reject log records information from messages that are rejected as a result
34057 of a configuration option (that is, for policy reasons).
34058 The first line of each rejection is a copy of the line that is also written to
34059 the main log. Then, if the message's header has been read at the time the log
34060 is written, its contents are written to this log. Only the original header
34061 lines are available; header lines added by ACLs are not logged. You can use the
34062 reject log to check that your policy controls are working correctly; on a busy
34063 host this may be easier than scanning the main log for rejection messages. You
34064 can suppress the writing of the reject log by setting &%write_rejectlog%&
34065 false.
34066 .next
34067 .cindex "panic log"
34068 .cindex "system log"
34069 When certain serious errors occur, Exim writes entries to its panic log. If the
34070 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34071 are usually written to the main log as well, but can get lost amid the mass of
34072 other entries. The panic log should be empty under normal circumstances. It is
34073 therefore a good idea to check it (or to have a &'cron'& script check it)
34074 regularly, in order to become aware of any problems. When Exim cannot open its
34075 panic log, it tries as a last resort to write to the system log (syslog). This
34076 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34077 message itself is written at priority LOG_CRIT.
34078 .endlist
34079
34080 Every log line starts with a timestamp, in the format shown in the following
34081 example. Note that many of the examples shown in this chapter are line-wrapped.
34082 In the log file, this would be all on one line:
34083 .code
34084 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34085   by QUIT
34086 .endd
34087 By default, the timestamps are in the local timezone. There are two
34088 ways of changing this:
34089
34090 .ilist
34091 You can set the &%timezone%& option to a different time zone; in particular, if
34092 you set
34093 .code
34094 timezone = UTC
34095 .endd
34096 the timestamps will be in UTC (aka GMT).
34097 .next
34098 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34099 example:
34100 .code
34101 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34102 .endd
34103 .endlist
34104
34105 .cindex "log" "process ids in"
34106 .cindex "pid (process id)" "in log lines"
34107 Exim does not include its process id in log lines by default, but you can
34108 request that it does so by specifying the &`pid`& log selector (see section
34109 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34110 brackets, immediately after the time and date.
34111
34112
34113
34114
34115 .section "Where the logs are written" "SECTwhelogwri"
34116 .cindex "log" "destination"
34117 .cindex "log" "to file"
34118 .cindex "log" "to syslog"
34119 .cindex "syslog"
34120 The logs may be written to local files, or to syslog, or both. However, it
34121 should be noted that many syslog implementations use UDP as a transport, and
34122 are therefore unreliable in the sense that messages are not guaranteed to
34123 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34124 It has also been reported that on large log files (tens of megabytes) you may
34125 need to tweak syslog to prevent it syncing the file with each write &-- on
34126 Linux this has been seen to make syslog take 90% plus of CPU time.
34127
34128 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34129 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34130 configuration. This latter string is expanded, so it can contain, for example,
34131 references to the host name:
34132 .code
34133 log_file_path = /var/log/$primary_hostname/exim_%slog
34134 .endd
34135 It is generally advisable, however, to set the string in &_Local/Makefile_&
34136 rather than at run time, because then the setting is available right from the
34137 start of Exim's execution. Otherwise, if there's something it wants to log
34138 before it has read the configuration file (for example, an error in the
34139 configuration file) it will not use the path you want, and may not be able to
34140 log at all.
34141
34142 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34143 list, currently limited to at most two items. This is one option where the
34144 facility for changing a list separator may not be used. The list must always be
34145 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34146 otherwise the item must either be an absolute path, containing &`%s`& at the
34147 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34148 implying the use of a default path.
34149
34150 When Exim encounters an empty item in the list, it searches the list defined by
34151 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34152 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34153 mean &"use the path specified at build time"&. It no such item exists, log
34154 files are written in the &_log_& subdirectory of the spool directory. This is
34155 equivalent to the setting:
34156 .code
34157 log_file_path = $spool_directory/log/%slog
34158 .endd
34159 If you do not specify anything at build time or run time, that is where the
34160 logs are written.
34161
34162 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34163 are in use &-- see section &<<SECTdatlogfil>>& below.
34164
34165 Here are some examples of possible settings:
34166 .display
34167 &`LOG_FILE_PATH=syslog                    `& syslog only
34168 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34169 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34170 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34171 .endd
34172 If there are more than two paths in the list, the first is used and a panic
34173 error is logged.
34174
34175
34176
34177 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34178 .cindex "log" "cycling local files"
34179 .cindex "cycling logs"
34180 .cindex "&'exicyclog'&"
34181 .cindex "log" "local files; writing to"
34182 Some operating systems provide centralized and standardized methods for cycling
34183 log files. For those that do not, a utility script called &'exicyclog'& is
34184 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34185 main and reject logs each time it is called. The maximum number of old logs to
34186 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34187
34188 An Exim delivery process opens the main log when it first needs to write to it,
34189 and it keeps the file open in case subsequent entries are required &-- for
34190 example, if a number of different deliveries are being done for the same
34191 message. However, remote SMTP deliveries can take a long time, and this means
34192 that the file may be kept open long after it is renamed if &'exicyclog'& or
34193 something similar is being used to rename log files on a regular basis. To
34194 ensure that a switch of log files is noticed as soon as possible, Exim calls
34195 &[stat()]& on the main log's name before reusing an open file, and if the file
34196 does not exist, or its inode has changed, the old file is closed and Exim
34197 tries to open the main log from scratch. Thus, an old log file may remain open
34198 for quite some time, but no Exim processes should write to it once it has been
34199 renamed.
34200
34201
34202
34203 .section "Datestamped log files" "SECTdatlogfil"
34204 .cindex "log" "datestamped files"
34205 Instead of cycling the main and reject log files by renaming them
34206 periodically, some sites like to use files whose names contain a datestamp,
34207 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34208 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34209 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34210 point where the datestamp is required. For example:
34211 .code
34212 log_file_path = /var/spool/exim/log/%slog-%D
34213 log_file_path = /var/log/exim-%s-%D.log
34214 log_file_path = /var/spool/exim/log/%D-%slog
34215 log_file_path = /var/log/exim/%s.%M
34216 .endd
34217 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34218 examples of names generated by the above examples:
34219 .code
34220 /var/spool/exim/log/mainlog-20021225
34221 /var/log/exim-reject-20021225.log
34222 /var/spool/exim/log/20021225-mainlog
34223 /var/log/exim/main.200212
34224 .endd
34225 When this form of log file is specified, Exim automatically switches to new
34226 files at midnight. It does not make any attempt to compress old logs; you
34227 will need to write your own script if you require this. You should not
34228 run &'exicyclog'& with this form of logging.
34229
34230 The location of the panic log is also determined by &%log_file_path%&, but it
34231 is not datestamped, because rotation of the panic log does not make sense.
34232 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34233 the string. In addition, if it immediately follows a slash, a following
34234 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34235 character is removed. Thus, the four examples above would give these panic
34236 log names:
34237 .code
34238 /var/spool/exim/log/paniclog
34239 /var/log/exim-panic.log
34240 /var/spool/exim/log/paniclog
34241 /var/log/exim/panic
34242 .endd
34243
34244
34245 .section "Logging to syslog" "SECID249"
34246 .cindex "log" "syslog; writing to"
34247 The use of syslog does not change what Exim logs or the format of its messages,
34248 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34249 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34250 that, the same strings are written to syslog as to log files. The syslog
34251 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34252 by default, but you can change these by setting the &%syslog_facility%& and
34253 &%syslog_processname%& options, respectively. If Exim was compiled with
34254 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34255 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34256 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34257 the time and host name to each line.
34258 The three log streams are mapped onto syslog priorities as follows:
34259
34260 .ilist
34261 &'mainlog'& is mapped to LOG_INFO
34262 .next
34263 &'rejectlog'& is mapped to LOG_NOTICE
34264 .next
34265 &'paniclog'& is mapped to LOG_ALERT
34266 .endlist
34267
34268 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34269 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34270 these are routed by syslog to the same place. You can suppress this duplication
34271 by setting &%syslog_duplication%& false.
34272
34273 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34274 entries contain multiple lines when headers are included. To cope with both
34275 these cases, entries written to syslog are split into separate &[syslog()]&
34276 calls at each internal newline, and also after a maximum of
34277 870 data characters. (This allows for a total syslog line length of 1024, when
34278 additions such as timestamps are added.) If you are running a syslog
34279 replacement that can handle lines longer than the 1024 characters allowed by
34280 RFC 3164, you should set
34281 .code
34282 SYSLOG_LONG_LINES=yes
34283 .endd
34284 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34285 lines, but it still splits at internal newlines in &'reject'& log entries.
34286
34287 To make it easy to re-assemble split lines later, each component of a split
34288 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34289 where <&'n'&> is the component number and <&'m'&> is the total number of
34290 components in the entry. The / delimiter is used when the line was split
34291 because it was too long; if it was split because of an internal newline, the \
34292 delimiter is used. For example, supposing the length limit to be 50 instead of
34293 870, the following would be the result of a typical rejection message to
34294 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34295 name, and pid as added by syslog:
34296 .code
34297 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34298 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34299 [3/5]  when scanning for sender: missing or malformed lo
34300 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34301 [5/5] mple>)
34302 .endd
34303 The same error might cause the following lines to be written to &"rejectlog"&
34304 (LOG_NOTICE):
34305 .code
34306 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34307 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34308 [3/18] er when scanning for sender: missing or malformed
34309 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34310 [5\18] .example>)
34311 [6\18] Recipients: ph10@some.domain.cam.example
34312 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34313 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34314 [9\18]        id 16RdAL-0006pc-00
34315 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34316 [11\18] 09:43 +0100
34317 [12\18] F From: <>
34318 [13\18]   Subject: this is a test header
34319 [18\18]   X-something: this is another header
34320 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34321 [16\18] le>
34322 [17\18] B Bcc:
34323 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34324 .endd
34325 Log lines that are neither too long nor contain newlines are written to syslog
34326 without modification.
34327
34328 If only syslog is being used, the Exim monitor is unable to provide a log tail
34329 display, unless syslog is routing &'mainlog'& to a file on the local host and
34330 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34331 where it is.
34332
34333
34334
34335 .section "Log line flags" "SECID250"
34336 One line is written to the main log for each message received, and for each
34337 successful, unsuccessful, and delayed delivery. These lines can readily be
34338 picked out by the distinctive two-character flags that immediately follow the
34339 timestamp. The flags are:
34340 .display
34341 &`<=`&     message arrival
34342 &`=>`&     normal message delivery
34343 &`->`&     additional address in same delivery
34344 &`>>`&     cutthrough message delivery
34345 &`*>`&     delivery suppressed by &%-N%&
34346 &`**`&     delivery failed; address bounced
34347 &`==`&     delivery deferred; temporary problem
34348 .endd
34349
34350
34351 .section "Logging message reception" "SECID251"
34352 .cindex "log" "reception line"
34353 The format of the single-line entry in the main log that is written for every
34354 message received is shown in the basic example below, which is split over
34355 several lines in order to fit it on the page:
34356 .code
34357 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34358   H=mailer.fict.example [192.168.123.123] U=exim
34359   P=smtp S=5678 id=<incoming message id>
34360 .endd
34361 The address immediately following &"<="& is the envelope sender address. A
34362 bounce message is shown with the sender address &"<>"&, and if it is locally
34363 generated, this is followed by an item of the form
34364 .code
34365 R=<message id>
34366 .endd
34367 which is a reference to the message that caused the bounce to be sent.
34368
34369 .cindex "HELO"
34370 .cindex "EHLO"
34371 For messages from other hosts, the H and U fields identify the remote host and
34372 record the RFC 1413 identity of the user that sent the message, if one was
34373 received. The number given in square brackets is the IP address of the sending
34374 host. If there is a single, unparenthesized  host name in the H field, as
34375 above, it has been verified to correspond to the IP address (see the
34376 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34377 by the remote host in the SMTP HELO or EHLO command, and has not been
34378 verified. If verification yields a different name to that given for HELO or
34379 EHLO, the verified name appears first, followed by the HELO or EHLO
34380 name in parentheses.
34381
34382 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34383 without brackets, in the HELO or EHLO command, leading to entries in
34384 the log containing text like these examples:
34385 .code
34386 H=(10.21.32.43) [192.168.8.34]
34387 H=([10.21.32.43]) [192.168.8.34]
34388 .endd
34389 This can be confusing. Only the final address in square brackets can be relied
34390 on.
34391
34392 For locally generated messages (that is, messages not received over TCP/IP),
34393 the H field is omitted, and the U field contains the login name of the caller
34394 of Exim.
34395
34396 .cindex "authentication" "logging"
34397 .cindex "AUTH" "logging"
34398 For all messages, the P field specifies the protocol used to receive the
34399 message. This is the value that is stored in &$received_protocol$&. In the case
34400 of incoming SMTP messages, the value indicates whether or not any SMTP
34401 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34402 session was encrypted, there is an additional X field that records the cipher
34403 suite that was used.
34404
34405 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34406 hosts that have authenticated themselves using the SMTP AUTH command. The first
34407 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34408 there is an additional item A= followed by the name of the authenticator that
34409 was used. If an authenticated identification was set up by the authenticator's
34410 &%server_set_id%& option, this is logged too, separated by a colon from the
34411 authenticator name.
34412
34413 .cindex "size" "of message"
34414 The id field records the existing message id, if present. The size of the
34415 received message is given by the S field. When the message is delivered,
34416 headers may be removed or added, so that the size of delivered copies of the
34417 message may not correspond with this value (and indeed may be different to each
34418 other).
34419
34420 The &%log_selector%& option can be used to request the logging of additional
34421 data when a message is received. See section &<<SECTlogselector>>& below.
34422
34423
34424
34425 .section "Logging deliveries" "SECID252"
34426 .cindex "log" "delivery line"
34427 The format of the single-line entry in the main log that is written for every
34428 delivery is shown in one of the examples below, for local and remote
34429 deliveries, respectively. Each example has been split into two lines in order
34430 to fit it on the page:
34431 .code
34432 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34433   <marv@hitch.fict.example> R=localuser T=local_delivery
34434 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34435   monk@holistic.fict.example R=dnslookup T=remote_smtp
34436   H=holistic.fict.example [192.168.234.234]
34437 .endd
34438 For ordinary local deliveries, the original address is given in angle brackets
34439 after the final delivery address, which might be a pipe or a file. If
34440 intermediate address(es) exist between the original and the final address, the
34441 last of these is given in parentheses after the final address. The R and T
34442 fields record the router and transport that were used to process the address.
34443
34444 If SMTP AUTH was used for the delivery there is an additional item A=
34445 followed by the name of the authenticator that was used.
34446 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34447 option, this is logged too, separated by a colon from the authenticator name.
34448
34449 If a shadow transport was run after a successful local delivery, the log line
34450 for the successful delivery has an item added on the end, of the form
34451 .display
34452 &`ST=<`&&'shadow transport name'&&`>`&
34453 .endd
34454 If the shadow transport did not succeed, the error message is put in
34455 parentheses afterwards.
34456
34457 .cindex "asterisk" "after IP address"
34458 When more than one address is included in a single delivery (for example, two
34459 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34460 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34461 down a single SMTP connection, an asterisk follows the IP address in the log
34462 lines for the second and subsequent messages.
34463
34464 .cindex "delivery" "cutthrough; logging"
34465 .cindex "cutthrough" "logging"
34466 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34467 line precedes the reception line, since cutthrough waits for a possible
34468 rejection from the destination in case it can reject the sourced item.
34469
34470 The generation of a reply message by a filter file gets logged as a
34471 &"delivery"& to the addressee, preceded by &">"&.
34472
34473 The &%log_selector%& option can be used to request the logging of additional
34474 data when a message is delivered. See section &<<SECTlogselector>>& below.
34475
34476
34477 .section "Discarded deliveries" "SECID253"
34478 .cindex "discarded messages"
34479 .cindex "message" "discarded"
34480 .cindex "delivery" "discarded; logging"
34481 When a message is discarded as a result of the command &"seen finish"& being
34482 obeyed in a filter file which generates no deliveries, a log entry of the form
34483 .code
34484 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34485   <low.club@bridge.example> R=userforward
34486 .endd
34487 is written, to record why no deliveries are logged. When a message is discarded
34488 because it is aliased to &":blackhole:"& the log line is like this:
34489 .code
34490 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34491   <hole@nowhere.example> R=blackhole_router
34492 .endd
34493
34494
34495 .section "Deferred deliveries" "SECID254"
34496 When a delivery is deferred, a line of the following form is logged:
34497 .code
34498 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34499   R=dnslookup T=smtp defer (146): Connection refused
34500 .endd
34501 In the case of remote deliveries, the error is the one that was given for the
34502 last IP address that was tried. Details of individual SMTP failures are also
34503 written to the log, so the above line would be preceded by something like
34504 .code
34505 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34506   mail1.endrest.example [192.168.239.239]: Connection refused
34507 .endd
34508 When a deferred address is skipped because its retry time has not been reached,
34509 a message is written to the log, but this can be suppressed by setting an
34510 appropriate value in &%log_selector%&.
34511
34512
34513
34514 .section "Delivery failures" "SECID255"
34515 .cindex "delivery" "failure; logging"
34516 If a delivery fails because an address cannot be routed, a line of the
34517 following form is logged:
34518 .code
34519 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34520   <jim@trek99.example>: unknown mail domain
34521 .endd
34522 If a delivery fails at transport time, the router and transport are shown, and
34523 the response from the remote host is included, as in this example:
34524 .code
34525 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34526   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34527   after pipelined RCPT TO:<ace400@pb.example>: host
34528   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34529   <ace400@pb.example>...Addressee unknown
34530 .endd
34531 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34532 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34533 disabling PIPELINING. The log lines for all forms of delivery failure are
34534 flagged with &`**`&.
34535
34536
34537
34538 .section "Fake deliveries" "SECID256"
34539 .cindex "delivery" "fake; logging"
34540 If a delivery does not actually take place because the &%-N%& option has been
34541 used to suppress it, a normal delivery line is written to the log, except that
34542 &"=>"& is replaced by &"*>"&.
34543
34544
34545
34546 .section "Completion" "SECID257"
34547 A line of the form
34548 .code
34549 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34550 .endd
34551 is written to the main log when a message is about to be removed from the spool
34552 at the end of its processing.
34553
34554
34555
34556
34557 .section "Summary of Fields in Log Lines" "SECID258"
34558 .cindex "log" "summary of fields"
34559 A summary of the field identifiers that are used in log lines is shown in
34560 the following table:
34561 .display
34562 &`A   `&        authenticator name (and optional id and sender)
34563 &`C   `&        SMTP confirmation on delivery
34564 &`    `&        command list for &"no mail in SMTP session"&
34565 &`CV  `&        certificate verification status
34566 &`D   `&        duration of &"no mail in SMTP session"&
34567 &`DN  `&        distinguished name from peer certificate
34568 &`DT  `&        on &`=>`& lines: time taken for a delivery
34569 &`F   `&        sender address (on delivery lines)
34570 &`H   `&        host name and IP address
34571 &`I   `&        local interface used
34572 &`id  `&        message id for incoming message
34573 &`P   `&        on &`<=`& lines: protocol used
34574 &`    `&        on &`=>`& and &`**`& lines: return path
34575 &`QT  `&        on &`=>`& lines: time spent on queue so far
34576 &`    `&        on &"Completed"& lines: time spent on queue
34577 &`R   `&        on &`<=`& lines: reference for local bounce
34578 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34579 &`S   `&        size of message
34580 &`SNI `&        server name indication from TLS client hello
34581 &`ST  `&        shadow transport name
34582 &`T   `&        on &`<=`& lines: message subject (topic)
34583 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34584 &`U   `&        local user or RFC 1413 identity
34585 &`X   `&        TLS cipher suite
34586 .endd
34587
34588
34589 .section "Other log entries" "SECID259"
34590 Various other types of log entry are written from time to time. Most should be
34591 self-explanatory. Among the more common are:
34592
34593 .ilist
34594 .cindex "retry" "time not reached"
34595 &'retry time not reached'&&~&~An address previously suffered a temporary error
34596 during routing or local delivery, and the time to retry has not yet arrived.
34597 This message is not written to an individual message log file unless it happens
34598 during the first delivery attempt.
34599 .next
34600 &'retry time not reached for any host'&&~&~An address previously suffered
34601 temporary errors during remote delivery, and the retry time has not yet arrived
34602 for any of the hosts to which it is routed.
34603 .next
34604 .cindex "spool directory" "file locked"
34605 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34606 some other Exim process is already working on the message. This can be quite
34607 common if queue running processes are started at frequent intervals. The
34608 &'exiwhat'& utility script can be used to find out what Exim processes are
34609 doing.
34610 .next
34611 .cindex "error" "ignored"
34612 &'error ignored'&&~&~There are several circumstances that give rise to this
34613 message:
34614 .olist
34615 Exim failed to deliver a bounce message whose age was greater than
34616 &%ignore_bounce_errors_after%&. The bounce was discarded.
34617 .next
34618 A filter file set up a delivery using the &"noerror"& option, and the delivery
34619 failed. The delivery was discarded.
34620 .next
34621 A delivery set up by a router configured with
34622 . ==== As this is a nested list, any displays it contains must be indented
34623 . ==== as otherwise they are too far to the left.
34624 .code
34625     errors_to = <>
34626 .endd
34627 failed. The delivery was discarded.
34628 .endlist olist
34629 .endlist ilist
34630
34631
34632
34633
34634
34635 .section "Reducing or increasing what is logged" "SECTlogselector"
34636 .cindex "log" "selectors"
34637 By setting the &%log_selector%& global option, you can disable some of Exim's
34638 default logging, or you can request additional logging. The value of
34639 &%log_selector%& is made up of names preceded by plus or minus characters. For
34640 example:
34641 .code
34642 log_selector = +arguments -retry_defer
34643 .endd
34644 The list of optional log items is in the following table, with the default
34645 selection marked by asterisks:
34646 .display
34647 &` 8bitmime                   `&  received 8BITMIME status
34648 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34649 &` address_rewrite            `&  address rewriting
34650 &` all_parents                `&  all parents in => lines
34651 &` arguments                  `&  command line arguments
34652 &`*connection_reject          `&  connection rejections
34653 &`*delay_delivery             `&  immediate delivery delayed
34654 &` deliver_time               `&  time taken to perform delivery
34655 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34656 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34657 &`*etrn                       `&  ETRN commands
34658 &`*host_lookup_failed         `&  as it says
34659 &` ident_timeout              `&  timeout for ident connection
34660 &` incoming_interface         `&  incoming interface on <= lines
34661 &` incoming_port              `&  incoming port on <= lines
34662 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34663 &` outgoing_port              `&  add remote port to => lines
34664 &`*queue_run                  `&  start and end queue runs
34665 &` queue_time                 `&  time on queue for one recipient
34666 &` queue_time_overall         `&  time on queue for whole message
34667 &` pid                        `&  Exim process id
34668 &` received_recipients        `&  recipients on <= lines
34669 &` received_sender            `&  sender on <= lines
34670 &`*rejected_header            `&  header contents on reject log
34671 &`*retry_defer                `&  &"retry time not reached"&
34672 &` return_path_on_delivery    `&  put return path on => and ** lines
34673 &` sender_on_delivery         `&  add sender to => lines
34674 &`*sender_verify_fail         `&  sender verification failures
34675 &`*size_reject                `&  rejection because too big
34676 &`*skip_delivery              `&  delivery skipped in a queue run
34677 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34678 &` smtp_connection            `&  SMTP connections
34679 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34680 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34681 &` smtp_no_mail               `&  session with no MAIL commands
34682 &` smtp_protocol_error        `&  SMTP protocol errors
34683 &` smtp_syntax_error          `&  SMTP syntax errors
34684 &` subject                    `&  contents of &'Subject:'& on <= lines
34685 &` tls_certificate_verified   `&  certificate verification status
34686 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34687 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34688 &` tls_sni                    `&  TLS SNI on <= lines
34689 &` unknown_in_list            `&  DNS lookup failed in list match
34690
34691 &` all                        `&  all of the above
34692 .endd
34693 More details on each of these items follows:
34694
34695 .ilist
34696 .cindex "8BITMIME"
34697 .cindex "log" "8BITMIME"
34698 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34699 which may help in tracking down interoperability issues with ancient MTAs
34700 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34701 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34702 &`7BIT`& and &`8BITMIME`& respectively.
34703 .next
34704 .cindex "&%warn%& ACL verb" "log when skipping"
34705 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34706 its conditions cannot be evaluated, a log line to this effect is written if
34707 this log selector is set.
34708 .next
34709 .cindex "log" "rewriting"
34710 .cindex "rewriting" "logging"
34711 &%address_rewrite%&: This applies both to global rewrites and per-transport
34712 rewrites, but not to rewrites in filters run as an unprivileged user (because
34713 such users cannot access the log).
34714 .next
34715 .cindex "log" "full parentage"
34716 &%all_parents%&: Normally only the original and final addresses are logged on
34717 delivery lines; with this selector, intermediate parents are given in
34718 parentheses between them.
34719 .next
34720 .cindex "log" "Exim arguments"
34721 .cindex "Exim arguments, logging"
34722 &%arguments%&: This causes Exim to write the arguments with which it was called
34723 to the main log, preceded by the current working directory. This is a debugging
34724 feature, added to make it easier to find out how certain MUAs call
34725 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34726 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34727 that are empty or that contain white space are quoted. Non-printing characters
34728 are shown as escape sequences. This facility cannot log unrecognized arguments,
34729 because the arguments are checked before the configuration file is read. The
34730 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34731 between the caller and Exim.
34732 .next
34733 .cindex "log" "connection rejections"
34734 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34735 connection is rejected, for whatever reason.
34736 .next
34737 .cindex "log" "delayed delivery"
34738 .cindex "delayed delivery, logging"
34739 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34740 started for an incoming message because the load is too high or too many
34741 messages were received on one connection. Logging does not occur if no delivery
34742 process is started because &%queue_only%& is set or &%-odq%& was used.
34743 .next
34744 .cindex "log" "delivery duration"
34745 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34746 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34747 .next
34748 .cindex "log" "message size on delivery"
34749 .cindex "size" "of message"
34750 &%delivery_size%&: For each delivery, the size of message delivered is added to
34751 the &"=>"& line, tagged with S=.
34752 .next
34753 .cindex "log" "dnslist defer"
34754 .cindex "DNS list" "logging defer"
34755 .cindex "black list (DNS)"
34756 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34757 DNS black list suffers a temporary error.
34758 .next
34759 .cindex "log" "ETRN commands"
34760 .cindex "ETRN" "logging"
34761 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34762 is run to determine whether or not it is actually accepted. An invalid ETRN
34763 command, or one received within a message transaction is not logged by this
34764 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34765 .next
34766 .cindex "log" "host lookup failure"
34767 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34768 any addresses, or when a lookup of an IP address fails to find a host name, a
34769 log line is written. This logging does not apply to direct DNS lookups when
34770 routing email addresses, but it does apply to &"byname"& lookups.
34771 .next
34772 .cindex "log" "ident timeout"
34773 .cindex "RFC 1413" "logging timeout"
34774 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34775 client's ident port times out.
34776 .next
34777 .cindex "log" "incoming interface"
34778 .cindex "interface" "logging"
34779 &%incoming_interface%&: The interface on which a message was received is added
34780 to the &"<="& line as an IP address in square brackets, tagged by I= and
34781 followed by a colon and the port number. The local interface and port are also
34782 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34783 rejection lines.
34784 .next
34785 .cindex "log" "incoming remote port"
34786 .cindex "port" "logging remote"
34787 .cindex "TCP/IP" "logging incoming remote port"
34788 .vindex "&$sender_fullhost$&"
34789 .vindex "&$sender_rcvhost$&"
34790 &%incoming_port%&: The remote port number from which a message was received is
34791 added to log entries and &'Received:'& header lines, following the IP address
34792 in square brackets, and separated from it by a colon. This is implemented by
34793 changing the value that is put in the &$sender_fullhost$& and
34794 &$sender_rcvhost$& variables. Recording the remote port number has become more
34795 important with the widening use of NAT (see RFC 2505).
34796 .next
34797 .cindex "log" "dropped connection"
34798 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34799 connection is unexpectedly dropped.
34800 .next
34801 .cindex "log" "outgoing remote port"
34802 .cindex "port" "logging outgoint remote"
34803 .cindex "TCP/IP" "logging ougtoing remote port"
34804 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34805 containing => tags) following the IP address. This option is not included in
34806 the default setting, because for most ordinary configurations, the remote port
34807 number is always 25 (the SMTP port).
34808 .next
34809 .cindex "log" "process ids in"
34810 .cindex "pid (process id)" "in log lines"
34811 &%pid%&: The current process id is added to every log line, in square brackets,
34812 immediately after the time and date.
34813 .next
34814 .cindex "log" "queue run"
34815 .cindex "queue runner" "logging"
34816 &%queue_run%&: The start and end of every queue run are logged.
34817 .next
34818 .cindex "log" "queue time"
34819 &%queue_time%&: The amount of time the message has been in the queue on the
34820 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34821 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34822 includes reception time as well as the delivery time for the current address.
34823 This means that it may be longer than the difference between the arrival and
34824 delivery log line times, because the arrival log line is not written until the
34825 message has been successfully received.
34826 .next
34827 &%queue_time_overall%&: The amount of time the message has been in the queue on
34828 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34829 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34830 message, so it includes reception time as well as the total delivery time.
34831 .next
34832 .cindex "log" "recipients"
34833 &%received_recipients%&: The recipients of a message are listed in the main log
34834 as soon as the message is received. The list appears at the end of the log line
34835 that is written when a message is received, preceded by the word &"for"&. The
34836 addresses are listed after they have been qualified, but before any rewriting
34837 has taken place.
34838 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34839 in the list.
34840 .next
34841 .cindex "log" "sender reception"
34842 &%received_sender%&: The unrewritten original sender of a message is added to
34843 the end of the log line that records the message's arrival, after the word
34844 &"from"& (before the recipients if &%received_recipients%& is also set).
34845 .next
34846 .cindex "log" "header lines for rejection"
34847 &%rejected_header%&: If a message's header has been received at the time a
34848 rejection is written to the reject log, the complete header is added to the
34849 log. Header logging can be turned off individually for messages that are
34850 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34851 .next
34852 .cindex "log" "retry defer"
34853 &%retry_defer%&: A log line is written if a delivery is deferred because a
34854 retry time has not yet been reached. However, this &"retry time not reached"&
34855 message is always omitted from individual message logs after the first delivery
34856 attempt.
34857 .next
34858 .cindex "log" "return path"
34859 &%return_path_on_delivery%&: The return path that is being transmitted with
34860 the message is included in delivery and bounce lines, using the tag P=.
34861 This is omitted if no delivery actually happens, for example, if routing fails,
34862 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34863 .next
34864 .cindex "log" "sender on delivery"
34865 &%sender_on_delivery%&: The message's sender address is added to every delivery
34866 and bounce line, tagged by F= (for &"from"&).
34867 This is the original sender that was received with the message; it is not
34868 necessarily the same as the outgoing return path.
34869 .next
34870 .cindex "log" "sender verify failure"
34871 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34872 gives details of a sender verification failure is not written. Log lines for
34873 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34874 detail is lost.
34875 .next
34876 .cindex "log" "size rejection"
34877 &%size_reject%&: A log line is written whenever a message is rejected because
34878 it is too big.
34879 .next
34880 .cindex "log" "frozen messages; skipped"
34881 .cindex "frozen messages" "logging skipping"
34882 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34883 queue run because it is frozen or because another process is already delivering
34884 it.
34885 .cindex "&""spool file is locked""&"
34886 The message that is written is &"spool file is locked"&.
34887 .next
34888 .cindex "log" "smtp confirmation"
34889 .cindex "SMTP" "logging confirmation"
34890 .cindex "LMTP" "logging confirmation"
34891 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
34892 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34893 A number of MTAs (including Exim) return an identifying string in this
34894 response.
34895 .next
34896 .cindex "log" "SMTP connections"
34897 .cindex "SMTP" "logging connections"
34898 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34899 established or closed, unless the connection is from a host that matches
34900 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34901 only when the closure is unexpected.) This applies to connections from local
34902 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34903 dropped in the middle of a message, a log line is always written, whether or
34904 not this selector is set, but otherwise nothing is written at the start and end
34905 of connections unless this selector is enabled.
34906
34907 For TCP/IP connections to an Exim daemon, the current number of connections is
34908 included in the log message for each new connection, but note that the count is
34909 reset if the daemon is restarted.
34910 Also, because connections are closed (and the closure is logged) in
34911 subprocesses, the count may not include connections that have been closed but
34912 whose termination the daemon has not yet noticed. Thus, while it is possible to
34913 match up the opening and closing of connections in the log, the value of the
34914 logged counts may not be entirely accurate.
34915 .next
34916 .cindex "log" "SMTP transaction; incomplete"
34917 .cindex "SMTP" "logging incomplete transactions"
34918 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34919 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34920 and the message sender plus any accepted recipients are included in the log
34921 line. This can provide evidence of dictionary attacks.
34922 .next
34923 .cindex "log" "non-MAIL SMTP sessions"
34924 .cindex "MAIL" "logging session without"
34925 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34926 connection terminates without having issued a MAIL command. This includes both
34927 the case when the connection is dropped, and the case when QUIT is used. It
34928 does not include cases where the connection is rejected right at the start (by
34929 an ACL, or because there are too many connections, or whatever). These cases
34930 already have their own log lines.
34931
34932 The log line that is written contains the identity of the client in the usual
34933 way, followed by D= and a time, which records the duration of the connection.
34934 If the connection was authenticated, this fact is logged exactly as it is for
34935 an incoming message, with an A= item. If the connection was encrypted, CV=,
34936 DN=, and X= items may appear as they do for an incoming message, controlled by
34937 the same logging options.
34938
34939 Finally, if any SMTP commands were issued during the connection, a C= item
34940 is added to the line, listing the commands that were used. For example,
34941 .code
34942 C=EHLO,QUIT
34943 .endd
34944 shows that the client issued QUIT straight after EHLO. If there were fewer
34945 than 20 commands, they are all listed. If there were more than 20 commands,
34946 the last 20 are listed, preceded by &"..."&. However, with the default
34947 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34948 have been aborted before 20 non-mail commands are processed.
34949 .next
34950 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34951 colon-separated, is appended to the A= item for a message arrival or delivery
34952 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34953 was accepted or used.
34954 .next
34955 .cindex "log" "SMTP protocol error"
34956 .cindex "SMTP" "logging protocol error"
34957 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34958 encountered. Exim does not have perfect detection of all protocol errors
34959 because of transmission delays and the use of pipelining. If PIPELINING has
34960 been advertised to a client, an Exim server assumes that the client will use
34961 it, and therefore it does not count &"expected"& errors (for example, RCPT
34962 received after rejecting MAIL) as protocol errors.
34963 .next
34964 .cindex "SMTP" "logging syntax errors"
34965 .cindex "SMTP" "syntax errors; logging"
34966 .cindex "SMTP" "unknown command; logging"
34967 .cindex "log" "unknown SMTP command"
34968 .cindex "log" "SMTP syntax error"
34969 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34970 encountered. An unrecognized command is treated as a syntax error. For an
34971 external connection, the host identity is given; for an internal connection
34972 using &%-bs%& the sender identification (normally the calling user) is given.
34973 .next
34974 .cindex "log" "subject"
34975 .cindex "subject, logging"
34976 &%subject%&: The subject of the message is added to the arrival log line,
34977 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34978 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34979 specifies whether characters with values greater than 127 should be logged
34980 unchanged, or whether they should be rendered as escape sequences.
34981 .next
34982 .cindex "log" "certificate verification"
34983 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34984 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34985 verified, and &`CV=no`& if not.
34986 .next
34987 .cindex "log" "TLS cipher"
34988 .cindex "TLS" "logging cipher"
34989 &%tls_cipher%&: When a message is sent or received over an encrypted
34990 connection, the cipher suite used is added to the log line, preceded by X=.
34991 .next
34992 .cindex "log" "TLS peer DN"
34993 .cindex "TLS" "logging peer DN"
34994 &%tls_peerdn%&: When a message is sent or received over an encrypted
34995 connection, and a certificate is supplied by the remote host, the peer DN is
34996 added to the log line, preceded by DN=.
34997 .next
34998 .cindex "log" "TLS SNI"
34999 .cindex "TLS" "logging SNI"
35000 &%tls_sni%&: When a message is received over an encrypted connection, and
35001 the remote host provided the Server Name Indication extension, the SNI is
35002 added to the log line, preceded by SNI=.
35003 .next
35004 .cindex "log" "DNS failure in list"
35005 &%unknown_in_list%&: This setting causes a log entry to be written when the
35006 result of a list match is failure because a DNS lookup failed.
35007 .endlist
35008
35009
35010 .section "Message log" "SECID260"
35011 .cindex "message" "log file for"
35012 .cindex "log" "message log; description of"
35013 .cindex "&_msglog_& directory"
35014 .oindex "&%preserve_message_logs%&"
35015 In addition to the general log files, Exim writes a log file for each message
35016 that it handles. The names of these per-message logs are the message ids, and
35017 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35018 message log contains copies of the log lines that apply to the message. This
35019 makes it easier to inspect the status of an individual message without having
35020 to search the main log. A message log is deleted when processing of the message
35021 is complete, unless &%preserve_message_logs%& is set, but this should be used
35022 only with great care because they can fill up your disk very quickly.
35023
35024 On a heavily loaded system, it may be desirable to disable the use of
35025 per-message logs, in order to reduce disk I/O. This can be done by setting the
35026 &%message_logs%& option false.
35027 .ecindex IIDloggen
35028
35029
35030
35031
35032 . ////////////////////////////////////////////////////////////////////////////
35033 . ////////////////////////////////////////////////////////////////////////////
35034
35035 .chapter "Exim utilities" "CHAPutils"
35036 .scindex IIDutils "utilities"
35037 A number of utility scripts and programs are supplied with Exim and are
35038 described in this chapter. There is also the Exim Monitor, which is covered in
35039 the next chapter. The utilities described here are:
35040
35041 .itable none 0 0 3  7* left  15* left  40* left
35042 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35043   "list what Exim processes are doing"
35044 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35045 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35046 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35047 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35048                                                 various criteria"
35049 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35050 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35051   "extract statistics from the log"
35052 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35053   "check address acceptance from given IP"
35054 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35055 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35056 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35057 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35058 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35059 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35060 .endtable
35061
35062 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35063 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35064 &url(http://duncanthrax.net/exilog/) for details.
35065
35066
35067
35068
35069 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35070 .cindex "&'exiwhat'&"
35071 .cindex "process, querying"
35072 .cindex "SIGUSR1"
35073 On operating systems that can restart a system call after receiving a signal
35074 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35075 a line describing what it is doing to the file &_exim-process.info_& in the
35076 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35077 processes it can find, having first emptied the file. It then waits for one
35078 second to allow the Exim processes to react before displaying the results. In
35079 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35080 send the signal to the Exim processes, so it is normally run as root.
35081
35082 &*Warning*&: This is not an efficient process. It is intended for occasional
35083 use by system administrators. It is not sensible, for example, to set up a
35084 script that sends SIGUSR1 signals to Exim processes at short intervals.
35085
35086
35087 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35088 varies in different operating systems. Not only are different options used,
35089 but the format of the output is different. For this reason, there are some
35090 system configuration options that configure exactly how &'exiwhat'& works. If
35091 it doesn't seem to be working for you, check the following compile-time
35092 options:
35093 .display
35094 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35095 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35096 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35097 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35098 .endd
35099 An example of typical output from &'exiwhat'& is
35100 .code
35101 164 daemon: -q1h, listening on port 25
35102 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35103 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35104   [10.19.42.42] (editor@ref.example)
35105 10592 handling incoming call from [192.168.243.242]
35106 10628 accepting a local non-SMTP message
35107 .endd
35108 The first number in the output line is the process number. The third line has
35109 been split here, in order to fit it on the page.
35110
35111
35112
35113 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35114 .cindex "&'exiqgrep'&"
35115 .cindex "queue" "grepping"
35116 This utility is a Perl script contributed by Matt Hubbard. It runs
35117 .code
35118 exim -bpu
35119 .endd
35120 or (in case &*-a*& switch is specified)
35121 .code
35122 exim -bp
35123 .endd
35124 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35125 contain alternate exim configuration the queue management might be using.
35126
35127 to obtain a queue listing, and then greps the output to select messages 
35128 that match given criteria. The following selection options are available:
35129
35130 .vlist
35131 .vitem &*-f*&&~<&'regex'&>
35132 Match the sender address using a case-insensitive search. The field that is
35133 tested is enclosed in angle brackets, so you can test for bounce messages with
35134 .code
35135 exiqgrep -f '^<>$'
35136 .endd
35137 .vitem &*-r*&&~<&'regex'&>
35138 Match a recipient address using a case-insensitve search. The field that is
35139 tested is not enclosed in angle brackets.
35140
35141 .vitem &*-s*&&~<&'regex'&>
35142 Match against the size field.
35143
35144 .vitem &*-y*&&~<&'seconds'&>
35145 Match messages that are younger than the given time.
35146
35147 .vitem &*-o*&&~<&'seconds'&>
35148 Match messages that are older than the given time.
35149
35150 .vitem &*-z*&
35151 Match only frozen messages.
35152
35153 .vitem &*-x*&
35154 Match only non-frozen messages.
35155 .endlist
35156
35157 The following options control the format of the output:
35158
35159 .vlist
35160 .vitem &*-c*&
35161 Display only the count of matching messages.
35162
35163 .vitem &*-l*&
35164 Long format &-- display the full message information as output by Exim. This is
35165 the default.
35166
35167 .vitem &*-i*&
35168 Display message ids only.
35169
35170 .vitem &*-b*&
35171 Brief format &-- one line per message.
35172
35173 .vitem &*-R*&
35174 Display messages in reverse order.
35175
35176 .vitem &*-a*&
35177 Include delivered recipients in queue listing.
35178 .endlist
35179
35180 There is one more option, &%-h%&, which outputs a list of options.
35181
35182
35183
35184 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35185 .cindex "&'exiqsumm'&"
35186 .cindex "queue" "summary"
35187 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35188 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35189 running a command such as
35190 .code
35191 exim -bp | exiqsumm
35192 .endd
35193 The output consists of one line for each domain that has messages waiting for
35194 it, as in the following example:
35195 .code
35196 3   2322   74m   66m  msn.com.example
35197 .endd
35198 Each line lists the number of pending deliveries for a domain, their total
35199 volume, and the length of time that the oldest and the newest messages have
35200 been waiting. Note that the number of pending deliveries is greater than the
35201 number of messages when messages have more than one recipient.
35202
35203 A summary line is output at the end. By default the output is sorted on the
35204 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35205 the output to be sorted by oldest message and by count of messages,
35206 respectively. There are also three options that split the messages for each
35207 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35208 separates frozen messages, and &%-s%& separates messages according to their
35209 sender.
35210
35211 The output of &'exim -bp'& contains the original addresses in the message, so
35212 this also applies to the output from &'exiqsumm'&. No domains from addresses
35213 generated by aliasing or forwarding are included (unless the &%one_time%&
35214 option of the &(redirect)& router has been used to convert them into &"top
35215 level"& addresses).
35216
35217
35218
35219
35220 .section "Extracting specific information from the log (exigrep)" &&&
35221          "SECTextspeinf"
35222 .cindex "&'exigrep'&"
35223 .cindex "log" "extracts; grepping for"
35224 The &'exigrep'& utility is a Perl script that searches one or more main log
35225 files for entries that match a given pattern. When it finds a match, it
35226 extracts all the log entries for the relevant message, not just those that
35227 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35228 given message, or all mail for a given user, or for a given host, for example.
35229 The input files can be in Exim log format or syslog format.
35230 If a matching log line is not associated with a specific message, it is
35231 included in &'exigrep'&'s output without any additional lines. The usage is:
35232 .display
35233 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35234 .endd
35235 If no log file names are given on the command line, the standard input is read.
35236
35237 The &%-t%& argument specifies a number of seconds. It adds an additional
35238 condition for message selection. Messages that are complete are shown only if
35239 they spent more than <&'n'&> seconds on the queue.
35240
35241 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35242 makes it case-sensitive. This may give a performance improvement when searching
35243 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35244 option; with &%-I%& they do not. In both cases it is possible to change the
35245 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35246
35247 The &%-l%& option means &"literal"&, that is, treat all characters in the
35248 pattern as standing for themselves. Otherwise the pattern must be a Perl
35249 regular expression.
35250
35251 The &%-v%& option inverts the matching condition. That is, a line is selected
35252 if it does &'not'& match the pattern.
35253
35254 If the location of a &'zcat'& command is known from the definition of
35255 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35256 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35257
35258
35259 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35260 .cindex "&'exipick'&"
35261 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35262 lists messages from the queue according to a variety of criteria. For details
35263 of &'exipick'&'s facilities, visit the web page at
35264 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35265 the &%--help%& option.
35266
35267
35268 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35269 .cindex "log" "cycling local files"
35270 .cindex "cycling logs"
35271 .cindex "&'exicyclog'&"
35272 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35273 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35274 you are using log files with datestamps in their names (see section
35275 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35276 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35277 There are two command line options for &'exicyclog'&:
35278 .ilist
35279 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35280 default that is set when Exim is built. The default default is 10.
35281 .next
35282 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35283 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35284 overriding the script's default, which is to find the setting from Exim's
35285 configuration.
35286 .endlist
35287
35288 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35289 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35290 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35291 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35292 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35293 logs are handled similarly.
35294
35295 If the limit is greater than 99, the script uses 3-digit numbers such as
35296 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35297 to one that is greater, or &'vice versa'&, you will have to fix the names of
35298 any existing log files.
35299
35300 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35301 the end are deleted. All files with numbers greater than 01 are compressed,
35302 using a compression command which is configured by the COMPRESS_COMMAND
35303 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35304 root &%crontab%& entry of the form
35305 .code
35306 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35307 .endd
35308 assuming you have used the name &"exim"& for the Exim user. You can run
35309 &'exicyclog'& as root if you wish, but there is no need.
35310
35311
35312
35313 .section "Mail statistics (eximstats)" "SECTmailstat"
35314 .cindex "statistics"
35315 .cindex "&'eximstats'&"
35316 A Perl script called &'eximstats'& is provided for extracting statistical
35317 information from log files. The output is either plain text, or HTML.
35318 Exim log files are also supported by the &'Lire'& system produced by the
35319 LogReport Foundation &url(http://www.logreport.org).
35320
35321 The &'eximstats'& script has been hacked about quite a bit over time. The
35322 latest version is the result of some extensive revision by Steve Campbell. A
35323 lot of information is given by default, but there are options for suppressing
35324 various parts of it. Following any options, the arguments to the script are a
35325 list of files, which should be main log files. For example:
35326 .code
35327 eximstats -nr /var/spool/exim/log/mainlog.01
35328 .endd
35329 By default, &'eximstats'& extracts information about the number and volume of
35330 messages received from or delivered to various hosts. The information is sorted
35331 both by message count and by volume, and the top fifty hosts in each category
35332 are listed on the standard output. Similar information, based on email
35333 addresses or domains instead of hosts can be requested by means of various
35334 options. For messages delivered and received locally, similar statistics are
35335 also produced per user.
35336
35337 The output also includes total counts and statistics about delivery errors, and
35338 histograms showing the number of messages received and deliveries made in each
35339 hour of the day. A delivery with more than one address in its envelope (for
35340 example, an SMTP transaction with more than one RCPT command) is counted
35341 as a single delivery by &'eximstats'&.
35342
35343 Though normally more deliveries than receipts are reported (as messages may
35344 have multiple recipients), it is possible for &'eximstats'& to report more
35345 messages received than delivered, even though the queue is empty at the start
35346 and end of the period in question. If an incoming message contains no valid
35347 recipients, no deliveries are recorded for it. A bounce message is handled as
35348 an entirely separate message.
35349
35350 &'eximstats'& always outputs a grand total summary giving the volume and number
35351 of messages received and deliveries made, and the number of hosts involved in
35352 each case. It also outputs the number of messages that were delayed (that is,
35353 not completely delivered at the first attempt), and the number that had at
35354 least one address that failed.
35355
35356 The remainder of the output is in sections that can be independently disabled
35357 or modified by various options. It consists of a summary of deliveries by
35358 transport, histograms of messages received and delivered per time interval
35359 (default per hour), information about the time messages spent on the queue,
35360 a list of relayed messages, lists of the top fifty sending hosts, local
35361 senders, destination hosts, and destination local users by count and by volume,
35362 and a list of delivery errors that occurred.
35363
35364 The relay information lists messages that were actually relayed, that is, they
35365 came from a remote host and were directly delivered to some other remote host,
35366 without being processed (for example, for aliasing or forwarding) locally.
35367
35368 There are quite a few options for &'eximstats'& to control exactly what it
35369 outputs. These are documented in the Perl script itself, and can be extracted
35370 by running the command &(perldoc)& on the script. For example:
35371 .code
35372 perldoc /usr/exim/bin/eximstats
35373 .endd
35374
35375 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35376 .cindex "&'exim_checkaccess'&"
35377 .cindex "policy control" "checking access"
35378 .cindex "checking access"
35379 The &%-bh%& command line argument allows you to run a fake SMTP session with
35380 debugging output, in order to check what Exim is doing when it is applying
35381 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35382 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35383 sometimes you just want to answer the question &"Does this address have
35384 access?"& without bothering with any further details.
35385
35386 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35387 two arguments, an IP address and an email address:
35388 .code
35389 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35390 .endd
35391 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35392 given email address would be accepted in a RCPT command in a TCP/IP
35393 connection from the host with the given IP address. The output of the utility
35394 is either the word &"accepted"&, or the SMTP error response, for example:
35395 .code
35396 Rejected:
35397 550 Relay not permitted
35398 .endd
35399 When running this test, the utility uses &`<>`& as the envelope sender address
35400 for the MAIL command, but you can change this by providing additional
35401 options. These are passed directly to the Exim command. For example, to specify
35402 that the test is to be run with the sender address &'himself@there.example'&
35403 you can use:
35404 .code
35405 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35406                  -f himself@there.example
35407 .endd
35408 Note that these additional Exim command line items must be given after the two
35409 mandatory arguments.
35410
35411 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35412 while running its checks. You can run checks that include callouts by using
35413 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35414
35415
35416
35417 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35418 .cindex "DBM" "building dbm files"
35419 .cindex "building DBM files"
35420 .cindex "&'exim_dbmbuild'&"
35421 .cindex "lower casing"
35422 .cindex "binary zero" "in lookup key"
35423 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35424 the format used by the &(lsearch)& lookup (see section
35425 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35426 names as keys and the remainder of the information as data. The lower-casing
35427 can be prevented by calling the program with the &%-nolc%& option.
35428
35429 A terminating zero is included as part of the key string. This is expected by
35430 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35431 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35432 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35433 files.
35434
35435 The program requires two arguments: the name of the input file (which can be a
35436 single hyphen to indicate the standard input), and the name of the output file.
35437 It creates the output under a temporary name, and then renames it if all went
35438 well.
35439
35440 .cindex "USE_DB"
35441 If the native DB interface is in use (USE_DB is set in a compile-time
35442 configuration file &-- this is common in free versions of Unix) the two file
35443 names must be different, because in this mode the Berkeley DB functions create
35444 a single output file using exactly the name given. For example,
35445 .code
35446 exim_dbmbuild /etc/aliases /etc/aliases.db
35447 .endd
35448 reads the system alias file and creates a DBM version of it in
35449 &_/etc/aliases.db_&.
35450
35451 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35452 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35453 environment, the suffixes are added to the second argument of
35454 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35455 when the Berkeley functions are used in compatibility mode (though this is not
35456 recommended), because in that case it adds a &_.db_& suffix to the file name.
35457
35458 If a duplicate key is encountered, the program outputs a warning, and when it
35459 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35460 option is used. By default, only the first of a set of duplicates is used &--
35461 this makes it compatible with &(lsearch)& lookups. There is an option
35462 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35463 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35464 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35465 return code is 2.
35466
35467
35468
35469
35470 .section "Finding individual retry times (exinext)" "SECTfinindret"
35471 .cindex "retry" "times"
35472 .cindex "&'exinext'&"
35473 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35474 fish specific information out of the retry database. Given a mail domain (or a
35475 complete address), it looks up the hosts for that domain, and outputs any retry
35476 information for the hosts or for the domain. At present, the retry information
35477 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35478 output. For example:
35479 .code
35480 $ exinext piglet@milne.fict.example
35481 kanga.milne.example:192.168.8.1 error 146: Connection refused
35482   first failed: 21-Feb-1996 14:57:34
35483   last tried:   21-Feb-1996 14:57:34
35484   next try at:  21-Feb-1996 15:02:34
35485 roo.milne.example:192.168.8.3 error 146: Connection refused
35486   first failed: 20-Jan-1996 13:12:08
35487   last tried:   21-Feb-1996 11:42:03
35488   next try at:  21-Feb-1996 19:42:03
35489   past final cutoff time
35490 .endd
35491 You can also give &'exinext'& a local part, without a domain, and it
35492 will give any retry information for that local part in your default domain.
35493 A message id can be used to obtain retry information pertaining to a specific
35494 message. This exists only when an attempt to deliver a message to a remote host
35495 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35496 &'exinext'& is not particularly efficient, but then it is not expected to be
35497 run very often.
35498
35499 The &'exinext'& utility calls Exim to find out information such as the location
35500 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35501 passed on to the &'exim'& commands. The first specifies an alternate Exim
35502 configuration file, and the second sets macros for use within the configuration
35503 file. These features are mainly to help in testing, but might also be useful in
35504 environments where more than one configuration file is in use.
35505
35506
35507
35508 .section "Hints database maintenance" "SECThindatmai"
35509 .cindex "hints database" "maintenance"
35510 .cindex "maintaining Exim's hints database"
35511 Three utility programs are provided for maintaining the DBM files that Exim
35512 uses to contain its delivery hint information. Each program requires two
35513 arguments. The first specifies the name of Exim's spool directory, and the
35514 second is the name of the database it is to operate on. These are as follows:
35515
35516 .ilist
35517 &'retry'&: the database of retry information
35518 .next
35519 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35520 for remote hosts
35521 .next
35522 &'callout'&: the callout cache
35523 .next
35524 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35525 .next
35526 &'misc'&: other hints data
35527 .endlist
35528
35529 The &'misc'& database is used for
35530
35531 .ilist
35532 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35533 .next
35534 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35535 &(smtp)& transport)
35536 .endlist
35537
35538
35539
35540 .section "exim_dumpdb" "SECID261"
35541 .cindex "&'exim_dumpdb'&"
35542 The entire contents of a database are written to the standard output by the
35543 &'exim_dumpdb'& program, which has no options or arguments other than the
35544 spool and database names. For example, to dump the retry database:
35545 .code
35546 exim_dumpdb /var/spool/exim retry
35547 .endd
35548 Two lines of output are produced for each entry:
35549 .code
35550 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35551 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35552 .endd
35553 The first item on the first line is the key of the record. It starts with one
35554 of the letters R, or T, depending on whether it refers to a routing or
35555 transport retry. For a local delivery, the next part is the local address; for
35556 a remote delivery it is the name of the remote host, followed by its failing IP
35557 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35558 transport). If the remote port is not the standard one (port 25), it is added
35559 to the IP address. Then there follows an error code, an additional error code,
35560 and a textual description of the error.
35561
35562 The three times on the second line are the time of first failure, the time of
35563 the last delivery attempt, and the computed time for the next attempt. The line
35564 ends with an asterisk if the cutoff time for the last retry rule has been
35565 exceeded.
35566
35567 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35568 consists of a host name followed by a list of ids for messages that are or were
35569 waiting to be delivered to that host. If there are a very large number for any
35570 one host, continuation records, with a sequence number added to the host name,
35571 may be seen. The data in these records is often out of date, because a message
35572 may be routed to several alternative hosts, and Exim makes no effort to keep
35573 cross-references.
35574
35575
35576
35577 .section "exim_tidydb" "SECID262"
35578 .cindex "&'exim_tidydb'&"
35579 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35580 database. If run with no options, it removes all records that are more than 30
35581 days old. The age is calculated from the date and time that the record was last
35582 updated. Note that, in the case of the retry database, it is &'not'& the time
35583 since the first delivery failure. Information about a host that has been down
35584 for more than 30 days will remain in the database, provided that the record is
35585 updated sufficiently often.
35586
35587 The cutoff date can be altered by means of the &%-t%& option, which must be
35588 followed by a time. For example, to remove all records older than a week from
35589 the retry database:
35590 .code
35591 exim_tidydb -t 7d /var/spool/exim retry
35592 .endd
35593 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35594 message ids. In the former these appear as data in records keyed by host &--
35595 they were messages that were waiting for that host &-- and in the latter they
35596 are the keys for retry information for messages that have suffered certain
35597 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35598 message ids in database records are those of messages that are still on the
35599 queue. Message ids for messages that no longer exist are removed from
35600 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35601 For the &'retry'& database, records whose keys are non-existent message ids are
35602 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35603 whenever it removes information from the database.
35604
35605 Certain records are automatically removed by Exim when they are no longer
35606 needed, but others are not. For example, if all the MX hosts for a domain are
35607 down, a retry record is created for each one. If the primary MX host comes back
35608 first, its record is removed when Exim successfully delivers to it, but the
35609 records for the others remain because Exim has not tried to use those hosts.
35610
35611 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35612 hints databases. You should do this at a quiet time of day, because it requires
35613 a database to be locked (and therefore inaccessible to Exim) while it does its
35614 work. Removing records from a DBM file does not normally make the file smaller,
35615 but all the common DBM libraries are able to re-use the space that is released.
35616 After an initial phase of increasing in size, the databases normally reach a
35617 point at which they no longer get any bigger, as long as they are regularly
35618 tidied.
35619
35620 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35621 databases is likely to keep on increasing.
35622
35623
35624
35625
35626 .section "exim_fixdb" "SECID263"
35627 .cindex "&'exim_fixdb'&"
35628 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35629 Its main use is for testing Exim, but it might also be occasionally useful for
35630 getting round problems in a live system. It has no options, and its interface
35631 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35632 key of a database record can then be entered, and the data for that record is
35633 displayed.
35634
35635 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35636 except the &'retry'& database, that is the only operation that can be carried
35637 out. For the &'retry'& database, each field is output preceded by a number, and
35638 data for individual fields can be changed by typing the field number followed
35639 by new data, for example:
35640 .code
35641 > 4 951102:1000
35642 .endd
35643 resets the time of the next delivery attempt. Time values are given as a
35644 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35645 used as optional separators.
35646
35647
35648
35649
35650 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35651 .cindex "mailbox" "maintenance"
35652 .cindex "&'exim_lock'&"
35653 .cindex "locking mailboxes"
35654 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35655 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35656 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35657 a user agent while investigating a problem. The utility requires the name of
35658 the file as its first argument. If the locking is successful, the second
35659 argument is run as a command (using C's &[system()]& function); if there is no
35660 second argument, the value of the SHELL environment variable is used; if this
35661 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35662 is unlocked and the utility ends. The following options are available:
35663
35664 .vlist
35665 .vitem &%-fcntl%&
35666 Use &[fcntl()]& locking on the open mailbox.
35667
35668 .vitem &%-flock%&
35669 Use &[flock()]& locking on the open mailbox, provided the operating system
35670 supports it.
35671
35672 .vitem &%-interval%&
35673 This must be followed by a number, which is a number of seconds; it sets the
35674 interval to sleep between retries (default 3).
35675
35676 .vitem &%-lockfile%&
35677 Create a lock file before opening the mailbox.
35678
35679 .vitem &%-mbx%&
35680 Lock the mailbox using MBX rules.
35681
35682 .vitem &%-q%&
35683 Suppress verification output.
35684
35685 .vitem &%-retries%&
35686 This must be followed by a number; it sets the number of times to try to get
35687 the lock (default 10).
35688
35689 .vitem &%-restore_time%&
35690 This option causes &%exim_lock%& to restore the modified and read times to the
35691 locked file before exiting. This allows you to access a locked mailbox (for
35692 example, to take a backup copy) without disturbing the times that the user
35693 subsequently sees.
35694
35695 .vitem &%-timeout%&
35696 This must be followed by a number, which is a number of seconds; it sets a
35697 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35698 default), a non-blocking call is used.
35699
35700 .vitem &%-v%&
35701 Generate verbose output.
35702 .endlist
35703
35704 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35705 default is to create a lock file and also to use &[fcntl()]& locking on the
35706 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35707 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35708 requires that the directory containing the file be writeable. Locking by lock
35709 file does not last for ever; Exim assumes that a lock file is expired if it is
35710 more than 30 minutes old.
35711
35712 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35713 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35714 to be taken out on the open mailbox, and an exclusive lock on the file
35715 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35716 number of the mailbox file. When the locking is released, if an exclusive lock
35717 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35718
35719 The default output contains verification of the locking that takes place. The
35720 &%-v%& option causes some additional information to be given. The &%-q%& option
35721 suppresses all output except error messages.
35722
35723 A command such as
35724 .code
35725 exim_lock /var/spool/mail/spqr
35726 .endd
35727 runs an interactive shell while the file is locked, whereas
35728 .display
35729 &`exim_lock -q /var/spool/mail/spqr <<End`&
35730 <&'some commands'&>
35731 &`End`&
35732 .endd
35733 runs a specific non-interactive sequence of commands while the file is locked,
35734 suppressing all verification output. A single command can be run by a command
35735 such as
35736 .code
35737 exim_lock -q /var/spool/mail/spqr \
35738   "cp /var/spool/mail/spqr /some/where"
35739 .endd
35740 Note that if a command is supplied, it must be entirely contained within the
35741 second argument &-- hence the quotes.
35742 .ecindex IIDutils
35743
35744
35745 . ////////////////////////////////////////////////////////////////////////////
35746 . ////////////////////////////////////////////////////////////////////////////
35747
35748 .chapter "The Exim monitor" "CHAPeximon"
35749 .scindex IIDeximon "Exim monitor" "description"
35750 .cindex "X-windows"
35751 .cindex "&'eximon'&"
35752 .cindex "Local/eximon.conf"
35753 .cindex "&_exim_monitor/EDITME_&"
35754 The Exim monitor is an application which displays in an X window information
35755 about the state of Exim's queue and what Exim is doing. An admin user can
35756 perform certain operations on messages from this GUI interface; however all
35757 such facilities are also available from the command line, and indeed, the
35758 monitor itself makes use of the command line to perform any actions requested.
35759
35760
35761
35762 .section "Running the monitor" "SECID264"
35763 The monitor is started by running the script called &'eximon'&. This is a shell
35764 script that sets up a number of environment variables, and then runs the
35765 binary called &_eximon.bin_&. The default appearance of the monitor window can
35766 be changed by editing the &_Local/eximon.conf_& file created by editing
35767 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35768 parameters are for.
35769
35770 The parameters that get built into the &'eximon'& script can be overridden for
35771 a particular invocation by setting up environment variables of the same names,
35772 preceded by &`EXIMON_`&. For example, a shell command such as
35773 .code
35774 EXIMON_LOG_DEPTH=400 eximon
35775 .endd
35776 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35777 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35778 overrides the Exim log file configuration. This makes it possible to have
35779 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35780 syslog messages are routed to a file on the local host.
35781
35782 X resources can be used to change the appearance of the window in the normal
35783 way. For example, a resource setting of the form
35784 .code
35785 Eximon*background: gray94
35786 .endd
35787 changes the colour of the background to light grey rather than white. The
35788 stripcharts are drawn with both the data lines and the reference lines in
35789 black. This means that the reference lines are not visible when on top of the
35790 data. However, their colour can be changed by setting a resource called
35791 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35792 For example, if your X server is running Unix, you could set up lighter
35793 reference lines in the stripcharts by obeying
35794 .code
35795 xrdb -merge <<End
35796 Eximon*highlight: gray
35797 End
35798 .endd
35799 .cindex "admin user"
35800 In order to see the contents of messages on the queue, and to operate on them,
35801 &'eximon'& must either be run as root or by an admin user.
35802
35803 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35804 contain X11 resource parameters interpreted by the X11 library.  In addition,
35805 if the first parameter starts with the string "gdb" then it is removed and the
35806 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35807 versioned variants of gdb can be invoked).
35808
35809 The monitor's window is divided into three parts. The first contains one or
35810 more stripcharts and two action buttons, the second contains a &"tail"& of the
35811 main log file, and the third is a display of the queue of messages awaiting
35812 delivery, with two more action buttons. The following sections describe these
35813 different parts of the display.
35814
35815
35816
35817
35818 .section "The stripcharts" "SECID265"
35819 .cindex "stripchart"
35820 The first stripchart is always a count of messages on the queue. Its name can
35821 be configured by setting QUEUE_STRIPCHART_NAME in the
35822 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35823 configuration script by regular expression matches on log file entries, making
35824 it possible to display, for example, counts of messages delivered to certain
35825 hosts or using certain transports. The supplied defaults display counts of
35826 received and delivered messages, and of local and SMTP deliveries. The default
35827 period between stripchart updates is one minute; this can be adjusted by a
35828 parameter in the &_Local/eximon.conf_& file.
35829
35830 The stripchart displays rescale themselves automatically as the value they are
35831 displaying changes. There are always 10 horizontal lines in each chart; the
35832 title string indicates the value of each division when it is greater than one.
35833 For example, &"x2"& means that each division represents a value of 2.
35834
35835 It is also possible to have a stripchart which shows the percentage fullness of
35836 a particular disk partition, which is useful when local deliveries are confined
35837 to a single partition.
35838
35839 .cindex "&%statvfs%& function"
35840 This relies on the availability of the &[statvfs()]& function or equivalent in
35841 the operating system. Most, but not all versions of Unix that support Exim have
35842 this. For this particular stripchart, the top of the chart always represents
35843 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35844 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35845 &_Local/eximon.conf_& file.
35846
35847
35848
35849
35850 .section "Main action buttons" "SECID266"
35851 .cindex "size" "of monitor window"
35852 .cindex "Exim monitor" "window size"
35853 .cindex "window size"
35854 Below the stripcharts there is an action button for quitting the monitor. Next
35855 to this is another button marked &"Size"&. They are placed here so that
35856 shrinking the window to its default minimum size leaves just the queue count
35857 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35858 the window to expand to its maximum size, unless it is already at the maximum,
35859 in which case it is reduced to its minimum.
35860
35861 When expanding to the maximum, if the window cannot be fully seen where it
35862 currently is, it is moved back to where it was the last time it was at full
35863 size. When it is expanding from its minimum size, the old position is
35864 remembered, and next time it is reduced to the minimum it is moved back there.
35865
35866 The idea is that you can keep a reduced window just showing one or two
35867 stripcharts at a convenient place on your screen, easily expand it to show
35868 the full window when required, and just as easily put it back to what it was.
35869 The idea is copied from what the &'twm'& window manager does for its
35870 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35871 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35872
35873 Normally, the monitor starts up with the window at its full size, but it can be
35874 built so that it starts up with the window at its smallest size, by setting
35875 START_SMALL=yes in &_Local/eximon.conf_&.
35876
35877
35878
35879 .section "The log display" "SECID267"
35880 .cindex "log" "tail of; in monitor"
35881 The second section of the window is an area in which a display of the tail of
35882 the main log is maintained.
35883 To save space on the screen, the timestamp on each log line is shortened by
35884 removing the date and, if &%log_timezone%& is set, the timezone.
35885 The log tail is not available when the only destination for logging data is
35886 syslog, unless the syslog lines are routed to a local file whose name is passed
35887 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35888
35889 The log sub-window has a scroll bar at its lefthand side which can be used to
35890 move back to look at earlier text, and the up and down arrow keys also have a
35891 scrolling effect. The amount of log that is kept depends on the setting of
35892 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35893 to use. When this is full, the earlier 50% of data is discarded &-- this is
35894 much more efficient than throwing it away line by line. The sub-window also has
35895 a horizontal scroll bar for accessing the ends of long log lines. This is the
35896 only means of horizontal scrolling; the right and left arrow keys are not
35897 available. Text can be cut from this part of the window using the mouse in the
35898 normal way. The size of this subwindow is controlled by parameters in the
35899 configuration file &_Local/eximon.conf_&.
35900
35901 Searches of the text in the log window can be carried out by means of the ^R
35902 and ^S keystrokes, which default to a reverse and a forward search,
35903 respectively. The search covers only the text that is displayed in the window.
35904 It cannot go further back up the log.
35905
35906 The point from which the search starts is indicated by a caret marker. This is
35907 normally at the end of the text in the window, but can be positioned explicitly
35908 by pointing and clicking with the left mouse button, and is moved automatically
35909 by a successful search. If new text arrives in the window when it is scrolled
35910 back, the caret remains where it is, but if the window is not scrolled back,
35911 the caret is moved to the end of the new text.
35912
35913 Pressing ^R or ^S pops up a window into which the search text can be typed.
35914 There are buttons for selecting forward or reverse searching, for carrying out
35915 the search, and for cancelling. If the &"Search"& button is pressed, the search
35916 happens and the window remains so that further searches can be done. If the
35917 &"Return"& key is pressed, a single search is done and the window is closed. If
35918 ^C is typed the search is cancelled.
35919
35920 The searching facility is implemented using the facilities of the Athena text
35921 widget. By default this pops up a window containing both &"search"& and
35922 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35923 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35924 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35925 provided version of &%TextPop%& when the remaining parts of the text widget
35926 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35927 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35928 on these systems, at the expense of having unwanted items in the search popup
35929 window.
35930
35931
35932
35933 .section "The queue display" "SECID268"
35934 .cindex "queue" "display in monitor"
35935 The bottom section of the monitor window contains a list of all messages that
35936 are on the queue, which includes those currently being received or delivered,
35937 as well as those awaiting delivery. The size of this subwindow is controlled by
35938 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35939 at which it is updated is controlled by another parameter in the same file &--
35940 the default is 5 minutes, since queue scans can be quite expensive. However,
35941 there is an &"Update"& action button just above the display which can be used
35942 to force an update of the queue display at any time.
35943
35944 When a host is down for some time, a lot of pending mail can build up for it,
35945 and this can make it hard to deal with other messages on the queue. To help
35946 with this situation there is a button next to &"Update"& called &"Hide"&. If
35947 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35948 type anything in here and press &"Return"&, the text is added to a chain of
35949 such texts, and if every undelivered address in a message matches at least one
35950 of the texts, the message is not displayed.
35951
35952 If there is an address that does not match any of the texts, all the addresses
35953 are displayed as normal. The matching happens on the ends of addresses so, for
35954 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35955 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35956 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35957 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35958 a hide request is automatically cancelled after one hour.
35959
35960 While the dialogue box is displayed, you can't press any buttons or do anything
35961 else to the monitor window. For this reason, if you want to cut text from the
35962 queue display to use in the dialogue box, you have to do the cutting before
35963 pressing the &"Hide"& button.
35964
35965 The queue display contains, for each unhidden queued message, the length of
35966 time it has been on the queue, the size of the message, the message id, the
35967 message sender, and the first undelivered recipient, all on one line. If it is
35968 a bounce message, the sender is shown as &"<>"&. If there is more than one
35969 recipient to which the message has not yet been delivered, subsequent ones are
35970 listed on additional lines, up to a maximum configured number, following which
35971 an ellipsis is displayed. Recipients that have already received the message are
35972 not shown.
35973
35974 .cindex "frozen messages" "display"
35975 If a message is frozen, an asterisk is displayed at the left-hand side.
35976
35977 The queue display has a vertical scroll bar, and can also be scrolled by means
35978 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35979 The text searching facilities, as described above for the log window, are also
35980 available, but the caret is always moved to the end of the text when the queue
35981 display is updated.
35982
35983
35984
35985 .section "The queue menu" "SECID269"
35986 .cindex "queue" "menu in monitor"
35987 If the &%shift%& key is held down and the left button is clicked when the mouse
35988 pointer is over the text for any message, an action menu pops up, and the first
35989 line of the queue display for the message is highlighted. This does not affect
35990 any selected text.
35991
35992 If you want to use some other event for popping up the menu, you can set the
35993 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35994 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35995 value set in this parameter is a standard X event description. For example, to
35996 run eximon using &%ctrl%& rather than &%shift%& you could use
35997 .code
35998 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35999 .endd
36000 The title of the menu is the message id, and it contains entries which act as
36001 follows:
36002
36003 .ilist
36004 &'message log'&: The contents of the message log for the message are displayed
36005 in a new text window.
36006 .next
36007 &'headers'&: Information from the spool file that contains the envelope
36008 information and headers is displayed in a new text window. See chapter
36009 &<<CHAPspool>>& for a description of the format of spool files.
36010 .next
36011 &'body'&: The contents of the spool file containing the body of the message are
36012 displayed in a new text window. There is a default limit of 20,000 bytes to the
36013 amount of data displayed. This can be changed by setting the BODY_MAX
36014 option at compile time, or the EXIMON_BODY_MAX option at run time.
36015 .next
36016 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36017 delivery of the message. This causes an automatic thaw if the message is
36018 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36019 a new text window. The delivery is run in a separate process, to avoid holding
36020 up the monitor while the delivery proceeds.
36021 .next
36022 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36023 that the message be frozen.
36024 .next
36025 .cindex "thawing messages"
36026 .cindex "unfreezing messages"
36027 .cindex "frozen messages" "thawing"
36028 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36029 that the message be thawed.
36030 .next
36031 .cindex "delivery" "forcing failure"
36032 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36033 that Exim gives up trying to deliver the message. A bounce message is generated
36034 for any remaining undelivered addresses.
36035 .next
36036 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36037 that the message be deleted from the system without generating a bounce
36038 message.
36039 .next
36040 &'add recipient'&: A dialog box is displayed into which a recipient address can
36041 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36042 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36043 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36044 causes a call to Exim to be made using the &%-Mar%& option to request that an
36045 additional recipient be added to the message, unless the entry box is empty, in
36046 which case no action is taken.
36047 .next
36048 &'mark delivered'&: A dialog box is displayed into which a recipient address
36049 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36050 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36051 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36052 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36053 recipient address as already delivered, unless the entry box is empty, in which
36054 case no action is taken.
36055 .next
36056 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36057 mark all recipient addresses as already delivered.
36058 .next
36059 &'edit sender'&: A dialog box is displayed initialized with the current
36060 sender's address. Pressing RETURN causes a call to Exim to be made using the
36061 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36062 in which case no action is taken. If you want to set an empty sender (as in
36063 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36064 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36065 the address is qualified with that domain.
36066 .endlist
36067
36068 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36069 other cases when a call to Exim is made, if there is any output from Exim (in
36070 particular, if the command fails) a window containing the command and the
36071 output is displayed. Otherwise, the results of the action are normally apparent
36072 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36073 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36074 if no output is generated.
36075
36076 The queue display is automatically updated for actions such as freezing and
36077 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36078 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36079 force an update of the display after one of these actions.
36080
36081 In any text window that is displayed as result of a menu action, the normal
36082 cut-and-paste facility is available, and searching can be carried out using ^R
36083 and ^S, as described above for the log tail window.
36084 .ecindex IIDeximon
36085
36086
36087
36088
36089
36090 . ////////////////////////////////////////////////////////////////////////////
36091 . ////////////////////////////////////////////////////////////////////////////
36092
36093 .chapter "Security considerations" "CHAPsecurity"
36094 .scindex IIDsecurcon "security" "discussion of"
36095 This chapter discusses a number of issues concerned with security, some of
36096 which are also covered in other parts of this manual.
36097
36098 For reasons that this author does not understand, some people have promoted
36099 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36100 existence of this chapter in the documentation. However, the intent of the
36101 chapter is simply to describe the way Exim works in relation to certain
36102 security concerns, not to make any specific claims about the effectiveness of
36103 its security as compared with other MTAs.
36104
36105 What follows is a description of the way Exim is supposed to be. Best efforts
36106 have been made to try to ensure that the code agrees with the theory, but an
36107 absence of bugs can never be guaranteed. Any that are reported will get fixed
36108 as soon as possible.
36109
36110
36111 .section "Building a more &""hardened""& Exim" "SECID286"
36112 .cindex "security" "build-time features"
36113 There are a number of build-time options that can be set in &_Local/Makefile_&
36114 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36115 Exim administrator who does not have the root password, or by someone who has
36116 penetrated the Exim (but not the root) account. These options are as follows:
36117
36118 .ilist
36119 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36120 start of any file names used with the &%-C%& option. When it is set, these file
36121 names are also not allowed to contain the sequence &"/../"&. (However, if the
36122 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36123 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36124 default setting for &%ALT_CONFIG_PREFIX%&.
36125
36126 If the permitted configuration files are confined to a directory to
36127 which only root has access, this guards against someone who has broken
36128 into the Exim account from running a privileged Exim with an arbitrary
36129 configuration file, and using it to break into other accounts.
36130 .next
36131
36132 If a non-trusted configuration file (i.e. not the default configuration file
36133 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36134 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36135 the next item), then root privilege is retained only if the caller of Exim is
36136 root. This locks out the possibility of testing a configuration using &%-C%&
36137 right through message reception and delivery, even if the caller is root. The
36138 reception works, but by that time, Exim is running as the Exim user, so when
36139 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36140 privilege to be lost. However, root can test reception and delivery using two
36141 separate commands.
36142
36143 .next
36144 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36145 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36146 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36147 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36148 the restrictive side.  Requiring build-time selection of safe macros is onerous
36149 but this option is intended solely as a transition mechanism to permit
36150 previously-working configurations to continue to work after release 4.73.
36151 .next
36152 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36153 is disabled.
36154 .next
36155 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36156 never to be used for any deliveries. This is like the &%never_users%& runtime
36157 option, but it cannot be overridden; the runtime option adds additional users
36158 to the list. The default setting is &"root"&; this prevents a non-root user who
36159 is permitted to modify the runtime file from using Exim as a way to get root.
36160 .endlist
36161
36162
36163
36164 .section "Root privilege" "SECID270"
36165 .cindex "setuid"
36166 .cindex "root privilege"
36167 The Exim binary is normally setuid to root, which means that it gains root
36168 privilege (runs as root) when it starts execution. In some special cases (for
36169 example, when the daemon is not in use and there are no local deliveries), it
36170 may be possible to run Exim setuid to some user other than root. This is
36171 discussed in the next section. However, in most installations, root privilege
36172 is required for two things:
36173
36174 .ilist
36175 To set up a socket connected to the standard SMTP port (25) when initialising
36176 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36177 not required.
36178 .next
36179 To be able to change uid and gid in order to read users' &_.forward_& files and
36180 perform local deliveries as the receiving user or as specified in the
36181 configuration.
36182 .endlist
36183
36184 It is not necessary to be root to do any of the other things Exim does, such as
36185 receiving messages and delivering them externally over SMTP, and it is
36186 obviously more secure if Exim does not run as root except when necessary.
36187 For this reason, a user and group for Exim to use must be defined in
36188 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36189 group"&. Their values can be changed by the run time configuration, though this
36190 is not recommended. Often a user called &'exim'& is used, but some sites use
36191 &'mail'& or another user name altogether.
36192
36193 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36194 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36195 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36196
36197 After a new Exim process has interpreted its command line options, it changes
36198 uid and gid in the following cases:
36199
36200 .ilist
36201 .oindex "&%-C%&"
36202 .oindex "&%-D%&"
36203 If the &%-C%& option is used to specify an alternate configuration file, or if
36204 the &%-D%& option is used to define macro values for the configuration, and the
36205 calling process is not running as root, the uid and gid are changed to those of
36206 the calling process.
36207 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36208 option may not be used at all.
36209 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36210 can be supplied if the calling process is running as root, the Exim run-time
36211 user or CONFIGURE_OWNER, if defined.
36212 .next
36213 .oindex "&%-be%&"
36214 .oindex "&%-bf%&"
36215 .oindex "&%-bF%&"
36216 If the expansion test option (&%-be%&) or one of the filter testing options
36217 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36218 calling process.
36219 .next
36220 If the process is not a daemon process or a queue runner process or a delivery
36221 process or a process for testing address routing (started with &%-bt%&), the
36222 uid and gid are changed to the Exim user and group. This means that Exim always
36223 runs under its own uid and gid when receiving messages. This also applies when
36224 testing address verification
36225 .oindex "&%-bv%&"
36226 .oindex "&%-bh%&"
36227 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36228 option).
36229 .next
36230 For a daemon, queue runner, delivery, or address testing process, the uid
36231 remains as root at this stage, but the gid is changed to the Exim group.
36232 .endlist
36233
36234 The processes that initially retain root privilege behave as follows:
36235
36236 .ilist
36237 A daemon process changes the gid to the Exim group and the uid to the Exim
36238 user after setting up one or more listening sockets. The &[initgroups()]&
36239 function is called, so that if the Exim user is in any additional groups, they
36240 will be used during message reception.
36241 .next
36242 A queue runner process retains root privilege throughout its execution. Its
36243 job is to fork a controlled sequence of delivery processes.
36244 .next
36245 A delivery process retains root privilege throughout most of its execution,
36246 but any actual deliveries (that is, the transports themselves) are run in
36247 subprocesses which always change to a non-root uid and gid. For local
36248 deliveries this is typically the uid and gid of the owner of the mailbox; for
36249 remote deliveries, the Exim uid and gid are used. Once all the delivery
36250 subprocesses have been run, a delivery process changes to the Exim uid and gid
36251 while doing post-delivery tidying up such as updating the retry database and
36252 generating bounce and warning messages.
36253
36254 While the recipient addresses in a message are being routed, the delivery
36255 process runs as root. However, if a user's filter file has to be processed,
36256 this is done in a subprocess that runs under the individual user's uid and
36257 gid. A system filter is run as root unless &%system_filter_user%& is set.
36258 .next
36259 A process that is testing addresses (the &%-bt%& option) runs as root so that
36260 the routing is done in the same environment as a message delivery.
36261 .endlist
36262
36263
36264
36265
36266 .section "Running Exim without privilege" "SECTrunexiwitpri"
36267 .cindex "privilege, running without"
36268 .cindex "unprivileged running"
36269 .cindex "root privilege" "running without"
36270 Some installations like to run Exim in an unprivileged state for more of its
36271 operation, for added security. Support for this mode of operation is provided
36272 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36273 gid are changed to the Exim user and group at the start of a delivery process
36274 (and also queue runner and address testing processes). This means that address
36275 routing is no longer run as root, and the deliveries themselves cannot change
36276 to any other uid.
36277
36278 .cindex SIGHUP
36279 .cindex "daemon" "restarting"
36280 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36281 that the daemon can still be started in the usual way, and it can respond
36282 correctly to SIGHUP because the re-invocation regains root privilege.
36283
36284 An alternative approach is to make Exim setuid to the Exim user and also setgid
36285 to the Exim group. If you do this, the daemon must be started from a root
36286 process. (Calling Exim from a root process makes it behave in the way it does
36287 when it is setuid root.) However, the daemon cannot restart itself after a
36288 SIGHUP signal because it cannot regain privilege.
36289
36290 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36291 stops Exim from trying to re-invoke itself to do a delivery after a message has
36292 been received. Such a re-invocation is a waste of resources because it has no
36293 effect.
36294
36295 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36296 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36297 to the Exim user seems a clean approach, but there is one complication:
36298
36299 In this style of operation, Exim is running with the real uid and gid set to
36300 those of the calling process, and the effective uid/gid set to Exim's values.
36301 Ideally, any association with the calling process' uid/gid should be dropped,
36302 that is, the real uid/gid should be reset to the effective values so as to
36303 discard any privileges that the caller may have. While some operating systems
36304 have a function that permits this action for a non-root effective uid, quite a
36305 number of them do not. Because of this lack of standardization, Exim does not
36306 address this problem at this time.
36307
36308 For this reason, the recommended approach for &"mostly unprivileged"& running
36309 is to keep the Exim binary setuid to root, and to set
36310 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36311 be used in the most straightforward way.
36312
36313 If you configure Exim not to run delivery processes as root, there are a
36314 number of restrictions on what you can do:
36315
36316 .ilist
36317 You can deliver only as the Exim user/group. You should  explicitly use the
36318 &%user%& and &%group%& options to override routers or local transports that
36319 normally deliver as the recipient. This makes sure that configurations that
36320 work in this mode function the same way in normal mode. Any implicit or
36321 explicit specification of another user causes an error.
36322 .next
36323 Use of &_.forward_& files is severely restricted, such that it is usually
36324 not worthwhile to include them in the configuration.
36325 .next
36326 Users who wish to use &_.forward_& would have to make their home directory and
36327 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36328 and their equivalents in Exim filters, cannot be used. While they could be
36329 enabled in the Exim user's name, that would be insecure and not very useful.
36330 .next
36331 Unless the local user mailboxes are all owned by the Exim user (possible in
36332 some POP3 or IMAP-only environments):
36333
36334 .olist
36335 They must be owned by the Exim group and be writeable by that group. This
36336 implies you must set &%mode%& in the appendfile configuration, as well as the
36337 mode of the mailbox files themselves.
36338 .next
36339 You must set &%no_check_owner%&, since most or all of the files will not be
36340 owned by the Exim user.
36341 .next
36342 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36343 on a newly created mailbox when unprivileged. This also implies that new
36344 mailboxes need to be created manually.
36345 .endlist olist
36346 .endlist ilist
36347
36348
36349 These restrictions severely restrict what can be done in local deliveries.
36350 However, there are no restrictions on remote deliveries. If you are running a
36351 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36352 gives more security at essentially no cost.
36353
36354 If you are using the &%mua_wrapper%& facility (see chapter
36355 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36356
36357
36358
36359
36360 .section "Delivering to local files" "SECID271"
36361 Full details of the checks applied by &(appendfile)& before it writes to a file
36362 are given in chapter &<<CHAPappendfile>>&.
36363
36364
36365
36366 .section "Running local commands" "SECTsecconslocalcmds"
36367 .cindex "security" "local commands"
36368 .cindex "security" "command injection attacks"
36369 There are a number of ways in which an administrator can configure Exim to run
36370 commands based upon received, untrustworthy, data. Further, in some
36371 configurations a user who can control a &_.forward_& file can also arrange to
36372 run commands. Configuration to check includes, but is not limited to:
36373
36374 .ilist
36375 Use of &%use_shell%& in the pipe transport: various forms of shell command
36376 injection may be possible with this option present. It is dangerous and should
36377 be used only with considerable caution. Consider constraints which whitelist
36378 allowed characters in a variable which is to be used in a pipe transport that
36379 has &%use_shell%& enabled.
36380 .next
36381 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36382 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36383 &_.forward_& files in a redirect router. If Exim is running on a central mail
36384 hub to which ordinary users do not have shell access, but home directories are
36385 NFS mounted (for instance) then administrators should review the list of these
36386 forbid options available, and should bear in mind that the options that may
36387 need forbidding can change as new features are added between releases.
36388 .next
36389 The &%${run...}%& expansion item does not use a shell by default, but
36390 administrators can configure use of &_/bin/sh_& as part of the command.
36391 Such invocations should be viewed with prejudicial suspicion.
36392 .next
36393 Administrators who use embedded Perl are advised to explore how Perl's
36394 taint checking might apply to their usage.
36395 .next
36396 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36397 administrators are well advised to view its use with suspicion, in case (for
36398 instance) it allows a local-part to contain embedded Exim directives.
36399 .next
36400 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36401 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36402 each can reference arbitrary lists and files, rather than just being a list
36403 of opaque strings.
36404 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36405 real-world security vulnerabilities caused by its use with untrustworthy data
36406 injected in, for SQL injection attacks.
36407 Consider the use of the &%inlisti%& expansion condition instead.
36408 .endlist
36409
36410
36411
36412
36413 .section "Trust in configuration data" "SECTsecconfdata"
36414 .cindex "security" "data sources"
36415 .cindex "security" "regular expressions"
36416 .cindex "regular expressions" "security"
36417 .cindex "PCRE" "security"
36418 If configuration data for Exim can come from untrustworthy sources, there
36419 are some issues to be aware of:
36420
36421 .ilist
36422 Use of &%${expand...}%& may provide a path for shell injection attacks.
36423 .next
36424 Letting untrusted data provide a regular expression is unwise.
36425 .next
36426 Using &%${match...}%& to apply a fixed regular expression against untrusted
36427 data may result in pathological behaviour within PCRE.  Be aware of what
36428 "backtracking" means and consider options for being more strict with a regular
36429 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36430 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36431 possessive quantifiers or just not using regular expressions against untrusted
36432 data.
36433 .next
36434 It can be important to correctly use &%${quote:...}%&,
36435 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36436 items to ensure that data is correctly constructed.
36437 .next
36438 Some lookups might return multiple results, even though normal usage is only
36439 expected to yield one result.
36440 .endlist
36441
36442
36443
36444
36445 .section "IPv4 source routing" "SECID272"
36446 .cindex "source routing" "in IP packets"
36447 .cindex "IP source routing"
36448 Many operating systems suppress IP source-routed packets in the kernel, but
36449 some cannot be made to do this, so Exim does its own check. It logs incoming
36450 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36451 IPv6. No special checking is currently done.
36452
36453
36454
36455 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36456 Support for these SMTP commands is disabled by default. If required, they can
36457 be enabled by defining suitable ACLs.
36458
36459
36460
36461
36462 .section "Privileged users" "SECID274"
36463 .cindex "trusted users"
36464 .cindex "admin user"
36465 .cindex "privileged user"
36466 .cindex "user" "trusted"
36467 .cindex "user" "admin"
36468 Exim recognizes two sets of users with special privileges. Trusted users are
36469 able to submit new messages to Exim locally, but supply their own sender
36470 addresses and information about a sending host. For other users submitting
36471 local messages, Exim sets up the sender address from the uid, and doesn't
36472 permit a remote host to be specified.
36473
36474 .oindex "&%-f%&"
36475 However, an untrusted user is permitted to use the &%-f%& command line option
36476 in the special form &%-f <>%& to indicate that a delivery failure for the
36477 message should not cause an error report. This affects the message's envelope,
36478 but it does not affect the &'Sender:'& header. Untrusted users may also be
36479 permitted to use specific forms of address with the &%-f%& option by setting
36480 the &%untrusted_set_sender%& option.
36481
36482 Trusted users are used to run processes that receive mail messages from some
36483 other mail domain and pass them on to Exim for delivery either locally, or over
36484 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36485 as any user listed in the &%trusted_users%& configuration option, or under any
36486 group listed in the &%trusted_groups%& option.
36487
36488 Admin users are permitted to do things to the messages on Exim's queue. They
36489 can freeze or thaw messages, cause them to be returned to their senders, remove
36490 them entirely, or modify them in various ways. In addition, admin users can run
36491 the Exim monitor and see all the information it is capable of providing, which
36492 includes the contents of files on the spool.
36493
36494 .oindex "&%-M%&"
36495 .oindex "&%-q%&"
36496 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36497 delivery of messages on its queue is restricted to admin users. This
36498 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36499 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36500 queue is also restricted to admin users. This restriction can be relaxed by
36501 setting &%no_queue_list_requires_admin%&.
36502
36503 Exim recognizes an admin user if the calling process is running as root or as
36504 the Exim user or if any of the groups associated with the calling process is
36505 the Exim group. It is not necessary actually to be running under the Exim
36506 group. However, if admin users who are not root or the Exim user are to access
36507 the contents of files on the spool via the Exim monitor (which runs
36508 unprivileged), Exim must be built to allow group read access to its spool
36509 files.
36510
36511
36512
36513 .section "Spool files" "SECID275"
36514 .cindex "spool directory" "files"
36515 Exim's spool directory and everything it contains is owned by the Exim user and
36516 set to the Exim group. The mode for spool files is defined in the
36517 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36518 any user who is a member of the Exim group can access these files.
36519
36520
36521
36522 .section "Use of argv[0]" "SECID276"
36523 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36524 of specific strings, Exim assumes certain options. For example, calling Exim
36525 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36526 to calling it with the option &%-bS%&. There are no security implications in
36527 this.
36528
36529
36530
36531 .section "Use of %f formatting" "SECID277"
36532 The only use made of &"%f"& by Exim is in formatting load average values. These
36533 are actually stored in integer variables as 1000 times the load average.
36534 Consequently, their range is limited and so therefore is the length of the
36535 converted output.
36536
36537
36538
36539 .section "Embedded Exim path" "SECID278"
36540 Exim uses its own path name, which is embedded in the code, only when it needs
36541 to re-exec in order to regain root privilege. Therefore, it is not root when it
36542 does so. If some bug allowed the path to get overwritten, it would lead to an
36543 arbitrary program's being run as exim, not as root.
36544
36545
36546
36547 .section "Dynamic module directory" "SECTdynmoddir"
36548 Any dynamically loadable modules must be installed into the directory
36549 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36550 loading it.
36551
36552
36553 .section "Use of sprintf()" "SECID279"
36554 .cindex "&[sprintf()]&"
36555 A large number of occurrences of &"sprintf"& in the code are actually calls to
36556 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36557 The intermediate formatting is done into a large fixed buffer by a function
36558 that runs through the format string itself, and checks the length of each
36559 conversion before performing it, thus preventing buffer overruns.
36560
36561 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36562 the output buffer is known to be sufficiently long to contain the converted
36563 string.
36564
36565
36566
36567 .section "Use of debug_printf() and log_write()" "SECID280"
36568 Arbitrary strings are passed to both these functions, but they do their
36569 formatting by calling the function &'string_vformat()'&, which runs through
36570 the format string itself, and checks the length of each conversion.
36571
36572
36573
36574 .section "Use of strcat() and strcpy()" "SECID281"
36575 These are used only in cases where the output buffer is known to be large
36576 enough to hold the result.
36577 .ecindex IIDsecurcon
36578
36579
36580
36581
36582 . ////////////////////////////////////////////////////////////////////////////
36583 . ////////////////////////////////////////////////////////////////////////////
36584
36585 .chapter "Format of spool files" "CHAPspool"
36586 .scindex IIDforspo1 "format" "spool files"
36587 .scindex IIDforspo2 "spool directory" "format of files"
36588 .scindex IIDforspo3 "spool files" "format of"
36589 .cindex "spool files" "editing"
36590 A message on Exim's queue consists of two files, whose names are the message id
36591 followed by -D and -H, respectively. The data portion of the message is kept in
36592 the -D file on its own. The message's envelope, status, and headers are all
36593 kept in the -H file, whose format is described in this chapter. Each of these
36594 two files contains the final component of its own name as its first line. This
36595 is insurance against disk crashes where the directory is lost but the files
36596 themselves are recoverable.
36597
36598 Some people are tempted into editing -D files in order to modify messages. You
36599 need to be extremely careful if you do this; it is not recommended and you are
36600 on your own if you do it. Here are some of the pitfalls:
36601
36602 .ilist
36603 You must ensure that Exim does not try to deliver the message while you are
36604 fiddling with it. The safest way is to take out a write lock on the -D file,
36605 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36606 place, the lock will be retained. If you write a new file and rename it, the
36607 lock will be lost at the instant of rename.
36608 .next
36609 .vindex "&$body_linecount$&"
36610 If you change the number of lines in the file, the value of
36611 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36612 present, this value is not used by Exim, but there is no guarantee that this
36613 will always be the case.
36614 .next
36615 If the message is in MIME format, you must take care not to break it.
36616 .next
36617 If the message is cryptographically signed, any change will invalidate the
36618 signature.
36619 .endlist
36620 All in all, modifying -D files is fraught with danger.
36621
36622 Files whose names end with -J may also be seen in the &_input_& directory (or
36623 its subdirectories when &%split_spool_directory%& is set). These are journal
36624 files, used to record addresses to which the message has been delivered during
36625 the course of a delivery attempt. If there are still undelivered recipients at
36626 the end, the -H file is updated, and the -J file is deleted. If, however, there
36627 is some kind of crash (for example, a power outage) before this happens, the -J
36628 file remains in existence. When Exim next processes the message, it notices the
36629 -J file and uses it to update the -H file before starting the next delivery
36630 attempt.
36631
36632 .section "Format of the -H file" "SECID282"
36633 .cindex "uid (user id)" "in spool file"
36634 .cindex "gid (group id)" "in spool file"
36635 The second line of the -H file contains the login name for the uid of the
36636 process that called Exim to read the message, followed by the numerical uid and
36637 gid. For a locally generated message, this is normally the user who sent the
36638 message. For a message received over TCP/IP via the daemon, it is
36639 normally the Exim user.
36640
36641 The third line of the file contains the address of the message's sender as
36642 transmitted in the envelope, contained in angle brackets. The sender address is
36643 empty for bounce messages. For incoming SMTP mail, the sender address is given
36644 in the MAIL command. For locally generated mail, the sender address is
36645 created by Exim from the login name of the current user and the configured
36646 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36647 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36648 &"<>"& or an address that matches &%untrusted_set_senders%&.
36649
36650 The fourth line contains two numbers. The first is the time that the message
36651 was received, in the conventional Unix form &-- the number of seconds since the
36652 start of the epoch. The second number is a count of the number of messages
36653 warning of delayed delivery that have been sent to the sender.
36654
36655 There follow a number of lines starting with a hyphen. These can appear in any
36656 order, and are omitted when not relevant:
36657
36658 .vlist
36659 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36660 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36661 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36662 recognized, to provide backward compatibility. In the old format, a line of
36663 this form is present for every ACL variable that is not empty. The number
36664 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36665 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36666 the data string for the variable. The string itself starts at the beginning of
36667 the next line, and is followed by a newline character. It may contain internal
36668 newlines.
36669
36670 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36671 A line of this form is present for every ACL connection variable that is
36672 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36673 The length is the length of the data string for the variable. The string itself
36674 starts at the beginning of the next line, and is followed by a newline
36675 character. It may contain internal newlines.
36676
36677 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36678 A line of this form is present for every ACL message variable that is defined.
36679 Note that there is a space between &%-aclm%& and the rest of the name. The
36680 length is the length of the data string for the variable. The string itself
36681 starts at the beginning of the next line, and is followed by a newline
36682 character. It may contain internal newlines.
36683
36684 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36685 This is present if, when the message was received over SMTP, the value of
36686 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36687
36688 .vitem &%-allow_unqualified_recipient%&
36689 This is present if unqualified recipient addresses are permitted in header
36690 lines (to stop such addresses from being qualified if rewriting occurs at
36691 transport time). Local messages that were input using &%-bnq%& and remote
36692 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36693
36694 .vitem &%-allow_unqualified_sender%&
36695 This is present if unqualified sender addresses are permitted in header lines
36696 (to stop such addresses from being qualified if rewriting occurs at transport
36697 time). Local messages that were input using &%-bnq%& and remote messages from
36698 hosts that match &%sender_unqualified_hosts%& set this flag.
36699
36700 .vitem "&%-auth_id%&&~<&'text'&>"
36701 The id information for a message received on an authenticated SMTP connection
36702 &-- the value of the &$authenticated_id$& variable.
36703
36704 .vitem "&%-auth_sender%&&~<&'address'&>"
36705 The address of an authenticated sender &-- the value of the
36706 &$authenticated_sender$& variable.
36707
36708 .vitem "&%-body_linecount%&&~<&'number'&>"
36709 This records the number of lines in the body of the message, and is always
36710 present.
36711
36712 .vitem "&%-body_zerocount%&&~<&'number'&>"
36713 This records the number of binary zero bytes in the body of the message, and is
36714 present if the number is greater than zero.
36715
36716 .vitem &%-deliver_firsttime%&
36717 This is written when a new message is first added to the spool. When the spool
36718 file is updated after a deferral, it is omitted.
36719
36720 .vitem "&%-frozen%&&~<&'time'&>"
36721 .cindex "frozen messages" "spool data"
36722 The message is frozen, and the freezing happened at <&'time'&>.
36723
36724 .vitem "&%-helo_name%&&~<&'text'&>"
36725 This records the host name as specified by a remote host in a HELO or EHLO
36726 command.
36727
36728 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36729 This records the IP address of the host from which the message was received and
36730 the remote port number that was used. It is omitted for locally generated
36731 messages.
36732
36733 .vitem "&%-host_auth%&&~<&'text'&>"
36734 If the message was received on an authenticated SMTP connection, this records
36735 the name of the authenticator &-- the value of the
36736 &$sender_host_authenticated$& variable.
36737
36738 .vitem &%-host_lookup_failed%&
36739 This is present if an attempt to look up the sending host's name from its IP
36740 address failed. It corresponds to the &$host_lookup_failed$& variable.
36741
36742 .vitem "&%-host_name%&&~<&'text'&>"
36743 .cindex "reverse DNS lookup"
36744 .cindex "DNS" "reverse lookup"
36745 This records the name of the remote host from which the message was received,
36746 if the host name was looked up from the IP address when the message was being
36747 received. It is not present if no reverse lookup was done.
36748
36749 .vitem "&%-ident%&&~<&'text'&>"
36750 For locally submitted messages, this records the login of the originating user,
36751 unless it was a trusted user and the &%-oMt%& option was used to specify an
36752 ident value. For messages received over TCP/IP, this records the ident string
36753 supplied by the remote host, if any.
36754
36755 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36756 This records the IP address of the local interface and the port number through
36757 which a message was received from a remote host. It is omitted for locally
36758 generated messages.
36759
36760 .vitem &%-local%&
36761 The message is from a local sender.
36762
36763 .vitem &%-localerror%&
36764 The message is a locally-generated bounce message.
36765
36766 .vitem "&%-local_scan%&&~<&'string'&>"
36767 This records the data string that was returned by the &[local_scan()]& function
36768 when the message was received &-- the value of the &$local_scan_data$&
36769 variable. It is omitted if no data was returned.
36770
36771 .vitem &%-manual_thaw%&
36772 The message was frozen but has been thawed manually, that is, by an explicit
36773 Exim command rather than via the auto-thaw process.
36774
36775 .vitem &%-N%&
36776 A testing delivery process was started using the &%-N%& option to suppress any
36777 actual deliveries, but delivery was deferred. At any further delivery attempts,
36778 &%-N%& is assumed.
36779
36780 .vitem &%-received_protocol%&
36781 This records the value of the &$received_protocol$& variable, which contains
36782 the name of the protocol by which the message was received.
36783
36784 .vitem &%-sender_set_untrusted%&
36785 The envelope sender of this message was set by an untrusted local caller (used
36786 to ensure that the caller is displayed in queue listings).
36787
36788 .vitem "&%-spam_score_int%&&~<&'number'&>"
36789 If a message was scanned by SpamAssassin, this is present. It records the value
36790 of &$spam_score_int$&.
36791
36792 .vitem &%-tls_certificate_verified%&
36793 A TLS certificate was received from the client that sent this message, and the
36794 certificate was verified by the server.
36795
36796 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36797 When the message was received over an encrypted connection, this records the
36798 name of the cipher suite that was used.
36799
36800 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36801 When the message was received over an encrypted connection, and a certificate
36802 was received from the client, this records the Distinguished Name from that
36803 certificate.
36804 .endlist
36805
36806 Following the options there is a list of those addresses to which the message
36807 is not to be delivered. This set of addresses is initialized from the command
36808 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36809 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36810 the address is added to this set. The addresses are kept internally as a
36811 balanced binary tree, and it is a representation of that tree which is written
36812 to the spool file. If an address is expanded via an alias or forward file, the
36813 original address is added to the tree when deliveries to all its child
36814 addresses are complete.
36815
36816 If the tree is empty, there is a single line in the spool file containing just
36817 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36818 Y or N, followed by an address. The address is the value for the node of the
36819 tree, and the letters indicate whether the node has a left branch and/or a
36820 right branch attached to it, respectively. If branches exist, they immediately
36821 follow. Here is an example of a three-node tree:
36822 .code
36823 YY darcy@austen.fict.example
36824 NN alice@wonderland.fict.example
36825 NN editor@thesaurus.ref.example
36826 .endd
36827 After the non-recipients tree, there is a list of the message's recipients.
36828 This is a simple list, preceded by a count. It includes all the original
36829 recipients of the message, including those to whom the message has already been
36830 delivered. In the simplest case, the list contains one address per line. For
36831 example:
36832 .code
36833 4
36834 editor@thesaurus.ref.example
36835 darcy@austen.fict.example
36836 rdo@foundation
36837 alice@wonderland.fict.example
36838 .endd
36839 However, when a child address has been added to the top-level addresses as a
36840 result of the use of the &%one_time%& option on a &(redirect)& router, each
36841 line is of the following form:
36842 .display
36843 <&'top-level address'&> <&'errors_to address'&> &&&
36844   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36845 .endd
36846 The 01 flag bit indicates the presence of the three other fields that follow
36847 the top-level address. Other bits may be used in future to support additional
36848 fields. The <&'parent number'&> is the offset in the recipients list of the
36849 original parent of the &"one time"& address. The first two fields are the
36850 envelope sender that is associated with this address and its length. If the
36851 length is zero, there is no special envelope sender (there are then two space
36852 characters in the line). A non-empty field can arise from a &(redirect)& router
36853 that has an &%errors_to%& setting.
36854
36855
36856 A blank line separates the envelope and status information from the headers
36857 which follow. A header may occupy several lines of the file, and to save effort
36858 when reading it in, each header is preceded by a number and an identifying
36859 character. The number is the number of characters in the header, including any
36860 embedded newlines and the terminating newline. The character is one of the
36861 following:
36862
36863 .table2 50pt
36864 .row <&'blank'&>         "header in which Exim has no special interest"
36865 .row &`B`&               "&'Bcc:'& header"
36866 .row &`C`&               "&'Cc:'& header"
36867 .row &`F`&               "&'From:'& header"
36868 .row &`I`&               "&'Message-id:'& header"
36869 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36870 .row &`R`&               "&'Reply-To:'& header"
36871 .row &`S`&               "&'Sender:'& header"
36872 .row &`T`&               "&'To:'& header"
36873 .row &`*`&               "replaced or deleted header"
36874 .endtable
36875
36876 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36877 purposes. They are not transmitted when the message is delivered. Here is a
36878 typical set of headers:
36879 .code
36880 111P Received: by hobbit.fict.example with local (Exim 4.00)
36881 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36882 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36883 038* X-rewrote-sender: bb@hobbit.fict.example
36884 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36885 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36886 099* To: alice@wonderland.fict.example, rdo@foundation,
36887 darcy@austen.fict.example, editor@thesaurus.ref.example
36888 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36889 darcy@austen.fict.example, editor@thesaurus.ref.example
36890 038  Date: Fri, 11 May 2001 10:28:59 +0100
36891 .endd
36892 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36893 &'To:'& header have been rewritten, the last one because routing expanded the
36894 unqualified domain &'foundation'&.
36895 .ecindex IIDforspo1
36896 .ecindex IIDforspo2
36897 .ecindex IIDforspo3
36898
36899 . ////////////////////////////////////////////////////////////////////////////
36900 . ////////////////////////////////////////////////////////////////////////////
36901
36902 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36903          "DKIM Support"
36904 .cindex "DKIM"
36905
36906 DKIM is a mechanism by which messages sent by some entity can be provably
36907 linked to a domain which that entity controls.  It permits reputation to
36908 be tracked on a per-domain basis, rather than merely upon source IP address.
36909 DKIM is documented in RFC 4871.
36910
36911 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36912 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36913
36914 Exim's DKIM implementation allows to
36915 .olist
36916 Sign outgoing messages: This function is implemented in the SMTP transport.
36917 It can co-exist with all other Exim features
36918 (including transport filters)
36919 except cutthrough delivery.
36920 .next
36921 Verify signatures in incoming messages: This is implemented by an additional
36922 ACL (acl_smtp_dkim), which can be called several times per message, with
36923 different signature contexts.
36924 .endlist
36925
36926 In typical Exim style, the verification implementation does not include any
36927 default "policy". Instead it enables you to build your own policy using
36928 Exim's standard controls.
36929
36930 Please note that verification of DKIM signatures in incoming mail is turned
36931 on by default for logging purposes. For each signature in incoming email,
36932 exim will log a line displaying the most important signature details, and the
36933 signature status. Here is an example (with line-breaks added for clarity):
36934 .code
36935 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36936     d=facebookmail.com s=q1-2009b
36937     c=relaxed/relaxed a=rsa-sha1
36938     i=@facebookmail.com t=1252484542 [verification succeeded]
36939 .endd
36940 You might want to turn off DKIM verification processing entirely for internal
36941 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36942 control modifier. This should typically be done in the RCPT ACL, at points
36943 where you accept mail from relay sources (internal hosts or authenticated
36944 senders).
36945
36946
36947 .section "Signing outgoing messages" "SECID513"
36948 .cindex "DKIM" "signing"
36949
36950 Signing is implemented by setting private options on the SMTP transport.
36951 These options take (expandable) strings as arguments.
36952
36953 .option dkim_domain smtp string&!! unset
36954 MANDATORY:
36955 The domain you want to sign with. The result of this expanded
36956 option is put into the &%$dkim_domain%& expansion variable.
36957
36958 .option dkim_selector smtp string&!! unset
36959 MANDATORY:
36960 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36961 variable to look up a matching selector. The result is put in the expansion
36962 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36963 option along with &%$dkim_domain%&.
36964
36965 .option dkim_private_key smtp string&!! unset
36966 MANDATORY:
36967 This sets the private key to use. You can use the &%$dkim_domain%& and
36968 &%$dkim_selector%& expansion variables to determine the private key to use.
36969 The result can either
36970 .ilist
36971 be a valid RSA private key in ASCII armor, including line breaks.
36972 .next
36973 start with a slash, in which case it is treated as a file that contains
36974 the private key.
36975 .next
36976 be "0", "false" or the empty string, in which case the message will not
36977 be signed. This case will not result in an error, even if &%dkim_strict%&
36978 is set.
36979 .endlist
36980
36981 .option dkim_canon smtp string&!! unset
36982 OPTIONAL:
36983 This option sets the canonicalization method used when signing a message.
36984 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36985 The option defaults to "relaxed" when unset. Note: the current implementation
36986 only supports using the same canonicalization method for both headers and body.
36987
36988 .option dkim_strict smtp string&!! unset
36989 OPTIONAL:
36990 This  option  defines  how  Exim  behaves  when  signing a message that
36991 should be signed fails for some reason.  When the expansion evaluates to
36992 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36993 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36994 variables here.
36995
36996 .option dkim_sign_headers smtp string&!! unset
36997 OPTIONAL:
36998 When set, this option must expand to (or be specified as) a colon-separated
36999 list of header names. Headers with these names will be included in the message
37000 signature. When unspecified, the header names recommended in RFC4871 will be
37001 used.
37002
37003
37004 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37005 .cindex "DKIM" "verification"
37006
37007 Verification of DKIM signatures in incoming email is implemented via the
37008 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37009 syntactically(!) correct signature in the incoming message.
37010 A missing ACL definition defaults to accept.
37011 If any ACL call does not acccept, the message is not accepted.
37012 If a cutthrough delivery was in progress for the message it is
37013 summarily dropped (having wasted the transmission effort).
37014
37015 To evaluate the signature in the ACL a large number of expansion variables
37016 containing the signature status and its details are set up during the
37017 runtime of the ACL.
37018
37019 Calling the ACL only for existing signatures is not sufficient to build
37020 more advanced policies. For that reason, the global option
37021 &%dkim_verify_signers%&, and a global expansion variable
37022 &%$dkim_signers%& exist.
37023
37024 The global option &%dkim_verify_signers%& can be set to a colon-separated
37025 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37026 called. It is expanded when the message has been received. At this point,
37027 the expansion variable &%$dkim_signers%& already contains a colon-separated
37028 list of signer domains and identities for the message. When
37029 &%dkim_verify_signers%& is not specified in the main configuration,
37030 it defaults as:
37031 .code
37032 dkim_verify_signers = $dkim_signers
37033 .endd
37034 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37035 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37036 call the ACL for known domains or identities. This would be achieved as follows:
37037 .code
37038 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37039 .endd
37040 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37041 and "ebay.com", plus all domains and identities that have signatures in the message.
37042 You can also be more creative in constructing your policy. For example:
37043 .code
37044 dkim_verify_signers = $sender_address_domain:$dkim_signers
37045 .endd
37046
37047 If a domain or identity is listed several times in the (expanded) value of
37048 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37049
37050
37051 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37052 available (from most to least important):
37053
37054
37055 .vlist
37056 .vitem &%$dkim_cur_signer%&
37057 The signer that is being evaluated in this ACL run. This can be a domain or
37058 an identity. This is one of the list items from the expanded main option
37059 &%dkim_verify_signers%& (see above).
37060 .vitem &%$dkim_verify_status%&
37061 A string describing the general status of the signature. One of
37062 .ilist
37063 &%none%&: There is no signature in the message for the current domain or
37064 identity (as reflected by &%$dkim_cur_signer%&).
37065 .next
37066 &%invalid%&: The signature could not be verified due to a processing error.
37067 More detail is available in &%$dkim_verify_reason%&.
37068 .next
37069 &%fail%&: Verification of the signature failed.  More detail is
37070 available in &%$dkim_verify_reason%&.
37071 .next
37072 &%pass%&: The signature passed verification. It is valid.
37073 .endlist
37074 .vitem &%$dkim_verify_reason%&
37075 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37076 "fail" or "invalid". One of
37077 .ilist
37078 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37079 key for the domain could not be retrieved. This may be a temporary problem.
37080 .next
37081 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37082 record for the domain is syntactically invalid.
37083 .next
37084 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37085 body hash does not match the one specified in the signature header. This
37086 means that the message body was modified in transit.
37087 .next
37088 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37089 could not be verified. This may mean that headers were modified,
37090 re-written or otherwise changed in a way which is incompatible with
37091 DKIM verification. It may of course also mean that the signature is forged.
37092 .endlist
37093 .vitem &%$dkim_domain%&
37094 The signing domain. IMPORTANT: This variable is only populated if there is
37095 an actual signature in the message for the current domain or identity (as
37096 reflected by &%$dkim_cur_signer%&).
37097 .vitem &%$dkim_identity%&
37098 The signing identity, if present. IMPORTANT: This variable is only populated
37099 if there is an actual signature in the message for the current domain or
37100 identity (as reflected by &%$dkim_cur_signer%&).
37101 .vitem &%$dkim_selector%&
37102 The key record selector string.
37103 .vitem &%$dkim_algo%&
37104 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37105 .vitem &%$dkim_canon_body%&
37106 The body canonicalization method. One of 'relaxed' or 'simple'.
37107 .vitem &%dkim_canon_headers%&
37108 The header canonicalization method. One of 'relaxed' or 'simple'.
37109 .vitem &%$dkim_copiedheaders%&
37110 A transcript of headers and their values which are included in the signature
37111 (copied from the 'z=' tag of the signature).
37112 .vitem &%$dkim_bodylength%&
37113 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37114 limit was set by the signer, "9999999999999" is returned. This makes sure
37115 that this variable always expands to an integer value.
37116 .vitem &%$dkim_created%&
37117 UNIX timestamp reflecting the date and time when the signature was created.
37118 When this was not specified by the signer, "0" is returned.
37119 .vitem &%$dkim_expires%&
37120 UNIX timestamp reflecting the date and time when the signer wants the
37121 signature to be treated as "expired". When this was not specified by the
37122 signer, "9999999999999" is returned. This makes it possible to do useful
37123 integer size comparisons against this value.
37124 .vitem &%$dkim_headernames%&
37125 A colon-separated list of names of headers included in the signature.
37126 .vitem &%$dkim_key_testing%&
37127 "1" if the key record has the "testing" flag set, "0" if not.
37128 .vitem &%$dkim_key_nosubdomains%&
37129 "1" if the key record forbids subdomaining, "0" otherwise.
37130 .vitem &%$dkim_key_srvtype%&
37131 Service type (tag s=) from the key record. Defaults to "*" if not specified
37132 in the key record.
37133 .vitem &%$dkim_key_granularity%&
37134 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37135 in the key record.
37136 .vitem &%$dkim_key_notes%&
37137 Notes from the key record (tag n=).
37138 .endlist
37139
37140 In addition, two ACL conditions are provided:
37141
37142 .vlist
37143 .vitem &%dkim_signers%&
37144 ACL condition that checks a colon-separated list of domains or identities
37145 for a match against the domain or identity that the ACL is currently verifying
37146 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37147 verb to a group of domains or identities. For example:
37148
37149 .code
37150 # Warn when Mail purportedly from GMail has no signature at all
37151 warn log_message = GMail sender without DKIM signature
37152      sender_domains = gmail.com
37153      dkim_signers = gmail.com
37154      dkim_status = none
37155 .endd
37156
37157 .vitem &%dkim_status%&
37158 ACL condition that checks a colon-separated list of possible DKIM verification
37159 results against the actual result of verification. This is typically used
37160 to restrict an ACL verb to a list of verification outcomes, for example:
37161
37162 .code
37163 deny message = Mail from Paypal with invalid/missing signature
37164      sender_domains = paypal.com:paypal.de
37165      dkim_signers = paypal.com:paypal.de
37166      dkim_status = none:invalid:fail
37167 .endd
37168
37169 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37170 see the documentation of the &%$dkim_verify_status%& expansion variable above
37171 for more information of what they mean.
37172 .endlist
37173
37174 . ////////////////////////////////////////////////////////////////////////////
37175 . ////////////////////////////////////////////////////////////////////////////
37176
37177 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37178          "Adding drivers or lookups"
37179 .cindex "adding drivers"
37180 .cindex "new drivers, adding"
37181 .cindex "drivers" "adding new"
37182 The following actions have to be taken in order to add a new router, transport,
37183 authenticator, or lookup type to Exim:
37184
37185 .olist
37186 Choose a name for the driver or lookup type that does not conflict with any
37187 existing name; I will use &"newdriver"& in what follows.
37188 .next
37189 Add to &_src/EDITME_& the line:
37190 .display
37191 <&'type'&>&`_NEWDRIVER=yes`&
37192 .endd
37193 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37194 code is not to be included in the binary by default, comment this line out. You
37195 should also add any relevant comments about the driver or lookup type.
37196 .next
37197 Add to &_src/config.h.defaults_& the line:
37198 .code
37199 #define <type>_NEWDRIVER
37200 .endd
37201 .next
37202 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37203 and create a table entry as is done for all the other drivers and lookup types.
37204 .next
37205 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37206 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37207 Add your &`NEWDRIVER`& to that list.
37208 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37209 simple form that most lookups have.
37210 .next
37211 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37212 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37213 driver or lookup type and add it to the definition of OBJ.
37214 .next
37215 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37216 &_src_&.
37217 .next
37218 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37219 as for other drivers and lookups.
37220 .endlist
37221
37222 Then all you need to do is write the code! A good way to start is to make a
37223 proforma by copying an existing module of the same type, globally changing all
37224 occurrences of the name, and cutting out most of the code. Note that any
37225 options you create must be listed in alphabetical order, because the tables are
37226 searched using a binary chop procedure.
37227
37228 There is a &_README_& file in each of the sub-directories of &_src_& describing
37229 the interface that is expected.
37230
37231
37232
37233
37234 . ////////////////////////////////////////////////////////////////////////////
37235 . ////////////////////////////////////////////////////////////////////////////
37236
37237 . /////////////////////////////////////////////////////////////////////////////
37238 . These lines are processing instructions for the Simple DocBook Processor that
37239 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37240 . PDFs than using xmlto and fop. They will be ignored by all other XML
37241 . processors.
37242 . /////////////////////////////////////////////////////////////////////////////
37243
37244 .literal xml
37245 <?sdop
37246   format="newpage"
37247   foot_right_recto="&chaptertitle;"
37248   foot_right_verso="&chaptertitle;"
37249 ?>
37250 .literal off
37251
37252 .makeindex "Options index"   "option"
37253 .makeindex "Variables index" "variable"
37254 .makeindex "Concept index"   "concept"
37255
37256
37257 . /////////////////////////////////////////////////////////////////////////////
37258 . /////////////////////////////////////////////////////////////////////////////