dc2b6ac059971dfa761fd1db01005f6c55d63e46
[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.87"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2016
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" "deferred deliveries"
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 is set at build time). 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"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
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 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 .cindex "header lines" "From:"
2631 .cindex "header lines" "Sender:"
2632 For a trusted user, there is never any check on the contents of the &'From:'&
2633 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2634 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2635
2636 Trusted users may also specify a host name, host address, interface address,
2637 protocol name, ident value, and authentication data when submitting a message
2638 locally. Thus, they are able to insert messages into Exim's queue locally that
2639 have the characteristics of messages received from a remote host. Untrusted
2640 users may in some circumstances use &%-f%&, but can never set the other values
2641 that are available to trusted users.
2642 .next
2643 .cindex "user" "admin definition of"
2644 .cindex "admin user" "definition of"
2645 The admin users are root, the Exim user, and any user that is a member of the
2646 Exim group or of any group listed in the &%admin_groups%& configuration option.
2647 The current group does not have to be one of these groups.
2648
2649 Admin users are permitted to list the queue, and to carry out certain
2650 operations on messages, for example, to force delivery failures. It is also
2651 necessary to be an admin user in order to see the full information provided by
2652 the Exim monitor, and full debugging output.
2653
2654 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2655 Exim to attempt delivery of messages on its queue is restricted to admin users.
2656 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2657 option false (that is, specifying &%no_prod_requires_admin%&).
2658
2659 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2660 is restricted to admin users unless &%queue_list_requires_admin%& is set
2661 false.
2662 .endlist
2663
2664
2665 &*Warning*&: If you configure your system so that admin users are able to
2666 edit Exim's configuration file, you are giving those users an easy way of
2667 getting root. There is further discussion of this issue at the start of chapter
2668 &<<CHAPconf>>&.
2669
2670
2671
2672
2673 .section "Command line options" "SECID39"
2674 Exim's command line options are described in alphabetical order below. If none
2675 of the options that specifies a specific action (such as starting the daemon or
2676 a queue runner, or testing an address, or receiving a message in a specific
2677 format, or listing the queue) are present, and there is at least one argument
2678 on the command line, &%-bm%& (accept a local message on the standard input,
2679 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2680 outputs a brief message about itself and exits.
2681
2682 . ////////////////////////////////////////////////////////////////////////////
2683 . Insert a stylized XML comment here, to identify the start of the command line
2684 . options. This is for the benefit of the Perl script that automatically
2685 . creates a man page for the options.
2686 . ////////////////////////////////////////////////////////////////////////////
2687
2688 .literal xml
2689 <!-- === Start of command line options === -->
2690 .literal off
2691
2692
2693 .vlist
2694 .vitem &%--%&
2695 .oindex "--"
2696 .cindex "options" "command line; terminating"
2697 This is a pseudo-option whose only purpose is to terminate the options and
2698 therefore to cause subsequent command line items to be treated as arguments
2699 rather than options, even if they begin with hyphens.
2700
2701 .vitem &%--help%&
2702 .oindex "&%--help%&"
2703 This option causes Exim to output a few sentences stating what it is.
2704 The same output is generated if the Exim binary is called with no options and
2705 no arguments.
2706
2707 .vitem &%--version%&
2708 .oindex "&%--version%&"
2709 This option is an alias for &%-bV%& and causes version information to be
2710 displayed.
2711
2712 .vitem &%-Ac%& &&&
2713        &%-Am%&
2714 .oindex "&%-Ac%&"
2715 .oindex "&%-Am%&"
2716 These options are used by Sendmail for selecting configuration files and are
2717 ignored by Exim.
2718
2719 .vitem &%-B%&<&'type'&>
2720 .oindex "&%-B%&"
2721 .cindex "8-bit characters"
2722 .cindex "Sendmail compatibility" "8-bit characters"
2723 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2724 clean; it ignores this option.
2725
2726 .vitem &%-bd%&
2727 .oindex "&%-bd%&"
2728 .cindex "daemon"
2729 .cindex "SMTP" "listener"
2730 .cindex "queue runner"
2731 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2732 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2733 that the daemon should also initiate periodic queue runs.
2734
2735 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2736 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2737 disconnect from the controlling terminal. When running this way, it can be
2738 stopped by pressing ctrl-C.
2739
2740 By default, Exim listens for incoming connections to the standard SMTP port on
2741 all the host's running interfaces. However, it is possible to listen on other
2742 ports, on multiple ports, and only on specific interfaces. Chapter
2743 &<<CHAPinterfaces>>& contains a description of the options that control this.
2744
2745 When a listening daemon
2746 .cindex "daemon" "process id (pid)"
2747 .cindex "pid (process id)" "of daemon"
2748 is started without the use of &%-oX%& (that is, without overriding the normal
2749 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2750 in Exim's spool directory. This location can be overridden by setting
2751 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2752 running as root.
2753
2754 When &%-oX%& is used on the command line to start a listening daemon, the
2755 process id is not written to the normal pid file path. However, &%-oP%& can be
2756 used to specify a path on the command line if a pid file is required.
2757
2758 The SIGHUP signal
2759 .cindex "SIGHUP"
2760 .cindex "daemon" "restarting"
2761 can be used to cause the daemon to re-execute itself. This should be done
2762 whenever Exim's configuration file, or any file that is incorporated into it by
2763 means of the &%.include%& facility, is changed, and also whenever a new version
2764 of Exim is installed. It is not necessary to do this when other files that are
2765 referenced from the configuration (for example, alias files) are changed,
2766 because these are reread each time they are used.
2767
2768 .vitem &%-bdf%&
2769 .oindex "&%-bdf%&"
2770 This option has the same effect as &%-bd%& except that it never disconnects
2771 from the controlling terminal, even when no debugging is specified.
2772
2773 .vitem &%-be%&
2774 .oindex "&%-be%&"
2775 .cindex "testing" "string expansion"
2776 .cindex "expansion" "testing"
2777 Run Exim in expansion testing mode. Exim discards its root privilege, to
2778 prevent ordinary users from using this mode to read otherwise inaccessible
2779 files. If no arguments are given, Exim runs interactively, prompting for lines
2780 of data. Otherwise, it processes each argument in turn.
2781
2782 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2783 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2784 used without command line arguments. If successful, it uses the &[readline()]&
2785 function, which provides extensive line-editing facilities, for reading the
2786 test data. A line history is supported.
2787
2788 Long expansion expressions can be split over several lines by using backslash
2789 continuations. As in Exim's run time configuration, white space at the start of
2790 continuation lines is ignored. Each argument or data line is passed through the
2791 string expansion mechanism, and the result is output. Variable values from the
2792 configuration file (for example, &$qualify_domain$&) are available, but no
2793 message-specific values (such as &$message_exim_id$&) are set, because no message
2794 is being processed (but see &%-bem%& and &%-Mset%&).
2795
2796 &*Note*&: If you use this mechanism to test lookups, and you change the data
2797 files or databases you are using, you must exit and restart Exim before trying
2798 the same lookup again. Otherwise, because each Exim process caches the results
2799 of lookups, you will just get the same result as before.
2800
2801 .vitem &%-bem%&&~<&'filename'&>
2802 .oindex "&%-bem%&"
2803 .cindex "testing" "string expansion"
2804 .cindex "expansion" "testing"
2805 This option operates like &%-be%& except that it must be followed by the name
2806 of a file. For example:
2807 .code
2808 exim -bem /tmp/testmessage
2809 .endd
2810 The file is read as a message (as if receiving a locally-submitted non-SMTP
2811 message) before any of the test expansions are done. Thus, message-specific
2812 variables such as &$message_size$& and &$header_from:$& are available. However,
2813 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2814 recipients are read from the headers in the normal way, and are shown in the
2815 &$recipients$& variable. Note that recipients cannot be given on the command
2816 line, because further arguments are taken as strings to expand (just like
2817 &%-be%&).
2818
2819 .vitem &%-bF%&&~<&'filename'&>
2820 .oindex "&%-bF%&"
2821 .cindex "system filter" "testing"
2822 .cindex "testing" "system filter"
2823 This option is the same as &%-bf%& except that it assumes that the filter being
2824 tested is a system filter. The additional commands that are available only in
2825 system filters are recognized.
2826
2827 .vitem &%-bf%&&~<&'filename'&>
2828 .oindex "&%-bf%&"
2829 .cindex "filter" "testing"
2830 .cindex "testing" "filter file"
2831 .cindex "forward file" "testing"
2832 .cindex "testing" "forward file"
2833 .cindex "Sieve filter" "testing"
2834 This option runs Exim in user filter testing mode; the file is the filter file
2835 to be tested, and a test message must be supplied on the standard input. If
2836 there are no message-dependent tests in the filter, an empty file can be
2837 supplied.
2838
2839 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2840 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2841 filter and a user filter in the same run. For example:
2842 .code
2843 exim -bF /system/filter -bf /user/filter </test/message
2844 .endd
2845 This is helpful when the system filter adds header lines or sets filter
2846 variables that are used by the user filter.
2847
2848 If the test filter file does not begin with one of the special lines
2849 .code
2850 # Exim filter
2851 # Sieve filter
2852 .endd
2853 it is taken to be a normal &_.forward_& file, and is tested for validity under
2854 that interpretation. See sections &<<SECTitenonfilred>>& to
2855 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2856 redirection lists.
2857
2858 The result of an Exim command that uses &%-bf%&, provided no errors are
2859 detected, is a list of the actions that Exim would try to take if presented
2860 with the message for real. More details of filter testing are given in the
2861 separate document entitled &'Exim's interfaces to mail filtering'&.
2862
2863 When testing a filter file,
2864 .cindex "&""From""& line"
2865 .cindex "envelope sender"
2866 .oindex "&%-f%&" "for filter testing"
2867 the envelope sender can be set by the &%-f%& option,
2868 or by a &"From&~"& line at the start of the test message. Various parameters
2869 that would normally be taken from the envelope recipient address of the message
2870 can be set by means of additional command line options (see the next four
2871 options).
2872
2873 .vitem &%-bfd%&&~<&'domain'&>
2874 .oindex "&%-bfd%&"
2875 .vindex "&$qualify_domain$&"
2876 This sets the domain of the recipient address when a filter file is being
2877 tested by means of the &%-bf%& option. The default is the value of
2878 &$qualify_domain$&.
2879
2880 .vitem &%-bfl%&&~<&'local&~part'&>
2881 .oindex "&%-bfl%&"
2882 This sets the local part of the recipient address when a filter file is being
2883 tested by means of the &%-bf%& option. The default is the username of the
2884 process that calls Exim. A local part should be specified with any prefix or
2885 suffix stripped, because that is how it appears to the filter when a message is
2886 actually being delivered.
2887
2888 .vitem &%-bfp%&&~<&'prefix'&>
2889 .oindex "&%-bfp%&"
2890 This sets the prefix of the local part of the recipient address when a filter
2891 file is being tested by means of the &%-bf%& option. The default is an empty
2892 prefix.
2893
2894 .vitem &%-bfs%&&~<&'suffix'&>
2895 .oindex "&%-bfs%&"
2896 This sets the suffix of the local part of the recipient address when a filter
2897 file is being tested by means of the &%-bf%& option. The default is an empty
2898 suffix.
2899
2900 .vitem &%-bh%&&~<&'IP&~address'&>
2901 .oindex "&%-bh%&"
2902 .cindex "testing" "incoming SMTP"
2903 .cindex "SMTP" "testing incoming"
2904 .cindex "testing" "relay control"
2905 .cindex "relaying" "testing configuration"
2906 .cindex "policy control" "testing"
2907 .cindex "debugging" "&%-bh%& option"
2908 This option runs a fake SMTP session as if from the given IP address, using the
2909 standard input and output. The IP address may include a port number at the end,
2910 after a full stop. For example:
2911 .code
2912 exim -bh 10.9.8.7.1234
2913 exim -bh fe80::a00:20ff:fe86:a061.5678
2914 .endd
2915 When an IPv6 address is given, it is converted into canonical form. In the case
2916 of the second example above, the value of &$sender_host_address$& after
2917 conversion to the canonical form is
2918 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2919
2920 Comments as to what is going on are written to the standard error file. These
2921 include lines beginning with &"LOG"& for anything that would have been logged.
2922 This facility is provided for testing configuration options for incoming
2923 messages, to make sure they implement the required policy. For example, you can
2924 test your relay controls using &%-bh%&.
2925
2926 &*Warning 1*&:
2927 .cindex "RFC 1413"
2928 You can test features of the configuration that rely on ident (RFC 1413)
2929 information by using the &%-oMt%& option. However, Exim cannot actually perform
2930 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2931 connection.
2932
2933 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2934 are also skipped when testing using &%-bh%&. If you want these callouts to
2935 occur, use &%-bhc%& instead.
2936
2937 Messages supplied during the testing session are discarded, and nothing is
2938 written to any of the real log files. There may be pauses when DNS (and other)
2939 lookups are taking place, and of course these may time out. The &%-oMi%& option
2940 can be used to specify a specific IP interface and port if this is important,
2941 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2942 session were authenticated.
2943
2944 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2945 output just states whether a given recipient address from a given host is
2946 acceptable or not. See section &<<SECTcheckaccess>>&.
2947
2948 Features such as authentication and encryption, where the client input is not
2949 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2950 specialized SMTP test program such as
2951 &url(http://jetmore.org/john/code/#swaks,swaks).
2952
2953 .vitem &%-bhc%&&~<&'IP&~address'&>
2954 .oindex "&%-bhc%&"
2955 This option operates in the same way as &%-bh%&, except that address
2956 verification callouts are performed if required. This includes consulting and
2957 updating the callout cache database.
2958
2959 .vitem &%-bi%&
2960 .oindex "&%-bi%&"
2961 .cindex "alias file" "building"
2962 .cindex "building alias file"
2963 .cindex "Sendmail compatibility" "&%-bi%& option"
2964 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2965 Exim does not have the concept of a single alias file, and so it cannot mimic
2966 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2967 tend to appear in various scripts such as NIS make files, so the option must be
2968 recognized.
2969
2970 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2971 configuration option is run, under the uid and gid of the caller of Exim. If
2972 the &%-oA%& option is used, its value is passed to the command as an argument.
2973 The command set by &%bi_command%& may not contain arguments. The command can
2974 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2975 if this is required. If the &%bi_command%& option is not set, calling Exim with
2976 &%-bi%& is a no-op.
2977
2978 . // Keep :help first, then the rest in alphabetical order
2979 .vitem &%-bI:help%&
2980 .oindex "&%-bI:help%&"
2981 .cindex "querying exim information"
2982 We shall provide various options starting &`-bI:`& for querying Exim for
2983 information.  The output of many of these will be intended for machine
2984 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2985 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2986 options shall cause Exim to exit after producing the requested output.
2987
2988 .vitem &%-bI:dscp%&
2989 .oindex "&%-bI:dscp%&"
2990 .cindex "DSCP" "values"
2991 This option causes Exim to emit an alphabetically sorted list of all
2992 recognised DSCP names.
2993
2994 .vitem &%-bI:sieve%&
2995 .oindex "&%-bI:sieve%&"
2996 .cindex "Sieve filter" "capabilities"
2997 This option causes Exim to emit an alphabetically sorted list of all supported
2998 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2999 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3000 &`SIEVE`& capability response line.  As the precise list may depend upon
3001 compile-time build options, which this option will adapt to, this is the only
3002 way to guarantee a correct response.
3003
3004 .vitem &%-bm%&
3005 .oindex "&%-bm%&"
3006 .cindex "local message reception"
3007 This option runs an Exim receiving process that accepts an incoming,
3008 locally-generated message on the standard input. The recipients are given as the
3009 command arguments (except when &%-t%& is also present &-- see below). Each
3010 argument can be a comma-separated list of RFC 2822 addresses. This is the
3011 default option for selecting the overall action of an Exim call; it is assumed
3012 if no other conflicting option is present.
3013
3014 If any addresses in the message are unqualified (have no domain), they are
3015 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3016 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3017 suppressing this for special cases.
3018
3019 Policy checks on the contents of local messages can be enforced by means of
3020 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3021
3022 .cindex "return code" "for &%-bm%&"
3023 The return code is zero if the message is successfully accepted. Otherwise, the
3024 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3025
3026 The format
3027 .cindex "message" "format"
3028 .cindex "format" "message"
3029 .cindex "&""From""& line"
3030 .cindex "UUCP" "&""From""& line"
3031 .cindex "Sendmail compatibility" "&""From""& line"
3032 of the message must be as defined in RFC 2822, except that, for
3033 compatibility with Sendmail and Smail, a line in one of the forms
3034 .code
3035 From sender Fri Jan  5 12:55 GMT 1997
3036 From sender Fri, 5 Jan 97 12:55:01
3037 .endd
3038 (with the weekday optional, and possibly with additional text after the date)
3039 is permitted to appear at the start of the message. There appears to be no
3040 authoritative specification of the format of this line. Exim recognizes it by
3041 matching against the regular expression defined by the &%uucp_from_pattern%&
3042 option, which can be changed if necessary.
3043
3044 .oindex "&%-f%&" "overriding &""From""& line"
3045 The specified sender is treated as if it were given as the argument to the
3046 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3047 preference to the address taken from the message. The caller of Exim must be a
3048 trusted user for the sender of a message to be set in this way.
3049
3050 .vitem &%-bmalware%&&~<&'filename'&>
3051 .oindex "&%-bmalware%&"
3052 .cindex "testing", "malware"
3053 .cindex "malware scan test"
3054 This debugging option causes Exim to scan the given file or directory
3055 (depending on the used scanner interface),
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 &%config%& is given as an argument, the config is
3114 output, as it was parsed, any include file resolved, any comment removed.
3115
3116 If &%config_file%& is given as an argument, the name of the run time
3117 configuration file is output. (&%configure_file%& works too, for
3118 backward compatibility.)
3119 If a list of configuration files was supplied, the value that is output here
3120 is the name of the file that was actually used.
3121
3122 .cindex "options" "hiding name of"
3123 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3124 name will not be output.
3125
3126 .cindex "daemon" "process id (pid)"
3127 .cindex "pid (process id)" "of daemon"
3128 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3129 directories where log files and daemon pid files are written are output,
3130 respectively. If these values are unset, log files are written in a
3131 sub-directory of the spool directory called &%log%&, and the pid file is
3132 written directly into the spool directory.
3133
3134 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3135 .code
3136 exim -bP +local_domains
3137 .endd
3138 it searches for a matching named list of any type (domain, host, address, or
3139 local part) and outputs what it finds.
3140
3141 .cindex "options" "router &-- extracting"
3142 .cindex "options" "transport &-- extracting"
3143 .cindex "options" "authenticator &-- extracting"
3144 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3145 followed by the name of an appropriate driver instance, the option settings for
3146 that driver are output. For example:
3147 .code
3148 exim -bP transport local_delivery
3149 .endd
3150 The generic driver options are output first, followed by the driver's private
3151 options. A list of the names of drivers of a particular type can be obtained by
3152 using one of the words &%router_list%&, &%transport_list%&, or
3153 &%authenticator_list%&, and a complete list of all drivers with their option
3154 settings can be obtained by using &%routers%&, &%transports%&, or
3155 &%authenticators%&.
3156
3157 .cindex "environment"
3158 If &%environment%& is given as an argument, the set of environment
3159 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3160 variables.
3161
3162 .cindex "options" "macro &-- extracting"
3163 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3164 are available, similarly to the drivers.  Because macros are sometimes used
3165 for storing passwords, this option is restricted.
3166 The output format is one item per line.
3167
3168 .vitem &%-bp%&
3169 .oindex "&%-bp%&"
3170 .cindex "queue" "listing messages on"
3171 .cindex "listing" "messages on the queue"
3172 This option requests a listing of the contents of the mail queue on the
3173 standard output. If the &%-bp%& option is followed by a list of message ids,
3174 just those messages are listed. By default, this option can be used only by an
3175 admin user. However, the &%queue_list_requires_admin%& option can be set false
3176 to allow any user to see the queue.
3177
3178 Each message on the queue is displayed as in the following example:
3179 .code
3180 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3181           red.king@looking-glass.fict.example
3182           <other addresses>
3183 .endd
3184 .cindex "message" "size in queue listing"
3185 .cindex "size" "of message"
3186 The first line contains the length of time the message has been on the queue
3187 (in this case 25 minutes), the size of the message (2.9K), the unique local
3188 identifier for the message, and the message sender, as contained in the
3189 envelope. For bounce messages, the sender address is empty, and appears as
3190 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3191 the default sender address, the user's login name is shown in parentheses
3192 before the sender address.
3193
3194 .cindex "frozen messages" "in queue listing"
3195 If the message is frozen (attempts to deliver it are suspended) then the text
3196 &"*** frozen ***"& is displayed at the end of this line.
3197
3198 The recipients of the message (taken from the envelope, not the headers) are
3199 displayed on subsequent lines. Those addresses to which the message has already
3200 been delivered are marked with the letter D. If an original address gets
3201 expanded into several addresses via an alias or forward file, the original is
3202 displayed with a D only when deliveries for all of its child addresses are
3203 complete.
3204
3205
3206 .vitem &%-bpa%&
3207 .oindex "&%-bpa%&"
3208 This option operates like &%-bp%&, but in addition it shows delivered addresses
3209 that were generated from the original top level address(es) in each message by
3210 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3211 of just &"D"&.
3212
3213
3214 .vitem &%-bpc%&
3215 .oindex "&%-bpc%&"
3216 .cindex "queue" "count of messages on"
3217 This option counts the number of messages on the queue, and writes the total
3218 to the standard output. It is restricted to admin users, unless
3219 &%queue_list_requires_admin%& is set false.
3220
3221
3222 .vitem &%-bpr%&
3223 .oindex "&%-bpr%&"
3224 This option operates like &%-bp%&, but the output is not sorted into
3225 chronological order of message arrival. This can speed it up when there are
3226 lots of messages on the queue, and is particularly useful if the output is
3227 going to be post-processed in a way that doesn't need the sorting.
3228
3229 .vitem &%-bpra%&
3230 .oindex "&%-bpra%&"
3231 This option is a combination of &%-bpr%& and &%-bpa%&.
3232
3233 .vitem &%-bpru%&
3234 .oindex "&%-bpru%&"
3235 This option is a combination of &%-bpr%& and &%-bpu%&.
3236
3237
3238 .vitem &%-bpu%&
3239 .oindex "&%-bpu%&"
3240 This option operates like &%-bp%& but shows only undelivered top-level
3241 addresses for each message displayed. Addresses generated by aliasing or
3242 forwarding are not shown, unless the message was deferred after processing by a
3243 router with the &%one_time%& option set.
3244
3245
3246 .vitem &%-brt%&
3247 .oindex "&%-brt%&"
3248 .cindex "testing" "retry configuration"
3249 .cindex "retry" "configuration testing"
3250 This option is for testing retry rules, and it must be followed by up to three
3251 arguments. It causes Exim to look for a retry rule that matches the values
3252 and to write it to the standard output. For example:
3253 .code
3254 exim -brt bach.comp.mus.example
3255 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3256 .endd
3257 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3258 argument, which is required, can be a complete address in the form
3259 &'local_part@domain'&, or it can be just a domain name. If the second argument
3260 contains a dot, it is interpreted as an optional second domain name; if no
3261 retry rule is found for the first argument, the second is tried. This ties in
3262 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3263 rule is found that matches the host, one that matches the mail domain is
3264 sought. Finally, an argument that is the name of a specific delivery error, as
3265 used in setting up retry rules, can be given. For example:
3266 .code
3267 exim -brt haydn.comp.mus.example quota_3d
3268 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3269 .endd
3270
3271 .vitem &%-brw%&
3272 .oindex "&%-brw%&"
3273 .cindex "testing" "rewriting"
3274 .cindex "rewriting" "testing"
3275 This option is for testing address rewriting rules, and it must be followed by
3276 a single argument, consisting of either a local part without a domain, or a
3277 complete address with a fully qualified domain. Exim outputs how this address
3278 would be rewritten for each possible place it might appear. See chapter
3279 &<<CHAPrewrite>>& for further details.
3280
3281 .vitem &%-bS%&
3282 .oindex "&%-bS%&"
3283 .cindex "SMTP" "batched incoming"
3284 .cindex "batched SMTP input"
3285 This option is used for batched SMTP input, which is an alternative interface
3286 for non-interactive local message submission. A number of messages can be
3287 submitted in a single run. However, despite its name, this is not really SMTP
3288 input. Exim reads each message's envelope from SMTP commands on the standard
3289 input, but generates no responses. If the caller is trusted, or
3290 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3291 believed; otherwise the sender is always the caller of Exim.
3292
3293 The message itself is read from the standard input, in SMTP format (leading
3294 dots doubled), terminated by a line containing just a single dot. An error is
3295 provoked if the terminating dot is missing. A further message may then follow.
3296
3297 As for other local message submissions, the contents of incoming batch SMTP
3298 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3299 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3300 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3301
3302 Some other SMTP commands are recognized in the input. HELO and EHLO act
3303 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3304 QUIT quits, ignoring the rest of the standard input.
3305
3306 .cindex "return code" "for &%-bS%&"
3307 If any error is encountered, reports are written to the standard output and
3308 error streams, and Exim gives up immediately. The return code is 0 if no error
3309 was detected; it is 1 if one or more messages were accepted before the error
3310 was detected; otherwise it is 2.
3311
3312 More details of input using batched SMTP are given in section
3313 &<<SECTincomingbatchedSMTP>>&.
3314
3315 .vitem &%-bs%&
3316 .oindex "&%-bs%&"
3317 .cindex "SMTP" "local input"
3318 .cindex "local SMTP input"
3319 This option causes Exim to accept one or more messages by reading SMTP commands
3320 on the standard input, and producing SMTP replies on the standard output. SMTP
3321 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3322 Some user agents use this interface as a way of passing locally-generated
3323 messages to the MTA.
3324
3325 In
3326 .cindex "sender" "source of"
3327 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3328 set, the senders of messages are taken from the SMTP MAIL commands.
3329 Otherwise the content of these commands is ignored and the sender is set up as
3330 the calling user. Unqualified addresses are automatically qualified using
3331 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3332 &%-bnq%& option is used.
3333
3334 .cindex "inetd"
3335 The
3336 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3337 using a listening daemon. Exim can distinguish the two cases by checking
3338 whether the standard input is a TCP/IP socket. When Exim is called from
3339 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3340 above concerning senders and qualification do not apply. In this situation,
3341 Exim behaves in exactly the same way as it does when receiving a message via
3342 the listening daemon.
3343
3344 .vitem &%-bt%&
3345 .oindex "&%-bt%&"
3346 .cindex "testing" "addresses"
3347 .cindex "address" "testing"
3348 This option runs Exim in address testing mode, in which each argument is taken
3349 as a recipient address to be tested for deliverability. The results are
3350 written to the standard output. If a test fails, and the caller is not an admin
3351 user, no details of the failure are output, because these might contain
3352 sensitive information such as usernames and passwords for database lookups.
3353
3354 If no arguments are given, Exim runs in an interactive manner, prompting with a
3355 right angle bracket for addresses to be tested.
3356
3357 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3358 &[readline()]& function, because it is running as &'root'& and there are
3359 security issues.
3360
3361 Each address is handled as if it were the recipient address of a message
3362 (compare the &%-bv%& option). It is passed to the routers and the result is
3363 written to the standard output. However, any router that has
3364 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3365 genuine routing tests if your first router passes everything to a scanner
3366 program.
3367
3368 .cindex "return code" "for &%-bt%&"
3369 The return code is 2 if any address failed outright; it is 1 if no address
3370 failed outright but at least one could not be resolved for some reason. Return
3371 code 0 is given only when all addresses succeed.
3372
3373 .cindex "duplicate addresses"
3374 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3375 addresses after routing is complete, so that only one delivery takes place.
3376 This does not happen when testing with &%-bt%&; the full results of routing are
3377 always shown.
3378
3379 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3380 routers in the configuration makes any tests on the sender address of a
3381 message,
3382 .oindex "&%-f%&" "for address testing"
3383 you can use the &%-f%& option to set an appropriate sender when running
3384 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3385 default qualifying domain. However, if you have set up (for example) routers
3386 whose behaviour depends on the contents of an incoming message, you cannot test
3387 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3388 doing such tests.
3389
3390 .vitem &%-bV%&
3391 .oindex "&%-bV%&"
3392 .cindex "version number of Exim"
3393 This option causes Exim to write the current version number, compilation
3394 number, and compilation date of the &'exim'& binary to the standard output.
3395 It also lists the DBM library that is being used, the optional modules (such as
3396 specific lookup types), the drivers that are included in the binary, and the
3397 name of the run time configuration file that is in use.
3398
3399 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3400 configuration file. However, this is a static check only. It cannot check
3401 values that are to be expanded. For example, although a misspelt ACL verb is
3402 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3403 alone to discover (for example) all the typos in the configuration; some
3404 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3405 dynamic testing facilities.
3406
3407 .vitem &%-bv%&
3408 .oindex "&%-bv%&"
3409 .cindex "verifying address" "using &%-bv%&"
3410 .cindex "address" "verification"
3411 This option runs Exim in address verification mode, in which each argument is
3412 taken as a recipient address to be verified by the routers. (This does
3413 not involve any verification callouts). During normal operation, verification
3414 happens mostly as a consequence processing a &%verify%& condition in an ACL
3415 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3416 including callouts, see the &%-bh%& and &%-bhc%& options.
3417
3418 If verification fails, and the caller is not an admin user, no details of the
3419 failure are output, because these might contain sensitive information such as
3420 usernames and passwords for database lookups.
3421
3422 If no arguments are given, Exim runs in an interactive manner, prompting with a
3423 right angle bracket for addresses to be verified.
3424
3425 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3426 &[readline()]& function, because it is running as &'exim'& and there are
3427 security issues.
3428
3429 Verification differs from address testing (the &%-bt%& option) in that routers
3430 that have &%no_verify%& set are skipped, and if the address is accepted by a
3431 router that has &%fail_verify%& set, verification fails. The address is
3432 verified as a recipient if &%-bv%& is used; to test verification for a sender
3433 address, &%-bvs%& should be used.
3434
3435 If the &%-v%& option is not set, the output consists of a single line for each
3436 address, stating whether it was verified or not, and giving a reason in the
3437 latter case. Without &%-v%&, generating more than one address by redirection
3438 causes verification to end successfully, without considering the generated
3439 addresses. However, if just one address is generated, processing continues,
3440 and the generated address must verify successfully for the overall verification
3441 to succeed.
3442
3443 When &%-v%& is set, more details are given of how the address has been handled,
3444 and in the case of address redirection, all the generated addresses are also
3445 considered. Verification may succeed for some and fail for others.
3446
3447 The
3448 .cindex "return code" "for &%-bv%&"
3449 return code is 2 if any address failed outright; it is 1 if no address
3450 failed outright but at least one could not be resolved for some reason. Return
3451 code 0 is given only when all addresses succeed.
3452
3453 If any of the routers in the configuration makes any tests on the sender
3454 address of a message, you should use the &%-f%& option to set an appropriate
3455 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3456 calling user at the default qualifying domain.
3457
3458 .vitem &%-bvs%&
3459 .oindex "&%-bvs%&"
3460 This option acts like &%-bv%&, but verifies the address as a sender rather
3461 than a recipient address. This affects any rewriting and qualification that
3462 might happen.
3463
3464 .vitem &%-bw%&
3465 .oindex "&%-bw%&"
3466 .cindex "daemon"
3467 .cindex "inetd"
3468 .cindex "inetd" "wait mode"
3469 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3470 similarly to the &%-bd%& option.  All port specifications on the command-line
3471 and in the configuration file are ignored.  Queue-running may not be specified.
3472
3473 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3474 listening for connections.  This permits the system to start up and have
3475 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3476 each port only when the first connection is received.
3477
3478 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3479 which the daemon will exit, which should cause inetd to listen once more.
3480
3481 .vitem &%-C%&&~<&'filelist'&>
3482 .oindex "&%-C%&"
3483 .cindex "configuration file" "alternate"
3484 .cindex "CONFIGURE_FILE"
3485 .cindex "alternate configuration file"
3486 This option causes Exim to find the run time configuration file from the given
3487 list instead of from the list specified by the CONFIGURE_FILE
3488 compile-time setting. Usually, the list will consist of just a single file
3489 name, but it can be a colon-separated list of names. In this case, the first
3490 file that exists is used. Failure to open an existing file stops Exim from
3491 proceeding any further along the list, and an error is generated.
3492
3493 When this option is used by a caller other than root, and the list is different
3494 from the compiled-in list, Exim gives up its root privilege immediately, and
3495 runs with the real and effective uid and gid set to those of the caller.
3496 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3497 file contains a list of full pathnames, one per line, for configuration files
3498 which are trusted. Root privilege is retained for any configuration file so
3499 listed, as long as the caller is the Exim user (or the user specified in the
3500 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3501 not writeable by inappropriate users or groups.
3502
3503 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3504 configuration using &%-C%& right through message reception and delivery,
3505 even if the caller is root. The reception works, but by that time, Exim is
3506 running as the Exim user, so when it re-executes to regain privilege for the
3507 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3508 test reception and delivery using two separate commands (one to put a message
3509 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3510
3511 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3512 prefix string with which any file named in a &%-C%& command line option
3513 must start. In addition, the file name must not contain the sequence &`/../`&.
3514 However, if the value of the &%-C%& option is identical to the value of
3515 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3516 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3517 unset, any file name can be used with &%-C%&.
3518
3519 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3520 to a directory to which only root has access. This prevents someone who has
3521 broken into the Exim account from running a privileged Exim with an arbitrary
3522 configuration file.
3523
3524 The &%-C%& facility is useful for ensuring that configuration files are
3525 syntactically correct, but cannot be used for test deliveries, unless the
3526 caller is privileged, or unless it is an exotic configuration that does not
3527 require privilege. No check is made on the owner or group of the files
3528 specified by this option.
3529
3530
3531 .vitem &%-D%&<&'macro'&>=<&'value'&>
3532 .oindex "&%-D%&"
3533 .cindex "macro" "setting on command line"
3534 This option can be used to override macro definitions in the configuration file
3535 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3536 unprivileged caller, it causes Exim to give up its root privilege.
3537 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3538 completely disabled, and its use causes an immediate error exit.
3539
3540 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3541 colon-separated list of macros which are considered safe and, if &%-D%& only
3542 supplies macros from this list, and the values are acceptable, then Exim will
3543 not give up root privilege if the caller is root, the Exim run-time user, or
3544 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3545 to be removed in the future.  Acceptable values for the macros satisfy the
3546 regexp: &`^[A-Za-z0-9_/.-]*$`&
3547
3548 The entire option (including equals sign if present) must all be within one
3549 command line item. &%-D%& can be used to set the value of a macro to the empty
3550 string, in which case the equals sign is optional. These two commands are
3551 synonymous:
3552 .code
3553 exim -DABC  ...
3554 exim -DABC= ...
3555 .endd
3556 To include spaces in a macro definition item, quotes must be used. If you use
3557 quotes, spaces are permitted around the macro name and the equals sign. For
3558 example:
3559 .code
3560 exim '-D ABC = something' ...
3561 .endd
3562 &%-D%& may be repeated up to 10 times on a command line.
3563 Only macro names up to 22 letters long can be set.
3564
3565
3566 .vitem &%-d%&<&'debug&~options'&>
3567 .oindex "&%-d%&"
3568 .cindex "debugging" "list of selectors"
3569 .cindex "debugging" "&%-d%& option"
3570 This option causes debugging information to be written to the standard
3571 error stream. It is restricted to admin users because debugging output may show
3572 database queries that contain password information. Also, the details of users'
3573 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3574 writes an error message to the standard error stream and exits with a non-zero
3575 return code.
3576
3577 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3578 standard debugging data is output. This can be reduced, or increased to include
3579 some more rarely needed information, by directly following &%-d%& with a string
3580 made up of names preceded by plus or minus characters. These add or remove sets
3581 of debugging data, respectively. For example, &%-d+filter%& adds filter
3582 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3583 no spaces are allowed in the debug setting. The available debugging categories
3584 are:
3585 .display
3586 &`acl            `& ACL interpretation
3587 &`auth           `& authenticators
3588 &`deliver        `& general delivery logic
3589 &`dns            `& DNS lookups (see also resolver)
3590 &`dnsbl          `& DNS black list (aka RBL) code
3591 &`exec           `& arguments for &[execv()]& calls
3592 &`expand         `& detailed debugging for string expansions
3593 &`filter         `& filter handling
3594 &`hints_lookup   `& hints data lookups
3595 &`host_lookup    `& all types of name-to-IP address handling
3596 &`ident          `& ident lookup
3597 &`interface      `& lists of local interfaces
3598 &`lists          `& matching things in lists
3599 &`load           `& system load checks
3600 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3601                     &<<CHAPlocalscan>>&)
3602 &`lookup         `& general lookup code and all lookups
3603 &`memory         `& memory handling
3604 &`pid            `& add pid to debug output lines
3605 &`process_info   `& setting info for the process log
3606 &`queue_run      `& queue runs
3607 &`receive        `& general message reception logic
3608 &`resolver       `& turn on the DNS resolver's debugging output
3609 &`retry          `& retry handling
3610 &`rewrite        `& address rewriting
3611 &`route          `& address routing
3612 &`timestamp      `& add timestamp to debug output lines
3613 &`tls            `& TLS logic
3614 &`transport      `& transports
3615 &`uid            `& changes of uid/gid and looking up uid/gid
3616 &`verify         `& address verification logic
3617 &`all            `& almost all of the above (see below), and also &%-v%&
3618 .endd
3619 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3620 for &`-all`&. The reason for this is that &`+all`& is something that people
3621 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3622 is included, an awful lot of output that is very rarely of interest is
3623 generated, so it now has to be explicitly requested. However, &`-all`& does
3624 turn everything off.
3625
3626 .cindex "resolver, debugging output"
3627 .cindex "DNS resolver, debugging output"
3628 The &`resolver`& option produces output only if the DNS resolver was compiled
3629 with DEBUG enabled. This is not the case in some operating systems. Also,
3630 unfortunately, debugging output from the DNS resolver is written to stdout
3631 rather than stderr.
3632
3633 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3634 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3635 However, the &`pid`& selector is forced when debugging is turned on for a
3636 daemon, which then passes it on to any re-executed Exims. Exim also
3637 automatically adds the pid to debug lines when several remote deliveries are
3638 run in parallel.
3639
3640 The &`timestamp`& selector causes the current time to be inserted at the start
3641 of all debug output lines. This can be useful when trying to track down delays
3642 in processing.
3643
3644 If the &%debug_print%& option is set in any driver, it produces output whenever
3645 any debugging is selected, or if &%-v%& is used.
3646
3647 .vitem &%-dd%&<&'debug&~options'&>
3648 .oindex "&%-dd%&"
3649 This option behaves exactly like &%-d%& except when used on a command that
3650 starts a daemon process. In that case, debugging is turned off for the
3651 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3652 behaviour of the daemon without creating as much output as full debugging does.
3653
3654 .vitem &%-dropcr%&
3655 .oindex "&%-dropcr%&"
3656 This is an obsolete option that is now a no-op. It used to affect the way Exim
3657 handled CR and LF characters in incoming messages. What happens now is
3658 described in section &<<SECTlineendings>>&.
3659
3660 .vitem &%-E%&
3661 .oindex "&%-E%&"
3662 .cindex "bounce message" "generating"
3663 This option specifies that an incoming message is a locally-generated delivery
3664 failure report. It is used internally by Exim when handling delivery failures
3665 and is not intended for external use. Its only effect is to stop Exim
3666 generating certain messages to the postmaster, as otherwise message cascades
3667 could occur in some situations. As part of the same option, a message id may
3668 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3669 new message contains the id, following &"R="&, as a cross-reference.
3670
3671 .vitem &%-e%&&'x'&
3672 .oindex "&%-e%&&'x'&"
3673 There are a number of Sendmail options starting with &%-oe%& which seem to be
3674 called by various programs without the leading &%o%& in the option. For
3675 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3676 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3677
3678 .vitem &%-F%&&~<&'string'&>
3679 .oindex "&%-F%&"
3680 .cindex "sender" "name"
3681 .cindex "name" "of sender"
3682 This option sets the sender's full name for use when a locally-generated
3683 message is being accepted. In the absence of this option, the user's &'gecos'&
3684 entry from the password data is used. As users are generally permitted to alter
3685 their &'gecos'& entries, no security considerations are involved. White space
3686 between &%-F%& and the <&'string'&> is optional.
3687
3688 .vitem &%-f%&&~<&'address'&>
3689 .oindex "&%-f%&"
3690 .cindex "sender" "address"
3691 .cindex "address" "sender"
3692 .cindex "trusted users"
3693 .cindex "envelope sender"
3694 .cindex "user" "trusted"
3695 This option sets the address of the envelope sender of a locally-generated
3696 message (also known as the return path). The option can normally be used only
3697 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3698 users to use it.
3699
3700 Processes running as root or the Exim user are always trusted. Other
3701 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3702 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3703 of a local message is set to the caller's login name at the default qualify
3704 domain.
3705
3706 There is one exception to the restriction on the use of &%-f%&: an empty sender
3707 can be specified by any user, trusted or not, to create a message that can
3708 never provoke a bounce. An empty sender can be specified either as an empty
3709 string, or as a pair of angle brackets with nothing between them, as in these
3710 examples of shell commands:
3711 .code
3712 exim -f '<>' user@domain
3713 exim -f "" user@domain
3714 .endd
3715 In addition, the use of &%-f%& is not restricted when testing a filter file
3716 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3717 &%-bv%& options.
3718
3719 Allowing untrusted users to change the sender address does not of itself make
3720 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3721 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3722 though this can be overridden by setting &%no_local_from_check%&.
3723
3724 White
3725 .cindex "&""From""& line"
3726 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3727 given as two arguments or one combined argument). The sender of a
3728 locally-generated message can also be set (when permitted) by an initial
3729 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3730 if &%-f%& is also present, it overrides &"From&~"&.
3731
3732 .vitem &%-G%&
3733 .oindex "&%-G%&"
3734 .cindex "submission fixups, suppressing (command-line)"
3735 This option is equivalent to an ACL applying:
3736 .code
3737 control = suppress_local_fixups
3738 .endd
3739 for every message received.  Note that Sendmail will complain about such
3740 bad formatting, where Exim silently just does not fix it up.  This may change
3741 in future.
3742
3743 As this affects audit information, the caller must be a trusted user to use
3744 this option.
3745
3746 .vitem &%-h%&&~<&'number'&>
3747 .oindex "&%-h%&"
3748 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3749 This option is accepted for compatibility with Sendmail, but has no effect. (In
3750 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3751 headers.)
3752
3753 .vitem &%-i%&
3754 .oindex "&%-i%&"
3755 .cindex "Solaris" "&'mail'& command"
3756 .cindex "dot" "in incoming non-SMTP message"
3757 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3758 line by itself should not terminate an incoming, non-SMTP message. I can find
3759 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3760 command in Solaris 2.4 uses it. See also &%-ti%&.
3761
3762 .vitem &%-L%&&~<&'tag'&>
3763 .oindex "&%-L%&"
3764 .cindex "syslog" "process name; set with flag"
3765 This option is equivalent to setting &%syslog_processname%& in the config
3766 file and setting &%log_file_path%& to &`syslog`&.
3767 Its use is restricted to administrators.  The configuration file has to be
3768 read and parsed, to determine access rights, before this is set and takes
3769 effect, so early configuration file errors will not honour this flag.
3770
3771 The tag should not be longer than 32 characters.
3772
3773 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3774 .oindex "&%-M%&"
3775 .cindex "forcing delivery"
3776 .cindex "delivery" "forcing attempt"
3777 .cindex "frozen messages" "forcing delivery"
3778 This option requests Exim to run a delivery attempt on each message in turn. If
3779 any of the messages are frozen, they are automatically thawed before the
3780 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3781 and &%hold_domains%& are ignored.
3782
3783 Retry
3784 .cindex "hints database" "overriding retry hints"
3785 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3786 the normal retry time has not yet been reached. This option requires the caller
3787 to be an admin user. However, there is an option called &%prod_requires_admin%&
3788 which can be set false to relax this restriction (and also the same requirement
3789 for the &%-q%&, &%-R%&, and &%-S%& options).
3790
3791 The deliveries happen synchronously, that is, the original Exim process does
3792 not terminate until all the delivery attempts have finished. No output is
3793 produced unless there is a serious error. If you want to see what is happening,
3794 use the &%-v%& option as well, or inspect Exim's main log.
3795
3796 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3797 .oindex "&%-Mar%&"
3798 .cindex "message" "adding recipients"
3799 .cindex "recipient" "adding"
3800 This option requests Exim to add the addresses to the list of recipients of the
3801 message (&"ar"& for &"add recipients"&). The first argument must be a message
3802 id, and the remaining ones must be email addresses. However, if the message is
3803 active (in the middle of a delivery attempt), it is not altered. This option
3804 can be used only by an admin user.
3805
3806 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3807         &~<&'message&~id'&>"
3808 .oindex "&%-MC%&"
3809 .cindex "SMTP" "passed connection"
3810 .cindex "SMTP" "multiple deliveries"
3811 .cindex "multiple SMTP deliveries"
3812 This option is not intended for use by external callers. It is used internally
3813 by Exim to invoke another instance of itself to deliver a waiting message using
3814 an existing SMTP connection, which is passed as the standard input. Details are
3815 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3816 must be root or the Exim user in order to use it.
3817
3818 .vitem &%-MCA%&
3819 .oindex "&%-MCA%&"
3820 This option is not intended for use by external callers. It is used internally
3821 by Exim in conjunction with the &%-MC%& option. It signifies that the
3822 connection to the remote host has been authenticated.
3823
3824 .vitem &%-MCD%&
3825 .oindex "&%-MCD%&"
3826 This option is not intended for use by external callers. It is used internally
3827 by Exim in conjunction with the &%-MC%& option. It signifies that the
3828 remote host supports the ESMTP &_DSN_& extension.
3829
3830 .new
3831 .vitem &%-MCG%&
3832 .oindex "&%-MCG%&"
3833 This option is not intended for use by external callers. It is used internally
3834 by Exim in conjunction with the &%-MC%& option. It signifies that an
3835 alternate queue is used, named by the following option.
3836 .wen
3837
3838 .vitem &%-MCP%&
3839 .oindex "&%-MCP%&"
3840 This option is not intended for use by external callers. It is used internally
3841 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3842 which Exim is connected supports pipelining.
3843
3844 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3845 .oindex "&%-MCQ%&"
3846 This option is not intended for use by external callers. It is used internally
3847 by Exim in conjunction with the &%-MC%& option when the original delivery was
3848 started by a queue runner. It passes on the process id of the queue runner,
3849 together with the file descriptor number of an open pipe. Closure of the pipe
3850 signals the final completion of the sequence of processes that are passing
3851 messages through the same SMTP connection.
3852
3853 .vitem &%-MCS%&
3854 .oindex "&%-MCS%&"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3857 SMTP SIZE option should be used on messages delivered down the existing
3858 connection.
3859
3860 .vitem &%-MCT%&
3861 .oindex "&%-MCT%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3864 host to which Exim is connected supports TLS encryption.
3865
3866 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3867 .oindex "&%-Mc%&"
3868 .cindex "hints database" "not overridden by &%-Mc%&"
3869 .cindex "delivery" "manually started &-- not forced"
3870 This option requests Exim to run a delivery attempt on each message in turn,
3871 but unlike the &%-M%& option, it does check for retry hints, and respects any
3872 that are found. This option is not very useful to external callers. It is
3873 provided mainly for internal use by Exim when it needs to re-invoke itself in
3874 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3875 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3876 respects retry times and other options such as &%hold_domains%& that are
3877 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3878 If you want to run a specific delivery as if in a queue run, you should use
3879 &%-q%& with a message id argument. A distinction between queue run deliveries
3880 and other deliveries is made in one or two places.
3881
3882 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3883 .oindex "&%-Mes%&"
3884 .cindex "message" "changing sender"
3885 .cindex "sender" "changing"
3886 This option requests Exim to change the sender address in the message to the
3887 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3888 &"edit sender"&). There must be exactly two arguments. The first argument must
3889 be a message id, and the second one an email address. However, if the message
3890 is active (in the middle of a delivery attempt), its status is not altered.
3891 This option can be used only by an admin user.
3892
3893 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3894 .oindex "&%-Mf%&"
3895 .cindex "freezing messages"
3896 .cindex "message" "manually freezing"
3897 This option requests Exim to mark each listed message as &"frozen"&. This
3898 prevents any delivery attempts taking place until the message is &"thawed"&,
3899 either manually or as a result of the &%auto_thaw%& configuration option.
3900 However, if any of the messages are active (in the middle of a delivery
3901 attempt), their status is not altered. This option can be used only by an admin
3902 user.
3903
3904 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3905 .oindex "&%-Mg%&"
3906 .cindex "giving up on messages"
3907 .cindex "message" "abandoning delivery attempts"
3908 .cindex "delivery" "abandoning further attempts"
3909 This option requests Exim to give up trying to deliver the listed messages,
3910 including any that are frozen. However, if any of the messages are active,
3911 their status is not altered. For non-bounce messages, a delivery error message
3912 is sent to the sender, containing the text &"cancelled by administrator"&.
3913 Bounce messages are just discarded. This option can be used only by an admin
3914 user.
3915
3916 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mmad%&"
3918 .cindex "delivery" "cancelling all"
3919 This option requests Exim to mark all the recipient addresses in the messages
3920 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3921 message is active (in the middle of a delivery attempt), its status is not
3922 altered. This option can be used only by an admin user.
3923
3924 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3925 .oindex "&%-Mmd%&"
3926 .cindex "delivery" "cancelling by address"
3927 .cindex "recipient" "removing"
3928 .cindex "removing recipients"
3929 This option requests Exim to mark the given addresses as already delivered
3930 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3931 the remaining ones must be email addresses. These are matched to recipient
3932 addresses in the message in a case-sensitive manner. If the message is active
3933 (in the middle of a delivery attempt), its status is not altered. This option
3934 can be used only by an admin user.
3935
3936 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3937 .oindex "&%-Mrm%&"
3938 .cindex "removing messages"
3939 .cindex "abandoning mail"
3940 .cindex "message" "manually discarding"
3941 This option requests Exim to remove the given messages from the queue. No
3942 bounce messages are sent; each message is simply forgotten. However, if any of
3943 the messages are active, their status is not altered. This option can be used
3944 only by an admin user or by the user who originally caused the message to be
3945 placed on the queue.
3946
3947 .vitem &%-Mset%&&~<&'message&~id'&>
3948 .oindex "&%-Mset%&
3949 .cindex "testing" "string expansion"
3950 .cindex "expansion" "testing"
3951 This option is useful only in conjunction with &%-be%& (that is, when testing
3952 string expansions). Exim loads the given message from its spool before doing
3953 the test expansions, thus setting message-specific variables such as
3954 &$message_size$& and the header variables. The &$recipients$& variable is made
3955 available. This feature is provided to make it easier to test expansions that
3956 make use of these variables. However, this option can be used only by an admin
3957 user. See also &%-bem%&.
3958
3959 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mt%&"
3961 .cindex "thawing messages"
3962 .cindex "unfreezing messages"
3963 .cindex "frozen messages" "thawing"
3964 .cindex "message" "thawing frozen"
3965 This option requests Exim to &"thaw"& any of the listed messages that are
3966 &"frozen"&, so that delivery attempts can resume. However, if any of the
3967 messages are active, their status is not altered. This option can be used only
3968 by an admin user.
3969
3970 .vitem &%-Mvb%&&~<&'message&~id'&>
3971 .oindex "&%-Mvb%&"
3972 .cindex "listing" "message body"
3973 .cindex "message" "listing body of"
3974 This option causes the contents of the message body (-D) spool file to be
3975 written to the standard output. This option can be used only by an admin user.
3976
3977 .vitem &%-Mvc%&&~<&'message&~id'&>
3978 .oindex "&%-Mvc%&"
3979 .cindex "message" "listing in RFC 2822 format"
3980 .cindex "listing" "message in RFC 2822 format"
3981 This option causes a copy of the complete message (header lines plus body) to
3982 be written to the standard output in RFC 2822 format. This option can be used
3983 only by an admin user.
3984
3985 .vitem &%-Mvh%&&~<&'message&~id'&>
3986 .oindex "&%-Mvh%&"
3987 .cindex "listing" "message headers"
3988 .cindex "header lines" "listing"
3989 .cindex "message" "listing header lines"
3990 This option causes the contents of the message headers (-H) spool file to be
3991 written to the standard output. This option can be used only by an admin user.
3992
3993 .vitem &%-Mvl%&&~<&'message&~id'&>
3994 .oindex "&%-Mvl%&"
3995 .cindex "listing" "message log"
3996 .cindex "message" "listing message log"
3997 This option causes the contents of the message log spool file to be written to
3998 the standard output. This option can be used only by an admin user.
3999
4000 .vitem &%-m%&
4001 .oindex "&%-m%&"
4002 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4003 treats it that way too.
4004
4005 .vitem &%-N%&
4006 .oindex "&%-N%&"
4007 .cindex "debugging" "&%-N%& option"
4008 .cindex "debugging" "suppressing delivery"
4009 This is a debugging option that inhibits delivery of a message at the transport
4010 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4011 it just doesn't actually transport the message, but instead behaves as if it
4012 had successfully done so. However, it does not make any updates to the retry
4013 database, and the log entries for deliveries are flagged with &"*>"& rather
4014 than &"=>"&.
4015
4016 Because &%-N%& discards any message to which it applies, only root or the Exim
4017 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4018 words, an ordinary user can use it only when supplying an incoming message to
4019 which it will apply. Although transportation never fails when &%-N%& is set, an
4020 address may be deferred because of a configuration problem on a transport, or a
4021 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4022 the message, and applies to any subsequent delivery attempts that may happen
4023 for that message.
4024
4025 .vitem &%-n%&
4026 .oindex "&%-n%&"
4027 This option is interpreted by Sendmail to mean &"no aliasing"&.
4028 For normal modes of operation, it is ignored by Exim.
4029 When combined with &%-bP%& it makes the output more terse (suppresses
4030 option names, environment values and config pretty printing).
4031
4032 .vitem &%-O%&&~<&'data'&>
4033 .oindex "&%-O%&"
4034 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4035 Exim.
4036
4037 .vitem &%-oA%&&~<&'file&~name'&>
4038 .oindex "&%-oA%&"
4039 .cindex "Sendmail compatibility" "&%-oA%& option"
4040 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4041 alternative alias file name. Exim handles &%-bi%& differently; see the
4042 description above.
4043
4044 .vitem &%-oB%&&~<&'n'&>
4045 .oindex "&%-oB%&"
4046 .cindex "SMTP" "passed connection"
4047 .cindex "SMTP" "multiple deliveries"
4048 .cindex "multiple SMTP deliveries"
4049 This is a debugging option which limits the maximum number of messages that can
4050 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4051 transport. If <&'n'&> is omitted, the limit is set to 1.
4052
4053 .vitem &%-odb%&
4054 .oindex "&%-odb%&"
4055 .cindex "background delivery"
4056 .cindex "delivery" "in the background"
4057 This option applies to all modes in which Exim accepts incoming messages,
4058 including the listening daemon. It requests &"background"& delivery of such
4059 messages, which means that the accepting process automatically starts a
4060 delivery process for each message received, but does not wait for the delivery
4061 processes to finish.
4062
4063 When all the messages have been received, the reception process exits,
4064 leaving the delivery processes to finish in their own time. The standard output
4065 and error streams are closed at the start of each delivery process.
4066 This is the default action if none of the &%-od%& options are present.
4067
4068 If one of the queueing options in the configuration file
4069 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4070 overrides it if &%queue_only_override%& is set true, which is the default
4071 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4072
4073 .vitem &%-odf%&
4074 .oindex "&%-odf%&"
4075 .cindex "foreground delivery"
4076 .cindex "delivery" "in the foreground"
4077 This option requests &"foreground"& (synchronous) delivery when Exim has
4078 accepted a locally-generated message. (For the daemon it is exactly the same as
4079 &%-odb%&.) A delivery process is automatically started to deliver the message,
4080 and Exim waits for it to complete before proceeding.
4081
4082 The original Exim reception process does not finish until the delivery
4083 process for the final message has ended. The standard error stream is left open
4084 during deliveries.
4085
4086 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4087 false and one of the queueing options in the configuration file is in effect.
4088
4089 If there is a temporary delivery error during foreground delivery, the
4090 message is left on the queue for later delivery, and the original reception
4091 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4092 restricted configuration that never queues messages.
4093
4094
4095 .vitem &%-odi%&
4096 .oindex "&%-odi%&"
4097 This option is synonymous with &%-odf%&. It is provided for compatibility with
4098 Sendmail.
4099
4100 .vitem &%-odq%&
4101 .oindex "&%-odq%&"
4102 .cindex "non-immediate delivery"
4103 .cindex "delivery" "suppressing immediate"
4104 .cindex "queueing incoming messages"
4105 This option applies to all modes in which Exim accepts incoming messages,
4106 including the listening daemon. It specifies that the accepting process should
4107 not automatically start a delivery process for each message received. Messages
4108 are placed on the queue, and remain there until a subsequent queue runner
4109 process encounters them. There are several configuration options (such as
4110 &%queue_only%&) that can be used to queue incoming messages under certain
4111 conditions. This option overrides all of them and also &%-odqs%&. It always
4112 forces queueing.
4113
4114 .vitem &%-odqs%&
4115 .oindex "&%-odqs%&"
4116 .cindex "SMTP" "delaying delivery"
4117 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4118 However, like &%-odb%& and &%-odi%&, this option has no effect if
4119 &%queue_only_override%& is false and one of the queueing options in the
4120 configuration file is in effect.
4121
4122 When &%-odqs%& does operate, a delivery process is started for each incoming
4123 message, in the background by default, but in the foreground if &%-odi%& is
4124 also present. The recipient addresses are routed, and local deliveries are done
4125 in the normal way. However, if any SMTP deliveries are required, they are not
4126 done at this time, so the message remains on the queue until a subsequent queue
4127 runner process encounters it. Because routing was done, Exim knows which
4128 messages are waiting for which hosts, and so a number of messages for the same
4129 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4130 configuration option has the same effect for specific domains. See also the
4131 &%-qq%& option.
4132
4133 .vitem &%-oee%&
4134 .oindex "&%-oee%&"
4135 .cindex "error" "reporting"
4136 If an error is detected while a non-SMTP message is being received (for
4137 example, a malformed address), the error is reported to the sender in a mail
4138 message.
4139
4140 .cindex "return code" "for &%-oee%&"
4141 Provided
4142 this error message is successfully sent, the Exim receiving process
4143 exits with a return code of zero. If not, the return code is 2 if the problem
4144 is that the original message has no recipients, or 1 for any other error.
4145 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4146
4147 .vitem &%-oem%&
4148 .oindex "&%-oem%&"
4149 .cindex "error" "reporting"
4150 .cindex "return code" "for &%-oem%&"
4151 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4152 return code, whether or not the error message was successfully sent.
4153 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4154
4155 .vitem &%-oep%&
4156 .oindex "&%-oep%&"
4157 .cindex "error" "reporting"
4158 If an error is detected while a non-SMTP message is being received, the
4159 error is reported by writing a message to the standard error file (stderr).
4160 .cindex "return code" "for &%-oep%&"
4161 The return code is 1 for all errors.
4162
4163 .vitem &%-oeq%&
4164 .oindex "&%-oeq%&"
4165 .cindex "error" "reporting"
4166 This option is supported for compatibility with Sendmail, but has the same
4167 effect as &%-oep%&.
4168
4169 .vitem &%-oew%&
4170 .oindex "&%-oew%&"
4171 .cindex "error" "reporting"
4172 This option is supported for compatibility with Sendmail, but has the same
4173 effect as &%-oem%&.
4174
4175 .vitem &%-oi%&
4176 .oindex "&%-oi%&"
4177 .cindex "dot" "in incoming non-SMTP message"
4178 This option, which has the same effect as &%-i%&, specifies that a dot on a
4179 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4180 single dot does terminate, though Exim does no special processing for other
4181 lines that start with a dot. This option is set by default if Exim is called as
4182 &'rmail'&. See also &%-ti%&.
4183
4184 .vitem &%-oitrue%&
4185 .oindex "&%-oitrue%&"
4186 This option is treated as synonymous with &%-oi%&.
4187
4188 .vitem &%-oMa%&&~<&'host&~address'&>
4189 .oindex "&%-oMa%&"
4190 .cindex "sender" "host address, specifying for local message"
4191 A number of options starting with &%-oM%& can be used to set values associated
4192 with remote hosts on locally-submitted messages (that is, messages not received
4193 over TCP/IP). These options can be used by any caller in conjunction with the
4194 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4195 other circumstances, they are ignored unless the caller is trusted.
4196
4197 The &%-oMa%& option sets the sender host address. This may include a port
4198 number at the end, after a full stop (period). For example:
4199 .code
4200 exim -bs -oMa 10.9.8.7.1234
4201 .endd
4202 An alternative syntax is to enclose the IP address in square brackets,
4203 followed by a colon and the port number:
4204 .code
4205 exim -bs -oMa [10.9.8.7]:1234
4206 .endd
4207 The IP address is placed in the &$sender_host_address$& variable, and the
4208 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4209 are present on the command line, the sender host IP address is taken from
4210 whichever one is last.
4211
4212 .vitem &%-oMaa%&&~<&'name'&>
4213 .oindex "&%-oMaa%&"
4214 .cindex "authentication" "name, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4216 option sets the value of &$sender_host_authenticated$& (the authenticator
4217 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4218 This option can be used with &%-bh%& and &%-bs%& to set up an
4219 authenticated SMTP session without actually using the SMTP AUTH command.
4220
4221 .vitem &%-oMai%&&~<&'string'&>
4222 .oindex "&%-oMai%&"
4223 .cindex "authentication" "id, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4225 option sets the value of &$authenticated_id$& (the id that was authenticated).
4226 This overrides the default value (the caller's login id, except with &%-bh%&,
4227 where there is no default) for messages from local sources. See chapter
4228 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4229
4230 .vitem &%-oMas%&&~<&'address'&>
4231 .oindex "&%-oMas%&"
4232 .cindex "authentication" "sender, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4234 option sets the authenticated sender value in &$authenticated_sender$&. It
4235 overrides the sender address that is created from the caller's login id for
4236 messages from local sources, except when &%-bh%& is used, when there is no
4237 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4238 specified on a MAIL command overrides this value. See chapter
4239 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4240
4241 .vitem &%-oMi%&&~<&'interface&~address'&>
4242 .oindex "&%-oMi%&"
4243 .cindex "interface" "address, specifying for local message"
4244 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4245 option sets the IP interface address value. A port number may be included,
4246 using the same syntax as for &%-oMa%&. The interface address is placed in
4247 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4248
4249 .vitem &%-oMm%&&~<&'message&~reference'&>
4250 .oindex "&%-oMm%&"
4251 .cindex "message reference" "message reference, specifying for local message"
4252 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4253 option sets the message reference, e.g. message-id, and is logged during
4254 delivery. This is useful when some kind of audit trail is required to tie
4255 messages together. The format of the message reference is checked and will
4256 abort if the format is invalid. The option will only be accepted if exim is
4257 running in trusted mode, not as any regular user.
4258
4259 The best example of a message reference is when Exim sends a bounce message.
4260 The message reference is the message-id of the original message for which Exim
4261 is sending the bounce.
4262
4263 .vitem &%-oMr%&&~<&'protocol&~name'&>
4264 .oindex "&%-oMr%&"
4265 .cindex "protocol, specifying for local message"
4266 .vindex "&$received_protocol$&"
4267 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4268 option sets the received protocol value that is stored in
4269 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4270 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4271 SMTP protocol names (see the description of &$received_protocol$& in section
4272 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4273 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4274 be set by &%-oMr%&.
4275
4276 .vitem &%-oMs%&&~<&'host&~name'&>
4277 .oindex "&%-oMs%&"
4278 .cindex "sender" "host name, specifying for local message"
4279 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4280 option sets the sender host name in &$sender_host_name$&. When this option is
4281 present, Exim does not attempt to look up a host name from an IP address; it
4282 uses the name it is given.
4283
4284 .vitem &%-oMt%&&~<&'ident&~string'&>
4285 .oindex "&%-oMt%&"
4286 .cindex "sender" "ident string, specifying for local message"
4287 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4288 option sets the sender ident value in &$sender_ident$&. The default setting for
4289 local callers is the login id of the calling process, except when &%-bh%& is
4290 used, when there is no default.
4291
4292 .vitem &%-om%&
4293 .oindex "&%-om%&"
4294 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4295 In Sendmail, this option means &"me too"&, indicating that the sender of a
4296 message should receive a copy of the message if the sender appears in an alias
4297 expansion. Exim always does this, so the option does nothing.
4298
4299 .vitem &%-oo%&
4300 .oindex "&%-oo%&"
4301 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4302 This option is ignored. In Sendmail it specifies &"old style headers"&,
4303 whatever that means.
4304
4305 .vitem &%-oP%&&~<&'path'&>
4306 .oindex "&%-oP%&"
4307 .cindex "pid (process id)" "of daemon"
4308 .cindex "daemon" "process id (pid)"
4309 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4310 value. The option specifies the file to which the process id of the daemon is
4311 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4312 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4313 because in those cases, the normal pid file is not used.
4314
4315 .vitem &%-or%&&~<&'time'&>
4316 .oindex "&%-or%&"
4317 .cindex "timeout" "for non-SMTP input"
4318 This option sets a timeout value for incoming non-SMTP messages. If it is not
4319 set, Exim will wait forever for the standard input. The value can also be set
4320 by the &%receive_timeout%& option. The format used for specifying times is
4321 described in section &<<SECTtimeformat>>&.
4322
4323 .vitem &%-os%&&~<&'time'&>
4324 .oindex "&%-os%&"
4325 .cindex "timeout" "for SMTP input"
4326 .cindex "SMTP" "input timeout"
4327 This option sets a timeout value for incoming SMTP messages. The timeout
4328 applies to each SMTP command and block of data. The value can also be set by
4329 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4330 for specifying times is described in section &<<SECTtimeformat>>&.
4331
4332 .vitem &%-ov%&
4333 .oindex "&%-ov%&"
4334 This option has exactly the same effect as &%-v%&.
4335
4336 .vitem &%-oX%&&~<&'number&~or&~string'&>
4337 .oindex "&%-oX%&"
4338 .cindex "TCP/IP" "setting listening ports"
4339 .cindex "TCP/IP" "setting listening interfaces"
4340 .cindex "port" "receiving TCP/IP"
4341 This option is relevant only when the &%-bd%& (start listening daemon) option
4342 is also given. It controls which ports and interfaces the daemon uses. Details
4343 of the syntax, and how it interacts with configuration file options, are given
4344 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4345 file is written unless &%-oP%& is also present to specify a pid file name.
4346
4347 .vitem &%-pd%&
4348 .oindex "&%-pd%&"
4349 .cindex "Perl" "starting the interpreter"
4350 This option applies when an embedded Perl interpreter is linked with Exim (see
4351 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4352 option, forcing the starting of the interpreter to be delayed until it is
4353 needed.
4354
4355 .vitem &%-ps%&
4356 .oindex "&%-ps%&"
4357 .cindex "Perl" "starting the interpreter"
4358 This option applies when an embedded Perl interpreter is linked with Exim (see
4359 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4360 option, forcing the starting of the interpreter to occur as soon as Exim is
4361 started.
4362
4363 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4364 .oindex "&%-p%&"
4365 For compatibility with Sendmail, this option is equivalent to
4366 .display
4367 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4368 .endd
4369 It sets the incoming protocol and host name (for trusted callers). The
4370 host name and its colon can be omitted when only the protocol is to be set.
4371 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4372 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4373 or &`s`& using this option (but that does not seem a real limitation).
4374
4375 .vitem &%-q%&
4376 .oindex "&%-q%&"
4377 .cindex "queue runner" "starting manually"
4378 This option is normally restricted to admin users. However, there is a
4379 configuration option called &%prod_requires_admin%& which can be set false to
4380 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4381 and &%-S%& options).
4382
4383 .cindex "queue runner" "description of operation"
4384 .new
4385 If other commandline options do not specify an action,
4386 .wen
4387 the &%-q%& option starts one queue runner process. This scans the queue of
4388 waiting messages, and runs a delivery process for each one in turn. It waits
4389 for each delivery process to finish before starting the next one. A delivery
4390 process may not actually do any deliveries if the retry times for the addresses
4391 have not been reached. Use &%-qf%& (see below) if you want to override this.
4392
4393 If
4394 .cindex "SMTP" "passed connection"
4395 .cindex "SMTP" "multiple deliveries"
4396 .cindex "multiple SMTP deliveries"
4397 the delivery process spawns other processes to deliver other messages down
4398 passed SMTP connections, the queue runner waits for these to finish before
4399 proceeding.
4400
4401 When all the queued messages have been considered, the original queue runner
4402 process terminates. In other words, a single pass is made over the waiting
4403 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4404 this to be repeated periodically.
4405
4406 Exim processes the waiting messages in an unpredictable order. It isn't very
4407 random, but it is likely to be different each time, which is all that matters.
4408 If one particular message screws up a remote MTA, other messages to the same
4409 MTA have a chance of getting through if they get tried first.
4410
4411 It is possible to cause the messages to be processed in lexical message id
4412 order, which is essentially the order in which they arrived, by setting the
4413 &%queue_run_in_order%& option, but this is not recommended for normal use.
4414
4415 .vitem &%-q%&<&'qflags'&>
4416 The &%-q%& option may be followed by one or more flag letters that change its
4417 behaviour. They are all optional, but if more than one is present, they must
4418 appear in the correct order. Each flag is described in a separate item below.
4419
4420 .vitem &%-qq...%&
4421 .oindex "&%-qq%&"
4422 .cindex "queue" "double scanning"
4423 .cindex "queue" "routing"
4424 .cindex "routing" "whole queue before delivery"
4425 An option starting with &%-qq%& requests a two-stage queue run. In the first
4426 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4427 every domain. Addresses are routed, local deliveries happen, but no remote
4428 transports are run.
4429
4430 .cindex "hints database" "remembering routing"
4431 The hints database that remembers which messages are waiting for specific hosts
4432 is updated, as if delivery to those hosts had been deferred. After this is
4433 complete, a second, normal queue scan happens, with routing and delivery taking
4434 place as normal. Messages that are routed to the same host should mostly be
4435 delivered down a single SMTP
4436 .cindex "SMTP" "passed connection"
4437 .cindex "SMTP" "multiple deliveries"
4438 .cindex "multiple SMTP deliveries"
4439 connection because of the hints that were set up during the first queue scan.
4440 This option may be useful for hosts that are connected to the Internet
4441 intermittently.
4442
4443 .vitem &%-q[q]i...%&
4444 .oindex "&%-qi%&"
4445 .cindex "queue" "initial delivery"
4446 If the &'i'& flag is present, the queue runner runs delivery processes only for
4447 those messages that haven't previously been tried. (&'i'& stands for &"initial
4448 delivery"&.) This can be helpful if you are putting messages on the queue using
4449 &%-odq%& and want a queue runner just to process the new messages.
4450
4451 .vitem &%-q[q][i]f...%&
4452 .oindex "&%-qf%&"
4453 .cindex "queue" "forcing delivery"
4454 .cindex "delivery" "forcing in queue run"
4455 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4456 message, whereas without &'f'& only those non-frozen addresses that have passed
4457 their retry times are tried.
4458
4459 .vitem &%-q[q][i]ff...%&
4460 .oindex "&%-qff%&"
4461 .cindex "frozen messages" "forcing delivery"
4462 If &'ff'& is present, a delivery attempt is forced for every message, whether
4463 frozen or not.
4464
4465 .vitem &%-q[q][i][f[f]]l%&
4466 .oindex "&%-ql%&"
4467 .cindex "queue" "local deliveries only"
4468 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4469 be done. If a message requires any remote deliveries, it remains on the queue
4470 for later delivery.
4471
4472 .new
4473 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4474 .oindex "&%-qG%&"
4475 .cindex queue named
4476 .cindex "named queues"
4477 .cindex "queue" "delivering specific messages"
4478 If the &'G'& flag and a name is present, the queue runner operates on the
4479 queue with the given name rather than the default queue.
4480 The name should not contain a &'/'& character.
4481 For a periodic queue run (see below)
4482 append to the name a slash and a time value.
4483
4484 If other commandline options speicify an action, a &'-qG<name>'& option
4485 will specify a queue to operate on.
4486 For example:
4487 .code
4488 exim -bp -qGquarantine
4489 mailq -qGquarantime
4490 exim -qGoffpeak -Rf @special.domain.example
4491 .endd
4492 .wen
4493
4494 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4495 When scanning the queue, Exim can be made to skip over messages whose ids are
4496 lexically less than a given value by following the &%-q%& option with a
4497 starting message id. For example:
4498 .code
4499 exim -q 0t5C6f-0000c8-00
4500 .endd
4501 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4502 second message id is given, messages whose ids are lexically greater than it
4503 are also skipped. If the same id is given twice, for example,
4504 .code
4505 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4506 .endd
4507 just one delivery process is started, for that message. This differs from
4508 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4509 that it counts as a delivery from a queue run. Note that the selection
4510 mechanism does not affect the order in which the messages are scanned. There
4511 are also other ways of selecting specific sets of messages for delivery in a
4512 queue run &-- see &%-R%& and &%-S%&.
4513
4514 .vitem &%-q%&<&'qflags'&><&'time'&>
4515 .cindex "queue runner" "starting periodically"
4516 .cindex "periodic queue running"
4517 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4518 starting a queue runner process at intervals specified by the given time value
4519 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4520 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4521 single daemon process handles both functions. A common way of starting up a
4522 combined daemon at system boot time is to use a command such as
4523 .code
4524 /usr/exim/bin/exim -bd -q30m
4525 .endd
4526 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4527 process every 30 minutes.
4528
4529 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4530 pid file is written unless one is explicitly requested by the &%-oP%& option.
4531
4532 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4533 .oindex "&%-qR%&"
4534 This option is synonymous with &%-R%&. It is provided for Sendmail
4535 compatibility.
4536
4537 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4538 .oindex "&%-qS%&"
4539 This option is synonymous with &%-S%&.
4540
4541 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4542 .oindex "&%-R%&"
4543 .cindex "queue runner" "for specific recipients"
4544 .cindex "delivery" "to given domain"
4545 .cindex "domain" "delivery to"
4546 The <&'rsflags'&> may be empty, in which case the white space before the string
4547 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4548 which are the possible values for <&'rsflags'&>. White space is required if
4549 <&'rsflags'&> is not empty.
4550
4551 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4552 perform a single queue run, except that, when scanning the messages on the
4553 queue, Exim processes only those that have at least one undelivered recipient
4554 address containing the given string, which is checked in a case-independent
4555 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4556 regular expression; otherwise it is a literal string.
4557
4558 If you want to do periodic queue runs for messages with specific recipients,
4559 you can combine &%-R%& with &%-q%& and a time value. For example:
4560 .code
4561 exim -q25m -R @special.domain.example
4562 .endd
4563 This example does a queue run for messages with recipients in the given domain
4564 every 25 minutes. Any additional flags that are specified with &%-q%& are
4565 applied to each queue run.
4566
4567 Once a message is selected for delivery by this mechanism, all its addresses
4568 are processed. For the first selected message, Exim overrides any retry
4569 information and forces a delivery attempt for each undelivered address. This
4570 means that if delivery of any address in the first message is successful, any
4571 existing retry information is deleted, and so delivery attempts for that
4572 address in subsequently selected messages (which are processed without forcing)
4573 will run. However, if delivery of any address does not succeed, the retry
4574 information is updated, and in subsequently selected messages, the failing
4575 address will be skipped.
4576
4577 .cindex "frozen messages" "forcing delivery"
4578 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4579 all selected messages, not just the first; frozen messages are included when
4580 &'ff'& is present.
4581
4582 The &%-R%& option makes it straightforward to initiate delivery of all messages
4583 to a given domain after a host has been down for some time. When the SMTP
4584 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4585 effect is to run Exim with the &%-R%& option, but it can be configured to run
4586 an arbitrary command instead.
4587
4588 .vitem &%-r%&
4589 .oindex "&%-r%&"
4590 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4591
4592 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4593 .oindex "&%-S%&"
4594 .cindex "delivery" "from given sender"
4595 .cindex "queue runner" "for specific senders"
4596 This option acts like &%-R%& except that it checks the string against each
4597 message's sender instead of against the recipients. If &%-R%& is also set, both
4598 conditions must be met for a message to be selected. If either of the options
4599 has &'f'& or &'ff'& in its flags, the associated action is taken.
4600
4601 .vitem &%-Tqt%&&~<&'times'&>
4602 .oindex "&%-Tqt%&"
4603 This is an option that is exclusively for use by the Exim testing suite. It is not
4604 recognized when Exim is run normally. It allows for the setting up of explicit
4605 &"queue times"& so that various warning/retry features can be tested.
4606
4607 .vitem &%-t%&
4608 .oindex "&%-t%&"
4609 .cindex "recipient" "extracting from header lines"
4610 .cindex "&'Bcc:'& header line"
4611 .cindex "&'Cc:'& header line"
4612 .cindex "&'To:'& header line"
4613 When Exim is receiving a locally-generated, non-SMTP message on its standard
4614 input, the &%-t%& option causes the recipients of the message to be obtained
4615 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4616 from the command arguments. The addresses are extracted before any rewriting
4617 takes place and the &'Bcc:'& header line, if present, is then removed.
4618
4619 .cindex "Sendmail compatibility" "&%-t%& option"
4620 If the command has any arguments, they specify addresses to which the message
4621 is &'not'& to be delivered. That is, the argument addresses are removed from
4622 the recipients list obtained from the headers. This is compatible with Smail 3
4623 and in accordance with the documented behaviour of several versions of
4624 Sendmail, as described in man pages on a number of operating systems (e.g.
4625 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4626 argument addresses to those obtained from the headers, and the O'Reilly
4627 Sendmail book documents it that way. Exim can be made to add argument addresses
4628 instead of subtracting them by setting the option
4629 &%extract_addresses_remove_arguments%& false.
4630
4631 .cindex "&%Resent-%& header lines" "with &%-t%&"
4632 If there are any &%Resent-%& header lines in the message, Exim extracts
4633 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4634 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4635 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4636 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4637
4638 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4639 message is resent several times). The RFC also specifies that they should be
4640 added at the front of the message, and separated by &'Received:'& lines. It is
4641 not at all clear how &%-t%& should operate in the present of multiple sets,
4642 nor indeed exactly what constitutes a &"set"&.
4643 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4644 are often added at the end of the header, and if a message is resent more than
4645 once, it is common for the original set of &%Resent-%& headers to be renamed as
4646 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4647
4648 .vitem &%-ti%&
4649 .oindex "&%-ti%&"
4650 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4651 compatibility with Sendmail.
4652
4653 .vitem &%-tls-on-connect%&
4654 .oindex "&%-tls-on-connect%&"
4655 .cindex "TLS" "use without STARTTLS"
4656 .cindex "TLS" "automatic start"
4657 This option is available when Exim is compiled with TLS support. It forces all
4658 incoming SMTP connections to behave as if the incoming port is listed in the
4659 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4660 &<<CHAPTLS>>& for further details.
4661
4662
4663 .vitem &%-U%&
4664 .oindex "&%-U%&"
4665 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4666 Sendmail uses this option for &"initial message submission"&, and its
4667 documentation states that in future releases, it may complain about
4668 syntactically invalid messages rather than fixing them when this flag is not
4669 set. Exim ignores this option.
4670
4671 .vitem &%-v%&
4672 .oindex "&%-v%&"
4673 This option causes Exim to write information to the standard error stream,
4674 describing what it is doing. In particular, it shows the log lines for
4675 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4676 dialogue is shown. Some of the log lines shown may not actually be written to
4677 the log if the setting of &%log_selector%& discards them. Any relevant
4678 selectors are shown with each log line. If none are shown, the logging is
4679 unconditional.
4680
4681 .vitem &%-x%&
4682 .oindex "&%-x%&"
4683 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4684 National Language Support extended characters in the body of the mail item"&).
4685 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4686 this option.
4687
4688 .vitem &%-X%&&~<&'logfile'&>
4689 .oindex "&%-X%&"
4690 This option is interpreted by Sendmail to cause debug information to be sent
4691 to the named file.  It is ignored by Exim.
4692
4693 .vitem &%-z%&&~<&'log-line'&>
4694 .oindex "&%-z%&"
4695 This option writes its argument to Exim's logfile.
4696 Use is restricted to administrators; the intent is for operational notes.
4697 Quotes should be used to maintain a multi-word item as a single argument,
4698 under most shells.
4699 .endlist
4700
4701 .ecindex IIDclo1
4702 .ecindex IIDclo2
4703
4704
4705 . ////////////////////////////////////////////////////////////////////////////
4706 . Insert a stylized DocBook comment here, to identify the end of the command
4707 . line options. This is for the benefit of the Perl script that automatically
4708 . creates a man page for the options.
4709 . ////////////////////////////////////////////////////////////////////////////
4710
4711 .literal xml
4712 <!-- === End of command line options === -->
4713 .literal off
4714
4715
4716
4717
4718
4719 . ////////////////////////////////////////////////////////////////////////////
4720 . ////////////////////////////////////////////////////////////////////////////
4721
4722
4723 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4724          "The runtime configuration file"
4725
4726 .cindex "run time configuration"
4727 .cindex "configuration file" "general description"
4728 .cindex "CONFIGURE_FILE"
4729 .cindex "configuration file" "errors in"
4730 .cindex "error" "in configuration file"
4731 .cindex "return code" "for bad configuration"
4732 Exim uses a single run time configuration file that is read whenever an Exim
4733 binary is executed. Note that in normal operation, this happens frequently,
4734 because Exim is designed to operate in a distributed manner, without central
4735 control.
4736
4737 If a syntax error is detected while reading the configuration file, Exim
4738 writes a message on the standard error, and exits with a non-zero return code.
4739 The message is also written to the panic log. &*Note*&: Only simple syntax
4740 errors can be detected at this time. The values of any expanded options are
4741 not checked until the expansion happens, even when the expansion does not
4742 actually alter the string.
4743
4744 The name of the configuration file is compiled into the binary for security
4745 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4746 most configurations, this specifies a single file. However, it is permitted to
4747 give a colon-separated list of file names, in which case Exim uses the first
4748 existing file in the list.
4749
4750 .cindex "EXIM_USER"
4751 .cindex "EXIM_GROUP"
4752 .cindex "CONFIGURE_OWNER"
4753 .cindex "CONFIGURE_GROUP"
4754 .cindex "configuration file" "ownership"
4755 .cindex "ownership" "configuration file"
4756 The run time configuration file must be owned by root or by the user that is
4757 specified at compile time by the CONFIGURE_OWNER option (if set). The
4758 configuration file must not be world-writeable, or group-writeable unless its
4759 group is the root group or the one specified at compile time by the
4760 CONFIGURE_GROUP option.
4761
4762 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4763 to root, anybody who is able to edit the run time configuration file has an
4764 easy way to run commands as root. If you specify a user or group in the
4765 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4766 who are members of that group will trivially be able to obtain root privileges.
4767
4768 Up to Exim version 4.72, the run time configuration file was also permitted to
4769 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4770 since it offered a simple privilege escalation for any attacker who managed to
4771 compromise the Exim user account.
4772
4773 A default configuration file, which will work correctly in simple situations,
4774 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4775 defines just one file name, the installation process copies the default
4776 configuration to a new file of that name if it did not previously exist. If
4777 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4778 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4779 configuration.
4780
4781
4782
4783 .section "Using a different configuration file" "SECID40"
4784 .cindex "configuration file" "alternate"
4785 A one-off alternate configuration can be specified by the &%-C%& command line
4786 option, which may specify a single file or a list of files. However, when
4787 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4788 unless the argument for &%-C%& is identical to the built-in value from
4789 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4790 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4791 is useful mainly for checking the syntax of configuration files before
4792 installing them. No owner or group checks are done on a configuration file
4793 specified by &%-C%&, if root privilege has been dropped.
4794
4795 Even the Exim user is not trusted to specify an arbitrary configuration file
4796 with the &%-C%& option to be used with root privileges, unless that file is
4797 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4798 testing a configuration using &%-C%& right through message reception and
4799 delivery, even if the caller is root. The reception works, but by that time,
4800 Exim is running as the Exim user, so when it re-execs to regain privilege for
4801 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4802 can test reception and delivery using two separate commands (one to put a
4803 message on the queue, using &%-odq%&, and another to do the delivery, using
4804 &%-M%&).
4805
4806 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4807 prefix string with which any file named in a &%-C%& command line option must
4808 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4809 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4810 name can be used with &%-C%&.
4811
4812 One-off changes to a configuration can be specified by the &%-D%& command line
4813 option, which defines and overrides values for macros used inside the
4814 configuration file. However, like &%-C%&, the use of this option by a
4815 non-privileged user causes Exim to discard its root privilege.
4816 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4817 completely disabled, and its use causes an immediate error exit.
4818
4819 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4820 to declare certain macro names trusted, such that root privilege will not
4821 necessarily be discarded.
4822 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4823 considered safe and, if &%-D%& only supplies macros from this list, and the
4824 values are acceptable, then Exim will not give up root privilege if the caller
4825 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4826 transition mechanism and is expected to be removed in the future.  Acceptable
4827 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4828
4829 Some sites may wish to use the same Exim binary on different machines that
4830 share a file system, but to use different configuration files on each machine.
4831 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4832 looks for a file whose name is the configuration file name followed by a dot
4833 and the machine's node name, as obtained from the &[uname()]& function. If this
4834 file does not exist, the standard name is tried. This processing occurs for
4835 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4836
4837 In some esoteric situations different versions of Exim may be run under
4838 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4839 help with this. See the comments in &_src/EDITME_& for details.
4840
4841
4842
4843 .section "Configuration file format" "SECTconffilfor"
4844 .cindex "configuration file" "format of"
4845 .cindex "format" "configuration file"
4846 Exim's configuration file is divided into a number of different parts. General
4847 option settings must always appear at the start of the file. The other parts
4848 are all optional, and may appear in any order. Each part other than the first
4849 is introduced by the word &"begin"& followed by at least one literal
4850 space, and the name of the part. The optional parts are:
4851
4852 .ilist
4853 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4854 &<<CHAPACL>>&).
4855 .next
4856 .cindex "AUTH" "configuration"
4857 &'authenticators'&: Configuration settings for the authenticator drivers. These
4858 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4859 .next
4860 &'routers'&: Configuration settings for the router drivers. Routers process
4861 addresses and determine how the message is to be delivered (see chapters
4862 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4863 .next
4864 &'transports'&: Configuration settings for the transport drivers. Transports
4865 define mechanisms for copying messages to destinations (see chapters
4866 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4867 .next
4868 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4869 If there is no retry section, or if it is empty (that is, no retry rules are
4870 defined), Exim will not retry deliveries. In this situation, temporary errors
4871 are treated the same as permanent errors. Retry rules are discussed in chapter
4872 &<<CHAPretry>>&.
4873 .next
4874 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4875 when new addresses are generated during delivery. Rewriting is discussed in
4876 chapter &<<CHAPrewrite>>&.
4877 .next
4878 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4879 want to use this feature, you must set
4880 .code
4881 LOCAL_SCAN_HAS_OPTIONS=yes
4882 .endd
4883 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4884 facility are given in chapter &<<CHAPlocalscan>>&.
4885 .endlist
4886
4887 .cindex "configuration file" "leading white space in"
4888 .cindex "configuration file" "trailing white space in"
4889 .cindex "white space" "in configuration file"
4890 Leading and trailing white space in configuration lines is always ignored.
4891
4892 Blank lines in the file, and lines starting with a # character (ignoring
4893 leading white space) are treated as comments and are ignored. &*Note*&: A
4894 # character other than at the beginning of a line is not treated specially,
4895 and does not introduce a comment.
4896
4897 Any non-comment line can be continued by ending it with a backslash. Note that
4898 the general rule for white space means that trailing white space after the
4899 backslash and leading white space at the start of continuation
4900 lines is ignored. Comment lines beginning with # (but not empty lines) may
4901 appear in the middle of a sequence of continuation lines.
4902
4903 A convenient way to create a configuration file is to start from the
4904 default, which is supplied in &_src/configure.default_&, and add, delete, or
4905 change settings as required.
4906
4907 The ACLs, retry rules, and rewriting rules have their own syntax which is
4908 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4909 respectively. The other parts of the configuration file have some syntactic
4910 items in common, and these are described below, from section &<<SECTcos>>&
4911 onwards. Before that, the inclusion, macro, and conditional facilities are
4912 described.
4913
4914
4915
4916 .section "File inclusions in the configuration file" "SECID41"
4917 .cindex "inclusions in configuration file"
4918 .cindex "configuration file" "including other files"
4919 .cindex "&`.include`& in configuration file"
4920 .cindex "&`.include_if_exists`& in configuration file"
4921 You can include other files inside Exim's run time configuration file by
4922 using this syntax:
4923 .display
4924 &`.include`& <&'file name'&>
4925 &`.include_if_exists`& <&'file name'&>
4926 .endd
4927 on a line by itself. Double quotes round the file name are optional. If you use
4928 the first form, a configuration error occurs if the file does not exist; the
4929 second form does nothing for non-existent files. In all cases, an absolute file
4930 name is required.
4931
4932 Includes may be nested to any depth, but remember that Exim reads its
4933 configuration file often, so it is a good idea to keep them to a minimum.
4934 If you change the contents of an included file, you must HUP the daemon,
4935 because an included file is read only when the configuration itself is read.
4936
4937 The processing of inclusions happens early, at a physical line level, so, like
4938 comment lines, an inclusion can be used in the middle of an option setting,
4939 for example:
4940 .code
4941 hosts_lookup = a.b.c \
4942                .include /some/file
4943 .endd
4944 Include processing happens after macro processing (see below). Its effect is to
4945 process the lines of the included file as if they occurred inline where the
4946 inclusion appears.
4947
4948
4949
4950 .section "Macros in the configuration file" "SECTmacrodefs"
4951 .cindex "macro" "description of"
4952 .cindex "configuration file" "macros"
4953 If a line in the main part of the configuration (that is, before the first
4954 &"begin"& line) begins with an upper case letter, it is taken as a macro
4955 definition, and must be of the form
4956 .display
4957 <&'name'&> = <&'rest of line'&>
4958 .endd
4959 The name must consist of letters, digits, and underscores, and need not all be
4960 in upper case, though that is recommended. The rest of the line, including any
4961 continuations, is the replacement text, and has leading and trailing white
4962 space removed. Quotes are not removed. The replacement text can never end with
4963 a backslash character, but this doesn't seem to be a serious limitation.
4964
4965 Macros may also be defined between router, transport, authenticator, or ACL
4966 definitions. They may not, however, be defined within an individual driver or
4967 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4968
4969 .section "Macro substitution" "SECID42"
4970 Once a macro is defined, all subsequent lines in the file (and any included
4971 files) are scanned for the macro name; if there are several macros, the line is
4972 scanned for each in turn, in the order in which the macros are defined. The
4973 replacement text is not re-scanned for the current macro, though it is scanned
4974 for subsequently defined macros. For this reason, a macro name may not contain
4975 the name of a previously defined macro as a substring. You could, for example,
4976 define
4977 .display
4978 &`ABCD_XYZ = `&<&'something'&>
4979 &`ABCD = `&<&'something else'&>
4980 .endd
4981 but putting the definitions in the opposite order would provoke a configuration
4982 error. Macro expansion is applied to individual physical lines from the file,
4983 before checking for line continuation or file inclusion (see above). If a line
4984 consists solely of a macro name, and the expansion of the macro is empty, the
4985 line is ignored. A macro at the start of a line may turn the line into a
4986 comment line or a &`.include`& line.
4987
4988
4989 .section "Redefining macros" "SECID43"
4990 Once defined, the value of a macro can be redefined later in the configuration
4991 (or in an included file). Redefinition is specified by using &'=='& instead of
4992 &'='&. For example:
4993 .code
4994 MAC =  initial value
4995 ...
4996 MAC == updated value
4997 .endd
4998 Redefinition does not alter the order in which the macros are applied to the
4999 subsequent lines of the configuration file. It is still the same order in which
5000 the macros were originally defined. All that changes is the macro's value.
5001 Redefinition makes it possible to accumulate values. For example:
5002 .code
5003 MAC =  initial value
5004 ...
5005 MAC == MAC and something added
5006 .endd
5007 This can be helpful in situations where the configuration file is built
5008 from a number of other files.
5009
5010 .section "Overriding macro values" "SECID44"
5011 The values set for macros in the configuration file can be overridden by the
5012 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5013 used, unless called by root or the Exim user. A definition on the command line
5014 using the &%-D%& option causes all definitions and redefinitions within the
5015 file to be ignored.
5016
5017
5018
5019 .section "Example of macro usage" "SECID45"
5020 As an example of macro usage, consider a configuration where aliases are looked
5021 up in a MySQL database. It helps to keep the file less cluttered if long
5022 strings such as SQL statements are defined separately as macros, for example:
5023 .code
5024 ALIAS_QUERY = select mailbox from user where \
5025               login='${quote_mysql:$local_part}';
5026 .endd
5027 This can then be used in a &(redirect)& router setting like this:
5028 .code
5029 data = ${lookup mysql{ALIAS_QUERY}}
5030 .endd
5031 In earlier versions of Exim macros were sometimes used for domain, host, or
5032 address lists. In Exim 4 these are handled better by named lists &-- see
5033 section &<<SECTnamedlists>>&.
5034
5035
5036 .section "Conditional skips in the configuration file" "SECID46"
5037 .cindex "configuration file" "conditional skips"
5038 .cindex "&`.ifdef`&"
5039 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5040 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5041 portions of the configuration file. The processing happens whenever the file is
5042 read (that is, when an Exim binary starts to run).
5043
5044 The implementation is very simple. Instances of the first four directives must
5045 be followed by text that includes the names of one or macros. The condition
5046 that is tested is whether or not any macro substitution has taken place in the
5047 line. Thus:
5048 .code
5049 .ifdef AAA
5050 message_size_limit = 50M
5051 .else
5052 message_size_limit = 100M
5053 .endif
5054 .endd
5055 sets a message size limit of 50M if the macro &`AAA`& is defined
5056 (or &`A`& or &`AA`&), and 100M
5057 otherwise. If there is more than one macro named on the line, the condition
5058 is true if any of them are defined. That is, it is an &"or"& condition. To
5059 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5060
5061 Although you can use a macro expansion to generate one of these directives,
5062 it is not very useful, because the condition &"there was a macro substitution
5063 in this line"& will always be true.
5064
5065 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5066 to clarify complicated nestings.
5067
5068
5069
5070 .section "Common option syntax" "SECTcos"
5071 .cindex "common option syntax"
5072 .cindex "syntax of common options"
5073 .cindex "configuration file" "common option syntax"
5074 For the main set of options, driver options, and &[local_scan()]& options,
5075 each setting is on a line by itself, and starts with a name consisting of
5076 lower-case letters and underscores. Many options require a data value, and in
5077 these cases the name must be followed by an equals sign (with optional white
5078 space) and then the value. For example:
5079 .code
5080 qualify_domain = mydomain.example.com
5081 .endd
5082 .cindex "hiding configuration option values"
5083 .cindex "configuration options" "hiding value of"
5084 .cindex "options" "hiding value of"
5085 Some option settings may contain sensitive data, for example, passwords for
5086 accessing databases. To stop non-admin users from using the &%-bP%& command
5087 line option to read these values, you can precede the option settings with the
5088 word &"hide"&. For example:
5089 .code
5090 hide mysql_servers = localhost/users/admin/secret-password
5091 .endd
5092 For non-admin users, such options are displayed like this:
5093 .code
5094 mysql_servers = <value not displayable>
5095 .endd
5096 If &"hide"& is used on a driver option, it hides the value of that option on
5097 all instances of the same driver.
5098
5099 The following sections describe the syntax used for the different data types
5100 that are found in option settings.
5101
5102
5103 .section "Boolean options" "SECID47"
5104 .cindex "format" "boolean"
5105 .cindex "boolean configuration values"
5106 .oindex "&%no_%&&'xxx'&"
5107 .oindex "&%not_%&&'xxx'&"
5108 Options whose type is given as boolean are on/off switches. There are two
5109 different ways of specifying such options: with and without a data value. If
5110 the option name is specified on its own without data, the switch is turned on;
5111 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5112 boolean options may be followed by an equals sign and one of the words
5113 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5114 the following two settings have exactly the same effect:
5115 .code
5116 queue_only
5117 queue_only = true
5118 .endd
5119 The following two lines also have the same (opposite) effect:
5120 .code
5121 no_queue_only
5122 queue_only = false
5123 .endd
5124 You can use whichever syntax you prefer.
5125
5126
5127
5128
5129 .section "Integer values" "SECID48"
5130 .cindex "integer configuration values"
5131 .cindex "format" "integer"
5132 If an option's type is given as &"integer"&, the value can be given in decimal,
5133 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5134 number is assumed. Otherwise, it is treated as an octal number unless it starts
5135 with the characters &"0x"&, in which case the remainder is interpreted as a
5136 hexadecimal number.
5137
5138 If an integer value is followed by the letter K, it is multiplied by 1024; if
5139 it is followed by the letter M, it is multiplied by 1024x1024;
5140 .new
5141 if by the letter G, 1024x1024x1024.
5142 .wen
5143 When the values
5144 of integer option settings are output, values which are an exact multiple of
5145 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5146 and M. The printing style is independent of the actual input format that was
5147 used.
5148
5149
5150 .section "Octal integer values" "SECID49"
5151 .cindex "integer format"
5152 .cindex "format" "octal integer"
5153 If an option's type is given as &"octal integer"&, its value is always
5154 interpreted as an octal number, whether or not it starts with the digit zero.
5155 Such options are always output in octal.
5156
5157
5158 .section "Fixed point numbers" "SECID50"
5159 .cindex "fixed point configuration values"
5160 .cindex "format" "fixed point"
5161 If an option's type is given as &"fixed-point"&, its value must be a decimal
5162 integer, optionally followed by a decimal point and up to three further digits.
5163
5164
5165
5166 .section "Time intervals" "SECTtimeformat"
5167 .cindex "time interval" "specifying in configuration"
5168 .cindex "format" "time interval"
5169 A time interval is specified as a sequence of numbers, each followed by one of
5170 the following letters, with no intervening white space:
5171
5172 .table2 30pt
5173 .irow &%s%& seconds
5174 .irow &%m%& minutes
5175 .irow &%h%& hours
5176 .irow &%d%& days
5177 .irow &%w%& weeks
5178 .endtable
5179
5180 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5181 intervals are output in the same format. Exim does not restrict the values; it
5182 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5183
5184
5185
5186 .section "String values" "SECTstrings"
5187 .cindex "string" "format of configuration values"
5188 .cindex "format" "string"
5189 If an option's type is specified as &"string"&, the value can be specified with
5190 or without double-quotes. If it does not start with a double-quote, the value
5191 consists of the remainder of the line plus any continuation lines, starting at
5192 the first character after any leading white space, with trailing white space
5193 removed, and with no interpretation of the characters in the string. Because
5194 Exim removes comment lines (those beginning with #) at an early stage, they can
5195 appear in the middle of a multi-line string. The following two settings are
5196 therefore equivalent:
5197 .code
5198 trusted_users = uucp:mail
5199 trusted_users = uucp:\
5200                 # This comment line is ignored
5201                 mail
5202 .endd
5203 .cindex "string" "quoted"
5204 .cindex "escape characters in quoted strings"
5205 If a string does start with a double-quote, it must end with a closing
5206 double-quote, and any backslash characters other than those used for line
5207 continuation are interpreted as escape characters, as follows:
5208
5209 .table2 100pt
5210 .irow &`\\`&                     "single backslash"
5211 .irow &`\n`&                     "newline"
5212 .irow &`\r`&                     "carriage return"
5213 .irow &`\t`&                     "tab"
5214 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5215 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5216                                    character"
5217 .endtable
5218
5219 If a backslash is followed by some other character, including a double-quote
5220 character, that character replaces the pair.
5221
5222 Quoting is necessary only if you want to make use of the backslash escapes to
5223 insert special characters, or if you need to specify a value with leading or
5224 trailing spaces. These cases are rare, so quoting is almost never needed in
5225 current versions of Exim. In versions of Exim before 3.14, quoting was required
5226 in order to continue lines, so you may come across older configuration files
5227 and examples that apparently quote unnecessarily.
5228
5229
5230 .section "Expanded strings" "SECID51"
5231 .cindex "expansion" "definition of"
5232 Some strings in the configuration file are subjected to &'string expansion'&,
5233 by which means various parts of the string may be changed according to the
5234 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5235 is as just described; in particular, the handling of backslashes in quoted
5236 strings is done as part of the input process, before expansion takes place.
5237 However, backslash is also an escape character for the expander, so any
5238 backslashes that are required for that reason must be doubled if they are
5239 within a quoted configuration string.
5240
5241
5242 .section "User and group names" "SECID52"
5243 .cindex "user name" "format of"
5244 .cindex "format" "user name"
5245 .cindex "groups" "name format"
5246 .cindex "format" "group name"
5247 User and group names are specified as strings, using the syntax described
5248 above, but the strings are interpreted specially. A user or group name must
5249 either consist entirely of digits, or be a name that can be looked up using the
5250 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5251
5252
5253 .section "List construction" "SECTlistconstruct"
5254 .cindex "list" "syntax of in configuration"
5255 .cindex "format" "list item in configuration"
5256 .cindex "string" "list, definition of"
5257 The data for some configuration options is a list of items, with colon as the
5258 default separator. Many of these options are shown with type &"string list"& in
5259 the descriptions later in this document. Others are listed as &"domain list"&,
5260 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5261 are all the same; however, those other than &"string list"& are subject to
5262 particular kinds of interpretation, as described in chapter
5263 &<<CHAPdomhosaddlists>>&.
5264
5265 In all these cases, the entire list is treated as a single string as far as the
5266 input syntax is concerned. The &%trusted_users%& setting in section
5267 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5268 in a list, it must be entered as two colons. Leading and trailing white space
5269 on each item in a list is ignored. This makes it possible to include items that
5270 start with a colon, and in particular, certain forms of IPv6 address. For
5271 example, the list
5272 .code
5273 local_interfaces = 127.0.0.1 : ::::1
5274 .endd
5275 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5276
5277 &*Note*&: Although leading and trailing white space is ignored in individual
5278 list items, it is not ignored when parsing the list. The space after the first
5279 colon in the example above is necessary. If it were not there, the list would
5280 be interpreted as the two items 127.0.0.1:: and 1.
5281
5282 .section "Changing list separators" "SECTlistsepchange"
5283 .cindex "list separator" "changing"
5284 .cindex "IPv6" "addresses in lists"
5285 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5286 introduced to allow the separator character to be changed. If a list begins
5287 with a left angle bracket, followed by any punctuation character, that
5288 character is used instead of colon as the list separator. For example, the list
5289 above can be rewritten to use a semicolon separator like this:
5290 .code
5291 local_interfaces = <; 127.0.0.1 ; ::1
5292 .endd
5293 This facility applies to all lists, with the exception of the list in
5294 &%log_file_path%&. It is recommended that the use of non-colon separators be
5295 confined to circumstances where they really are needed.
5296
5297 .cindex "list separator" "newline as"
5298 .cindex "newline" "as list separator"
5299 It is also possible to use newline and other control characters (those with
5300 code values less than 32, plus DEL) as separators in lists. Such separators
5301 must be provided literally at the time the list is processed. For options that
5302 are string-expanded, you can write the separator using a normal escape
5303 sequence. This will be processed by the expander before the string is
5304 interpreted as a list. For example, if a newline-separated list of domains is
5305 generated by a lookup, you can process it directly by a line such as this:
5306 .code
5307 domains = <\n ${lookup mysql{.....}}
5308 .endd
5309 This avoids having to change the list separator in such data. You are unlikely
5310 to want to use a control character as a separator in an option that is not
5311 expanded, because the value is literal text. However, it can be done by giving
5312 the value in quotes. For example:
5313 .code
5314 local_interfaces = "<\n 127.0.0.1 \n ::1"
5315 .endd
5316 Unlike printing character separators, which can be included in list items by
5317 doubling, it is not possible to include a control character as data when it is
5318 set as the separator. Two such characters in succession are interpreted as
5319 enclosing an empty list item.
5320
5321
5322
5323 .section "Empty items in lists" "SECTempitelis"
5324 .cindex "list" "empty item in"
5325 An empty item at the end of a list is always ignored. In other words, trailing
5326 separator characters are ignored. Thus, the list in
5327 .code
5328 senders = user@domain :
5329 .endd
5330 contains only a single item. If you want to include an empty string as one item
5331 in a list, it must not be the last item. For example, this list contains three
5332 items, the second of which is empty:
5333 .code
5334 senders = user1@domain : : user2@domain
5335 .endd
5336 &*Note*&: There must be white space between the two colons, as otherwise they
5337 are interpreted as representing a single colon data character (and the list
5338 would then contain just one item). If you want to specify a list that contains
5339 just one, empty item, you can do it as in this example:
5340 .code
5341 senders = :
5342 .endd
5343 In this case, the first item is empty, and the second is discarded because it
5344 is at the end of the list.
5345
5346
5347
5348
5349 .section "Format of driver configurations" "SECTfordricon"
5350 .cindex "drivers" "configuration format"
5351 There are separate parts in the configuration for defining routers, transports,
5352 and authenticators. In each part, you are defining a number of driver
5353 instances, each with its own set of options. Each driver instance is defined by
5354 a sequence of lines like this:
5355 .display
5356 <&'instance name'&>:
5357   <&'option'&>
5358   ...
5359   <&'option'&>
5360 .endd
5361 In the following example, the instance name is &(localuser)&, and it is
5362 followed by three options settings:
5363 .code
5364 localuser:
5365   driver = accept
5366   check_local_user
5367   transport = local_delivery
5368 .endd
5369 For each driver instance, you specify which Exim code module it uses &-- by the
5370 setting of the &%driver%& option &-- and (optionally) some configuration
5371 settings. For example, in the case of transports, if you want a transport to
5372 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5373 a local file you would use the &(appendfile)& driver. Each of the drivers is
5374 described in detail in its own separate chapter later in this manual.
5375
5376 You can have several routers, transports, or authenticators that are based on
5377 the same underlying driver (each must have a different instance name).
5378
5379 The order in which routers are defined is important, because addresses are
5380 passed to individual routers one by one, in order. The order in which
5381 transports are defined does not matter at all. The order in which
5382 authenticators are defined is used only when Exim, as a client, is searching
5383 them to find one that matches an authentication mechanism offered by the
5384 server.
5385
5386 .cindex "generic options"
5387 .cindex "options" "generic &-- definition of"
5388 Within a driver instance definition, there are two kinds of option: &'generic'&
5389 and &'private'&. The generic options are those that apply to all drivers of the
5390 same type (that is, all routers, all transports or all authenticators). The
5391 &%driver%& option is a generic option that must appear in every definition.
5392 .cindex "private options"
5393 The private options are special for each driver, and none need appear, because
5394 they all have default values.
5395
5396 The options may appear in any order, except that the &%driver%& option must
5397 precede any private options, since these depend on the particular driver. For
5398 this reason, it is recommended that &%driver%& always be the first option.
5399
5400 Driver instance names, which are used for reference in log entries and
5401 elsewhere, can be any sequence of letters, digits, and underscores (starting
5402 with a letter) and must be unique among drivers of the same type. A router and
5403 a transport (for example) can each have the same name, but no two router
5404 instances can have the same name. The name of a driver instance should not be
5405 confused with the name of the underlying driver module. For example, the
5406 configuration lines:
5407 .code
5408 remote_smtp:
5409   driver = smtp
5410 .endd
5411 create an instance of the &(smtp)& transport driver whose name is
5412 &(remote_smtp)&. The same driver code can be used more than once, with
5413 different instance names and different option settings each time. A second
5414 instance of the &(smtp)& transport, with different options, might be defined
5415 thus:
5416 .code
5417 special_smtp:
5418   driver = smtp
5419   port = 1234
5420   command_timeout = 10s
5421 .endd
5422 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5423 these transport instances from routers, and these names would appear in log
5424 lines.
5425
5426 Comment lines may be present in the middle of driver specifications. The full
5427 list of option settings for any particular driver instance, including all the
5428 defaulted values, can be extracted by making use of the &%-bP%& command line
5429 option.
5430
5431
5432
5433
5434
5435
5436 . ////////////////////////////////////////////////////////////////////////////
5437 . ////////////////////////////////////////////////////////////////////////////
5438
5439 .chapter "The default configuration file" "CHAPdefconfil"
5440 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5441 .cindex "default" "configuration file &""walk through""&"
5442 The default configuration file supplied with Exim as &_src/configure.default_&
5443 is sufficient for a host with simple mail requirements. As an introduction to
5444 the way Exim is configured, this chapter &"walks through"& the default
5445 configuration, giving brief explanations of the settings. Detailed descriptions
5446 of the options are given in subsequent chapters. The default configuration file
5447 itself contains extensive comments about ways you might want to modify the
5448 initial settings. However, note that there are many options that are not
5449 mentioned at all in the default configuration.
5450
5451
5452
5453 .section "Main configuration settings" "SECTdefconfmain"
5454 The main (global) configuration option settings must always come first in the
5455 file. The first thing you'll see in the file, after some initial comments, is
5456 the line
5457 .code
5458 # primary_hostname =
5459 .endd
5460 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5461 to know the official, fully qualified name of your host, and this is where you
5462 can specify it. However, in most cases you do not need to set this option. When
5463 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5464
5465 The first three non-comment configuration lines are as follows:
5466 .code
5467 domainlist local_domains    = @
5468 domainlist relay_to_domains =
5469 hostlist   relay_from_hosts = 127.0.0.1
5470 .endd
5471 These are not, in fact, option settings. They are definitions of two named
5472 domain lists and one named host list. Exim allows you to give names to lists of
5473 domains, hosts, and email addresses, in order to make it easier to manage the
5474 configuration file (see section &<<SECTnamedlists>>&).
5475
5476 The first line defines a domain list called &'local_domains'&; this is used
5477 later in the configuration to identify domains that are to be delivered
5478 on the local host.
5479
5480 .cindex "@ in a domain list"
5481 There is just one item in this list, the string &"@"&. This is a special form
5482 of entry which means &"the name of the local host"&. Thus, if the local host is
5483 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5484 be delivered locally. Because the local host's name is referenced indirectly,
5485 the same configuration file can be used on different hosts.
5486
5487 The second line defines a domain list called &'relay_to_domains'&, but the
5488 list itself is empty. Later in the configuration we will come to the part that
5489 controls mail relaying through the local host; it allows relaying to any
5490 domains in this list. By default, therefore, no relaying on the basis of a mail
5491 domain is permitted.
5492
5493 The third line defines a host list called &'relay_from_hosts'&. This list is
5494 used later in the configuration to permit relaying from any host or IP address
5495 that matches the list. The default contains just the IP address of the IPv4
5496 loopback interface, which means that processes on the local host are able to
5497 submit mail for relaying by sending it over TCP/IP to that interface. No other
5498 hosts are permitted to submit messages for relaying.
5499
5500 Just to be sure there's no misunderstanding: at this point in the configuration
5501 we aren't actually setting up any controls. We are just defining some domains
5502 and hosts that will be used in the controls that are specified later.
5503
5504 The next two configuration lines are genuine option settings:
5505 .code
5506 acl_smtp_rcpt = acl_check_rcpt
5507 acl_smtp_data = acl_check_data
5508 .endd
5509 These options specify &'Access Control Lists'& (ACLs) that are to be used
5510 during an incoming SMTP session for every recipient of a message (every RCPT
5511 command), and after the contents of the message have been received,
5512 respectively. The names of the lists are &'acl_check_rcpt'& and
5513 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5514 section of the configuration. The RCPT ACL controls which recipients are
5515 accepted for an incoming message &-- if a configuration does not provide an ACL
5516 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5517 contents of a message to be checked.
5518
5519 Two commented-out option settings are next:
5520 .code
5521 # av_scanner = clamd:/tmp/clamd
5522 # spamd_address = 127.0.0.1 783
5523 .endd
5524 These are example settings that can be used when Exim is compiled with the
5525 content-scanning extension. The first specifies the interface to the virus
5526 scanner, and the second specifies the interface to SpamAssassin. Further
5527 details are given in chapter &<<CHAPexiscan>>&.
5528
5529 Three more commented-out option settings follow:
5530 .code
5531 # tls_advertise_hosts = *
5532 # tls_certificate = /etc/ssl/exim.crt
5533 # tls_privatekey = /etc/ssl/exim.pem
5534 .endd
5535 These are example settings that can be used when Exim is compiled with
5536 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5537 first one specifies the list of clients that are allowed to use TLS when
5538 connecting to this server; in this case the wildcard means all clients. The
5539 other options specify where Exim should find its TLS certificate and private
5540 key, which together prove the server's identity to any clients that connect.
5541 More details are given in chapter &<<CHAPTLS>>&.
5542
5543 Another two commented-out option settings follow:
5544 .code
5545 # daemon_smtp_ports = 25 : 465 : 587
5546 # tls_on_connect_ports = 465
5547 .endd
5548 .cindex "port" "465 and 587"
5549 .cindex "port" "for message submission"
5550 .cindex "message" "submission, ports for"
5551 .cindex "ssmtp protocol"
5552 .cindex "smtps protocol"
5553 .cindex "SMTP" "ssmtp protocol"
5554 .cindex "SMTP" "smtps protocol"
5555 These options provide better support for roaming users who wish to use this
5556 server for message submission. They are not much use unless you have turned on
5557 TLS (as described in the previous paragraph) and authentication (about which
5558 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5559 on end-user networks, so RFC 4409 specifies that message submission should use
5560 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5561 configured to use port 587 correctly, so these settings also enable the
5562 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5563 &<<SECTsupobssmt>>&).
5564
5565 Two more commented-out options settings follow:
5566 .code
5567 # qualify_domain =
5568 # qualify_recipient =
5569 .endd
5570 The first of these specifies a domain that Exim uses when it constructs a
5571 complete email address from a local login name. This is often needed when Exim
5572 receives a message from a local process. If you do not set &%qualify_domain%&,
5573 the value of &%primary_hostname%& is used. If you set both of these options,
5574 you can have different qualification domains for sender and recipient
5575 addresses. If you set only the first one, its value is used in both cases.
5576
5577 .cindex "domain literal" "recognizing format"
5578 The following line must be uncommented if you want Exim to recognize
5579 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5580 (an IP address within square brackets) instead of a named domain.
5581 .code
5582 # allow_domain_literals
5583 .endd
5584 The RFCs still require this form, but many people think that in the modern
5585 Internet it makes little sense to permit mail to be sent to specific hosts by
5586 quoting their IP addresses. This ancient format has been used by people who
5587 try to abuse hosts by using them for unwanted relaying. However, some
5588 people believe there are circumstances (for example, messages addressed to
5589 &'postmaster'&) where domain literals are still useful.
5590
5591 The next configuration line is a kind of trigger guard:
5592 .code
5593 never_users = root
5594 .endd
5595 It specifies that no delivery must ever be run as the root user. The normal
5596 convention is to set up &'root'& as an alias for the system administrator. This
5597 setting is a guard against slips in the configuration.
5598 The list of users specified by &%never_users%& is not, however, the complete
5599 list; the build-time configuration in &_Local/Makefile_& has an option called
5600 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5601 contents of &%never_users%& are added to this list. By default
5602 FIXED_NEVER_USERS also specifies root.
5603
5604 When a remote host connects to Exim in order to send mail, the only information
5605 Exim has about the host's identity is its IP address. The next configuration
5606 line,
5607 .code
5608 host_lookup = *
5609 .endd
5610 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5611 in order to get a host name. This improves the quality of the logging
5612 information, but if you feel it is too expensive, you can remove it entirely,
5613 or restrict the lookup to hosts on &"nearby"& networks.
5614 Note that it is not always possible to find a host name from an IP address,
5615 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5616 unreachable.
5617
5618 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5619 1413 (hence their names):
5620 .code
5621 rfc1413_hosts = *
5622 rfc1413_query_timeout = 0s
5623 .endd
5624 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5625 Few hosts offer RFC1413 service these days; calls have to be
5626 terminated by a timeout and this needlessly delays the startup
5627 of an incoming SMTP connection.
5628 If you have hosts for which you trust RFC1413 and need this
5629 information, you can change this.
5630
5631 This line enables an efficiency SMTP option.  It is negotiated by clients
5632 and not expected to cause problems but can be disabled if needed.
5633 .code
5634 prdr_enable = true
5635 .endd
5636
5637 When Exim receives messages over SMTP connections, it expects all addresses to
5638 be fully qualified with a domain, as required by the SMTP definition. However,
5639 if you are running a server to which simple clients submit messages, you may
5640 find that they send unqualified addresses. The two commented-out options:
5641 .code
5642 # sender_unqualified_hosts =
5643 # recipient_unqualified_hosts =
5644 .endd
5645 show how you can specify hosts that are permitted to send unqualified sender
5646 and recipient addresses, respectively.
5647
5648 The &%log_selector%& option is used to increase the detail of logging
5649 over the default:
5650 .code
5651 log_selector = +smtp_protocol_error +smtp_syntax_error \
5652                +tls_certificate_verified
5653 .endd
5654
5655 The &%percent_hack_domains%& option is also commented out:
5656 .code
5657 # percent_hack_domains =
5658 .endd
5659 It provides a list of domains for which the &"percent hack"& is to operate.
5660 This is an almost obsolete form of explicit email routing. If you do not know
5661 anything about it, you can safely ignore this topic.
5662
5663 The next two settings in the main part of the default configuration are
5664 concerned with messages that have been &"frozen"& on Exim's queue. When a
5665 message is frozen, Exim no longer continues to try to deliver it. Freezing
5666 occurs when a bounce message encounters a permanent failure because the sender
5667 address of the original message that caused the bounce is invalid, so the
5668 bounce cannot be delivered. This is probably the most common case, but there
5669 are also other conditions that cause freezing, and frozen messages are not
5670 always bounce messages.
5671 .code
5672 ignore_bounce_errors_after = 2d
5673 timeout_frozen_after = 7d
5674 .endd
5675 The first of these options specifies that failing bounce messages are to be
5676 discarded after 2 days on the queue. The second specifies that any frozen
5677 message (whether a bounce message or not) is to be timed out (and discarded)
5678 after a week. In this configuration, the first setting ensures that no failing
5679 bounce message ever lasts a week.
5680
5681 Exim queues it's messages in a spool directory. If you expect to have
5682 large queues, you may consider using this option. It splits the spool
5683 directory into subdirectories to avoid file system degradation from
5684 many files in a single directory, resulting in better performance.
5685 Manual manipulation of queued messages becomes more complex (though fortunately
5686 not often needed).
5687 .code
5688 # split_spool_directory = true
5689 .endd
5690
5691 In an ideal world everybody follows the standards. For non-ASCII
5692 messages RFC 2047 is a standard, allowing a maximum line length of 76
5693 characters. Exim adheres that standard and won't process messages which
5694 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5695 In particular, the Exim maintainers have had multiple reports of
5696 problems from Russian administrators of issues until they disable this
5697 check, because of some popular, yet buggy, mail composition software.
5698 .code
5699 # check_rfc2047_length = false
5700 .endd
5701
5702 If you need to be strictly RFC compliant you may wish to disable the
5703 8BITMIME advertisement. Use this, if you exchange mails with systems
5704 that are not 8-bit clean.
5705 .code
5706 # accept_8bitmime = false
5707 .endd
5708
5709 Libraries you use may depend on specific environment settings.  This
5710 imposes a security risk (e.g. PATH). There are two lists:
5711 &%keep_environment%& for the variables to import as they are, and
5712 &%add_environment%& for variables we want to set to a fixed value.
5713 Note that TZ is handled separately, by the $%timezone%$ runtime
5714 option and by the TIMEZONE_DEFAULT buildtime option.
5715 .code
5716 # keep_environment = ^LDAP
5717 # add_environment = PATH=/usr/bin::/bin
5718 .endd
5719
5720
5721 .section "ACL configuration" "SECID54"
5722 .cindex "default" "ACLs"
5723 .cindex "&ACL;" "default configuration"
5724 In the default configuration, the ACL section follows the main configuration.
5725 It starts with the line
5726 .code
5727 begin acl
5728 .endd
5729 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5730 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5731 and &%acl_smtp_data%& above.
5732
5733 .cindex "RCPT" "ACL for"
5734 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5735 RCPT command specifies one of the message's recipients. The ACL statements
5736 are considered in order, until the recipient address is either accepted or
5737 rejected. The RCPT command is then accepted or rejected, according to the
5738 result of the ACL processing.
5739 .code
5740 acl_check_rcpt:
5741 .endd
5742 This line, consisting of a name terminated by a colon, marks the start of the
5743 ACL, and names it.
5744 .code
5745 accept  hosts = :
5746 .endd
5747 This ACL statement accepts the recipient if the sending host matches the list.
5748 But what does that strange list mean? It doesn't actually contain any host
5749 names or IP addresses. The presence of the colon puts an empty item in the
5750 list; Exim matches this only if the incoming message did not come from a remote
5751 host, because in that case, the remote hostname is empty. The colon is
5752 important. Without it, the list itself is empty, and can never match anything.
5753
5754 What this statement is doing is to accept unconditionally all recipients in
5755 messages that are submitted by SMTP from local processes using the standard
5756 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5757 manner.
5758 .code
5759 deny    message       = Restricted characters in address
5760         domains       = +local_domains
5761         local_parts   = ^[.] : ^.*[@%!/|]
5762
5763 deny    message       = Restricted characters in address
5764         domains       = !+local_domains
5765         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5766 .endd
5767 These statements are concerned with local parts that contain any of the
5768 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5769 Although these characters are entirely legal in local parts (in the case of
5770 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5771 in Internet mail addresses.
5772
5773 The first three have in the past been associated with explicitly routed
5774 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5775 option). Addresses containing these characters are regularly tried by spammers
5776 in an attempt to bypass relaying restrictions, and also by open relay testing
5777 programs. Unless you really need them it is safest to reject these characters
5778 at this early stage. This configuration is heavy-handed in rejecting these
5779 characters for all messages it accepts from remote hosts. This is a deliberate
5780 policy of being as safe as possible.
5781
5782 The first rule above is stricter, and is applied to messages that are addressed
5783 to one of the local domains handled by this host. This is implemented by the
5784 first condition, which restricts it to domains that are listed in the
5785 &'local_domains'& domain list. The &"+"& character is used to indicate a
5786 reference to a named list. In this configuration, there is just one domain in
5787 &'local_domains'&, but in general there may be many.
5788
5789 The second condition on the first statement uses two regular expressions to
5790 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5791 or &"|"&. If you have local accounts that include these characters, you will
5792 have to modify this rule.
5793
5794 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5795 allows them because they have been encountered in practice. (Consider the
5796 common convention of local parts constructed as
5797 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5798 the author of Exim, who has no second initial.) However, a local part starting
5799 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5800 file name (for example, for a mailing list). This is also true for local parts
5801 that contain slashes. A pipe symbol can also be troublesome if the local part
5802 is incorporated unthinkingly into a shell command line.
5803
5804 The second rule above applies to all other domains, and is less strict. This
5805 allows your own users to send outgoing messages to sites that use slashes
5806 and vertical bars in their local parts. It blocks local parts that begin
5807 with a dot, slash, or vertical bar, but allows these characters within the
5808 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5809 and &"!"& is blocked, as before. The motivation here is to prevent your users
5810 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5811 .code
5812 accept  local_parts   = postmaster
5813         domains       = +local_domains
5814 .endd
5815 This statement, which has two conditions, accepts an incoming address if the
5816 local part is &'postmaster'& and the domain is one of those listed in the
5817 &'local_domains'& domain list. The &"+"& character is used to indicate a
5818 reference to a named list. In this configuration, there is just one domain in
5819 &'local_domains'&, but in general there may be many.
5820
5821 The presence of this statement means that mail to postmaster is never blocked
5822 by any of the subsequent tests. This can be helpful while sorting out problems
5823 in cases where the subsequent tests are incorrectly denying access.
5824 .code
5825 require verify        = sender
5826 .endd
5827 This statement requires the sender address to be verified before any subsequent
5828 ACL statement can be used. If verification fails, the incoming recipient
5829 address is refused. Verification consists of trying to route the address, to
5830 see if a bounce message could be delivered to it. In the case of remote
5831 addresses, basic verification checks only the domain, but &'callouts'& can be
5832 used for more verification if required. Section &<<SECTaddressverification>>&
5833 discusses the details of address verification.
5834 .code
5835 accept  hosts         = +relay_from_hosts
5836         control       = submission
5837 .endd
5838 This statement accepts the address if the message is coming from one of the
5839 hosts that are defined as being allowed to relay through this host. Recipient
5840 verification is omitted here, because in many cases the clients are dumb MUAs
5841 that do not cope well with SMTP error responses. For the same reason, the
5842 second line specifies &"submission mode"& for messages that are accepted. This
5843 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5844 messages that are deficient in some way, for example, because they lack a
5845 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5846 probably add recipient verification here, and disable submission mode.
5847 .code
5848 accept  authenticated = *
5849         control       = submission
5850 .endd
5851 This statement accepts the address if the client host has authenticated itself.
5852 Submission mode is again specified, on the grounds that such messages are most
5853 likely to come from MUAs. The default configuration does not define any
5854 authenticators, though it does include some nearly complete commented-out
5855 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5856 fact authenticate until you complete the authenticator definitions.
5857 .code
5858 require message = relay not permitted
5859         domains = +local_domains : +relay_to_domains
5860 .endd
5861 This statement rejects the address if its domain is neither a local domain nor
5862 one of the domains for which this host is a relay.
5863 .code
5864 require verify = recipient
5865 .endd
5866 This statement requires the recipient address to be verified; if verification
5867 fails, the address is rejected.
5868 .code
5869 # deny    message     = rejected because $sender_host_address \
5870 #                       is in a black list at $dnslist_domain\n\
5871 #                       $dnslist_text
5872 #         dnslists    = black.list.example
5873 #
5874 # warn    dnslists    = black.list.example
5875 #         add_header  = X-Warning: $sender_host_address is in \
5876 #                       a black list at $dnslist_domain
5877 #         log_message = found in $dnslist_domain
5878 .endd
5879 These commented-out lines are examples of how you could configure Exim to check
5880 sending hosts against a DNS black list. The first statement rejects messages
5881 from blacklisted hosts, whereas the second just inserts a warning header
5882 line.
5883 .code
5884 # require verify = csa
5885 .endd
5886 This commented-out line is an example of how you could turn on client SMTP
5887 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5888 records.
5889 .code
5890 accept
5891 .endd
5892 The final statement in the first ACL unconditionally accepts any recipient
5893 address that has successfully passed all the previous tests.
5894 .code
5895 acl_check_data:
5896 .endd
5897 This line marks the start of the second ACL, and names it. Most of the contents
5898 of this ACL are commented out:
5899 .code
5900 # deny    malware   = *
5901 #         message   = This message contains a virus \
5902 #                     ($malware_name).
5903 .endd
5904 These lines are examples of how to arrange for messages to be scanned for
5905 viruses when Exim has been compiled with the content-scanning extension, and a
5906 suitable virus scanner is installed. If the message is found to contain a
5907 virus, it is rejected with the given custom error message.
5908 .code
5909 # warn    spam      = nobody
5910 #         message   = X-Spam_score: $spam_score\n\
5911 #                     X-Spam_score_int: $spam_score_int\n\
5912 #                     X-Spam_bar: $spam_bar\n\
5913 #                     X-Spam_report: $spam_report
5914 .endd
5915 These lines are an example of how to arrange for messages to be scanned by
5916 SpamAssassin when Exim has been compiled with the content-scanning extension,
5917 and SpamAssassin has been installed. The SpamAssassin check is run with
5918 &`nobody`& as its user parameter, and the results are added to the message as a
5919 series of extra header line. In this case, the message is not rejected,
5920 whatever the spam score.
5921 .code
5922 accept
5923 .endd
5924 This final line in the DATA ACL accepts the message unconditionally.
5925
5926
5927 .section "Router configuration" "SECID55"
5928 .cindex "default" "routers"
5929 .cindex "routers" "default"
5930 The router configuration comes next in the default configuration, introduced
5931 by the line
5932 .code
5933 begin routers
5934 .endd
5935 Routers are the modules in Exim that make decisions about where to send
5936 messages. An address is passed to each router in turn, until it is either
5937 accepted, or failed. This means that the order in which you define the routers
5938 matters. Each router is fully described in its own chapter later in this
5939 manual. Here we give only brief overviews.
5940 .code
5941 # domain_literal:
5942 #   driver = ipliteral
5943 #   domains = !+local_domains
5944 #   transport = remote_smtp
5945 .endd
5946 .cindex "domain literal" "default router"
5947 This router is commented out because the majority of sites do not want to
5948 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5949 you uncomment this router, you also need to uncomment the setting of
5950 &%allow_domain_literals%& in the main part of the configuration.
5951 .code
5952 dnslookup:
5953   driver = dnslookup
5954   domains = ! +local_domains
5955   transport = remote_smtp
5956   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5957   no_more
5958 .endd
5959 The first uncommented router handles addresses that do not involve any local
5960 domains. This is specified by the line
5961 .code
5962 domains = ! +local_domains
5963 .endd
5964 The &%domains%& option lists the domains to which this router applies, but the
5965 exclamation mark is a negation sign, so the router is used only for domains
5966 that are not in the domain list called &'local_domains'& (which was defined at
5967 the start of the configuration). The plus sign before &'local_domains'&
5968 indicates that it is referring to a named list. Addresses in other domains are
5969 passed on to the following routers.
5970
5971 The name of the router driver is &(dnslookup)&,
5972 and is specified by the &%driver%& option. Do not be confused by the fact that
5973 the name of this router instance is the same as the name of the driver. The
5974 instance name is arbitrary, but the name set in the &%driver%& option must be
5975 one of the driver modules that is in the Exim binary.
5976
5977 The &(dnslookup)& router routes addresses by looking up their domains in the
5978 DNS in order to obtain a list of hosts to which the address is routed. If the
5979 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5980 specified by the &%transport%& option. If the router does not find the domain
5981 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5982 the address fails and is bounced.
5983
5984 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5985 be entirely ignored. This option is present because a number of cases have been
5986 encountered where MX records in the DNS point to host names
5987 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5988 Completely ignoring these IP addresses causes Exim to fail to route the
5989 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5990 continue to try to deliver the message periodically until the address timed
5991 out.
5992 .code
5993 system_aliases:
5994   driver = redirect
5995   allow_fail
5996   allow_defer
5997   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5998 # user = exim
5999   file_transport = address_file
6000   pipe_transport = address_pipe
6001 .endd
6002 Control reaches this and subsequent routers only for addresses in the local
6003 domains. This router checks to see whether the local part is defined as an
6004 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6005 data that it looks up from that file. If no data is found for the local part,
6006 the value of the &%data%& option is empty, causing the address to be passed to
6007 the next router.
6008
6009 &_/etc/aliases_& is a conventional name for the system aliases file that is
6010 often used. That is why it is referenced by from the default configuration
6011 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6012 &_Local/Makefile_& before building Exim.
6013 .code
6014 userforward:
6015   driver = redirect
6016   check_local_user
6017 # local_part_suffix = +* : -*
6018 # local_part_suffix_optional
6019   file = $home/.forward
6020 # allow_filter
6021   no_verify
6022   no_expn
6023   check_ancestor
6024   file_transport = address_file
6025   pipe_transport = address_pipe
6026   reply_transport = address_reply
6027 .endd
6028 This is the most complicated router in the default configuration. It is another
6029 redirection router, but this time it is looking for forwarding data set up by
6030 individual users. The &%check_local_user%& setting specifies a check that the
6031 local part of the address is the login name of a local user. If it is not, the
6032 router is skipped. The two commented options that follow &%check_local_user%&,
6033 namely:
6034 .code
6035 # local_part_suffix = +* : -*
6036 # local_part_suffix_optional
6037 .endd
6038 .vindex "&$local_part_suffix$&"
6039 show how you can specify the recognition of local part suffixes. If the first
6040 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6041 by any sequence of characters, is removed from the local part and placed in the
6042 variable &$local_part_suffix$&. The second suffix option specifies that the
6043 presence of a suffix in the local part is optional. When a suffix is present,
6044 the check for a local login uses the local part with the suffix removed.
6045
6046 When a local user account is found, the file called &_.forward_& in the user's
6047 home directory is consulted. If it does not exist, or is empty, the router
6048 declines. Otherwise, the contents of &_.forward_& are interpreted as
6049 redirection data (see chapter &<<CHAPredirect>>& for more details).
6050
6051 .cindex "Sieve filter" "enabling in default router"
6052 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6053 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6054 is commented out by default), the contents of the file are interpreted as a set
6055 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6056 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6057 separate document entitled &'Exim's interfaces to mail filtering'&.
6058
6059 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6060 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6061 There are two reasons for doing this:
6062
6063 .olist
6064 Whether or not a local user has a &_.forward_& file is not really relevant when
6065 checking an address for validity; it makes sense not to waste resources doing
6066 unnecessary work.
6067 .next
6068 More importantly, when Exim is verifying addresses or handling an EXPN
6069 command during an SMTP session, it is running as the Exim user, not as root.
6070 The group is the Exim group, and no additional groups are set up.
6071 It may therefore not be possible for Exim to read users' &_.forward_& files at
6072 this time.
6073 .endlist
6074
6075 The setting of &%check_ancestor%& prevents the router from generating a new
6076 address that is the same as any previous address that was redirected. (This
6077 works round a problem concerning a bad interaction between aliasing and
6078 forwarding &-- see section &<<SECTredlocmai>>&).
6079
6080 The final three option settings specify the transports that are to be used when
6081 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6082 auto-reply, respectively. For example, if a &_.forward_& file contains
6083 .code
6084 a.nother@elsewhere.example, /home/spqr/archive
6085 .endd
6086 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6087 transport.
6088 .code
6089 localuser:
6090   driver = accept
6091   check_local_user
6092 # local_part_suffix = +* : -*
6093 # local_part_suffix_optional
6094   transport = local_delivery
6095 .endd
6096 The final router sets up delivery into local mailboxes, provided that the local
6097 part is the name of a local login, by accepting the address and assigning it to
6098 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6099 routers, so the address is bounced. The commented suffix settings fulfil the
6100 same purpose as they do for the &(userforward)& router.
6101
6102
6103 .section "Transport configuration" "SECID56"
6104 .cindex "default" "transports"
6105 .cindex "transports" "default"
6106 Transports define mechanisms for actually delivering messages. They operate
6107 only when referenced from routers, so the order in which they are defined does
6108 not matter. The transports section of the configuration starts with
6109 .code
6110 begin transports
6111 .endd
6112 One remote transport and four local transports are defined.
6113 .code
6114 remote_smtp:
6115   driver = smtp
6116   hosts_try_prdr = *
6117 .endd
6118 This transport is used for delivering messages over SMTP connections.
6119 The list of remote hosts comes from the router.
6120 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6121 It is negotiated between client and server
6122 and not expected to cause problems but can be disabled if needed.
6123 All other options are defaulted.
6124 .code
6125 local_delivery:
6126   driver = appendfile
6127   file = /var/mail/$local_part
6128   delivery_date_add
6129   envelope_to_add
6130   return_path_add
6131 # group = mail
6132 # mode = 0660
6133 .endd
6134 This &(appendfile)& transport is used for local delivery to user mailboxes in
6135 traditional BSD mailbox format. By default it runs under the uid and gid of the
6136 local user, which requires the sticky bit to be set on the &_/var/mail_&
6137 directory. Some systems use the alternative approach of running mail deliveries
6138 under a particular group instead of using the sticky bit. The commented options
6139 show how this can be done.
6140
6141 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6142 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6143 similarly-named options above.
6144 .code
6145 address_pipe:
6146   driver = pipe
6147   return_output
6148 .endd
6149 This transport is used for handling deliveries to pipes that are generated by
6150 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6151 option specifies that any output on stdout or stderr generated by the pipe is to
6152 be returned to the sender.
6153 .code
6154 address_file:
6155   driver = appendfile
6156   delivery_date_add
6157   envelope_to_add
6158   return_path_add
6159 .endd
6160 This transport is used for handling deliveries to files that are generated by
6161 redirection. The name of the file is not specified in this instance of
6162 &(appendfile)&, because it comes from the &(redirect)& router.
6163 .code
6164 address_reply:
6165   driver = autoreply
6166 .endd
6167 This transport is used for handling automatic replies generated by users'
6168 filter files.
6169
6170
6171
6172 .section "Default retry rule" "SECID57"
6173 .cindex "retry" "default rule"
6174 .cindex "default" "retry rule"
6175 The retry section of the configuration file contains rules which affect the way
6176 Exim retries deliveries that cannot be completed at the first attempt. It is
6177 introduced by the line
6178 .code
6179 begin retry
6180 .endd
6181 In the default configuration, there is just one rule, which applies to all
6182 errors:
6183 .code
6184 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6185 .endd
6186 This causes any temporarily failing address to be retried every 15 minutes for
6187 2 hours, then at intervals starting at one hour and increasing by a factor of
6188 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6189 is not delivered after 4 days of temporary failure, it is bounced. The time is
6190 measured from first failure, not from the time the message was received.
6191
6192 If the retry section is removed from the configuration, or is empty (that is,
6193 if no retry rules are defined), Exim will not retry deliveries. This turns
6194 temporary errors into permanent errors.
6195
6196
6197 .section "Rewriting configuration" "SECID58"
6198 The rewriting section of the configuration, introduced by
6199 .code
6200 begin rewrite
6201 .endd
6202 contains rules for rewriting addresses in messages as they arrive. There are no
6203 rewriting rules in the default configuration file.
6204
6205
6206
6207 .section "Authenticators configuration" "SECTdefconfauth"
6208 .cindex "AUTH" "configuration"
6209 The authenticators section of the configuration, introduced by
6210 .code
6211 begin authenticators
6212 .endd
6213 defines mechanisms for the use of the SMTP AUTH command. The default
6214 configuration file contains two commented-out example authenticators
6215 which support plaintext username/password authentication using the
6216 standard PLAIN mechanism and the traditional but non-standard LOGIN
6217 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6218 to support most MUA software.
6219
6220 The example PLAIN authenticator looks like this:
6221 .code
6222 #PLAIN:
6223 #  driver                  = plaintext
6224 #  server_set_id           = $auth2
6225 #  server_prompts          = :
6226 #  server_condition        = Authentication is not yet configured
6227 #  server_advertise_condition = ${if def:tls_in_cipher }
6228 .endd
6229 And the example LOGIN authenticator looks like this:
6230 .code
6231 #LOGIN:
6232 #  driver                  = plaintext
6233 #  server_set_id           = $auth1
6234 #  server_prompts          = <| Username: | Password:
6235 #  server_condition        = Authentication is not yet configured
6236 #  server_advertise_condition = ${if def:tls_in_cipher }
6237 .endd
6238
6239 The &%server_set_id%& option makes Exim remember the authenticated username
6240 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6241 &%server_prompts%& option configures the &(plaintext)& authenticator so
6242 that it implements the details of the specific authentication mechanism,
6243 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6244 when Exim offers authentication to clients; in the examples, this is only
6245 when TLS or SSL has been started, so to enable the authenticators you also
6246 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6247
6248 The &%server_condition%& setting defines how to verify that the username and
6249 password are correct. In the examples it just produces an error message.
6250 To make the authenticators work, you can use a string expansion
6251 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6252
6253 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6254 usercode and password are in different positions.
6255 Chapter &<<CHAPplaintext>>& covers both.
6256
6257 .ecindex IIDconfiwal
6258
6259
6260
6261 . ////////////////////////////////////////////////////////////////////////////
6262 . ////////////////////////////////////////////////////////////////////////////
6263
6264 .chapter "Regular expressions" "CHAPregexp"
6265
6266 .cindex "regular expressions" "library"
6267 .cindex "PCRE"
6268 Exim supports the use of regular expressions in many of its options. It
6269 uses the PCRE regular expression library; this provides regular expression
6270 matching that is compatible with Perl 5. The syntax and semantics of
6271 regular expressions is discussed in many Perl reference books, and also in
6272 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6273 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6274
6275 The documentation for the syntax and semantics of the regular expressions that
6276 are supported by PCRE is included in the PCRE distribution, and no further
6277 description is included here. The PCRE functions are called from Exim using
6278 the default option settings (that is, with no PCRE options set), except that
6279 the PCRE_CASELESS option is set when the matching is required to be
6280 case-insensitive.
6281
6282 In most cases, when a regular expression is required in an Exim configuration,
6283 it has to start with a circumflex, in order to distinguish it from plain text
6284 or an &"ends with"& wildcard. In this example of a configuration setting, the
6285 second item in the colon-separated list is a regular expression.
6286 .code
6287 domains = a.b.c : ^\\d{3} : *.y.z : ...
6288 .endd
6289 The doubling of the backslash is required because of string expansion that
6290 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6291 of this issue, and a way of avoiding the need for doubling backslashes. The
6292 regular expression that is eventually used in this example contains just one
6293 backslash. The circumflex is included in the regular expression, and has the
6294 normal effect of &"anchoring"& it to the start of the string that is being
6295 matched.
6296
6297 There are, however, two cases where a circumflex is not required for the
6298 recognition of a regular expression: these are the &%match%& condition in a
6299 string expansion, and the &%matches%& condition in an Exim filter file. In
6300 these cases, the relevant string is always treated as a regular expression; if
6301 it does not start with a circumflex, the expression is not anchored, and can
6302 match anywhere in the subject string.
6303
6304 In all cases, if you want a regular expression to match at the end of a string,
6305 you must code the $ metacharacter to indicate this. For example:
6306 .code
6307 domains = ^\\d{3}\\.example
6308 .endd
6309 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6310 You need to use:
6311 .code
6312 domains = ^\\d{3}\\.example\$
6313 .endd
6314 if you want &'example'& to be the top-level domain. The backslash before the
6315 $ is needed because string expansion also interprets dollar characters.
6316
6317
6318
6319 . ////////////////////////////////////////////////////////////////////////////
6320 . ////////////////////////////////////////////////////////////////////////////
6321
6322 .chapter "File and database lookups" "CHAPfdlookup"
6323 .scindex IIDfidalo1 "file" "lookups"
6324 .scindex IIDfidalo2 "database" "lookups"
6325 .cindex "lookup" "description of"
6326 Exim can be configured to look up data in files or databases as it processes
6327 messages. Two different kinds of syntax are used:
6328
6329 .olist
6330 A string that is to be expanded may contain explicit lookup requests. These
6331 cause parts of the string to be replaced by data that is obtained from the
6332 lookup. Lookups of this type are conditional expansion items. Different results
6333 can be defined for the cases of lookup success and failure. See chapter
6334 &<<CHAPexpand>>&, where string expansions are described in detail.
6335 The key for the lookup is specified as part of the string expansion.
6336 .next
6337 Lists of domains, hosts, and email addresses can contain lookup requests as a
6338 way of avoiding excessively long linear lists. In this case, the data that is
6339 returned by the lookup is often (but not always) discarded; whether the lookup
6340 succeeds or fails is what really counts. These kinds of list are described in
6341 chapter &<<CHAPdomhosaddlists>>&.
6342 The key for the lookup is given by the context in which the list is expanded.
6343 .endlist
6344
6345 String expansions, lists, and lookups interact with each other in such a way
6346 that there is no order in which to describe any one of them that does not
6347 involve references to the others. Each of these three chapters makes more sense
6348 if you have read the other two first. If you are reading this for the first
6349 time, be aware that some of it will make a lot more sense after you have read
6350 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6351
6352 .section "Examples of different lookup syntax" "SECID60"
6353 It is easy to confuse the two different kinds of lookup, especially as the
6354 lists that may contain the second kind are always expanded before being
6355 processed as lists. Therefore, they may also contain lookups of the first kind.
6356 Be careful to distinguish between the following two examples:
6357 .code
6358 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6359 domains = lsearch;/some/file
6360 .endd
6361 The first uses a string expansion, the result of which must be a domain list.
6362 No strings have been specified for a successful or a failing lookup; the
6363 defaults in this case are the looked-up data and an empty string, respectively.
6364 The expansion takes place before the string is processed as a list, and the
6365 file that is searched could contain lines like this:
6366 .code
6367 192.168.3.4: domain1:domain2:...
6368 192.168.1.9: domain3:domain4:...
6369 .endd
6370 When the lookup succeeds, the result of the expansion is a list of domains (and
6371 possibly other types of item that are allowed in domain lists).
6372
6373 In the second example, the lookup is a single item in a domain list. It causes
6374 Exim to use a lookup to see if the domain that is being processed can be found
6375 in the file. The file could contains lines like this:
6376 .code
6377 domain1:
6378 domain2:
6379 .endd
6380 Any data that follows the keys is not relevant when checking that the domain
6381 matches the list item.
6382
6383 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6384 Consider a file containing lines like this:
6385 .code
6386 192.168.5.6: lsearch;/another/file
6387 .endd
6388 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6389 first &%domains%& setting above generates the second setting, which therefore
6390 causes a second lookup to occur.
6391
6392 The rest of this chapter describes the different lookup types that are
6393 available. Any of them can be used in any part of the configuration where a
6394 lookup is permitted.
6395
6396
6397 .section "Lookup types" "SECID61"
6398 .cindex "lookup" "types of"
6399 .cindex "single-key lookup" "definition of"
6400 Two different types of data lookup are implemented:
6401
6402 .ilist
6403 The &'single-key'& type requires the specification of a file in which to look,
6404 and a single key to search for. The key must be a non-empty string for the
6405 lookup to succeed. The lookup type determines how the file is searched.
6406 .next
6407 .cindex "query-style lookup" "definition of"
6408 The &'query-style'& type accepts a generalized database query. No particular
6409 key value is assumed by Exim for query-style lookups. You can use whichever
6410 Exim variables you need to construct the database query.
6411 .endlist
6412
6413 The code for each lookup type is in a separate source file that is included in
6414 the binary of Exim only if the corresponding compile-time option is set. The
6415 default settings in &_src/EDITME_& are:
6416 .code
6417 LOOKUP_DBM=yes
6418 LOOKUP_LSEARCH=yes
6419 .endd
6420 which means that only linear searching and DBM lookups are included by default.
6421 For some types of lookup (e.g. SQL databases), you need to install appropriate
6422 libraries and header files before building Exim.
6423
6424
6425
6426
6427 .section "Single-key lookup types" "SECTsinglekeylookups"
6428 .cindex "lookup" "single-key types"
6429 .cindex "single-key lookup" "list of types"
6430 The following single-key lookup types are implemented:
6431
6432 .ilist
6433 .cindex "cdb" "description of"
6434 .cindex "lookup" "cdb"
6435 .cindex "binary zero" "in lookup key"
6436 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6437 string without a terminating binary zero. The cdb format is designed for
6438 indexed files that are read frequently and never updated, except by total
6439 re-creation. As such, it is particularly suitable for large files containing
6440 aliases or other indexed data referenced by an MTA. Information about cdb can
6441 be found in several places:
6442 .display
6443 &url(http://www.pobox.com/~djb/cdb.html)
6444 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6445 &url(http://packages.debian.org/stable/utils/freecdb.html)
6446 .endd
6447 A cdb distribution is not needed in order to build Exim with cdb support,
6448 because the code for reading cdb files is included directly in Exim itself.
6449 However, no means of building or testing cdb files is provided with Exim, so
6450 you need to obtain a cdb distribution in order to do this.
6451 .next
6452 .cindex "DBM" "lookup type"
6453 .cindex "lookup" "dbm"
6454 .cindex "binary zero" "in lookup key"
6455 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6456 DBM file by looking up the record with the given key. A terminating binary
6457 zero is included in the key that is passed to the DBM library. See section
6458 &<<SECTdb>>& for a discussion of DBM libraries.
6459
6460 .cindex "Berkeley DB library" "file format"
6461 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6462 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6463 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6464 the DB_UNKNOWN option. This enables it to handle any of the types of database
6465 that the library supports, and can be useful for accessing DBM files created by
6466 other applications. (For earlier DB versions, DB_HASH is always used.)
6467 .next
6468 .cindex "lookup" "dbmjz"
6469 .cindex "lookup" "dbm &-- embedded NULs"
6470 .cindex "sasldb2"
6471 .cindex "dbmjz lookup type"
6472 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6473 interpreted as an Exim list; the elements of the list are joined together with
6474 ASCII NUL characters to form the lookup key.  An example usage would be to
6475 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6476 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6477 &(cram_md5)& authenticator.
6478 .next
6479 .cindex "lookup" "dbmnz"
6480 .cindex "lookup" "dbm &-- terminating zero"
6481 .cindex "binary zero" "in lookup key"
6482 .cindex "Courier"
6483 .cindex "&_/etc/userdbshadow.dat_&"
6484 .cindex "dbmnz lookup type"
6485 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6486 is not included in the key that is passed to the DBM library. You may need this
6487 if you want to look up data in files that are created by or shared with some
6488 other application that does not use terminating zeros. For example, you need to
6489 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6490 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6491 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6492 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6493 .next
6494 .cindex "lookup" "dsearch"
6495 .cindex "dsearch lookup type"
6496 &(dsearch)&: The given file must be a directory; this is searched for an entry
6497 whose name is the key by calling the &[lstat()]& function. The key may not
6498 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6499 the lookup is the name of the entry, which may be a file, directory,
6500 symbolic link, or any other kind of directory entry. An example of how this
6501 lookup can be used to support virtual domains is given in section
6502 &<<SECTvirtualdomains>>&.
6503 .next
6504 .cindex "lookup" "iplsearch"
6505 .cindex "iplsearch lookup type"
6506 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6507 terminated by a colon or white space or the end of the line. The keys in the
6508 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6509 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6510 being interpreted as a key terminator. For example:
6511 .code
6512 1.2.3.4:           data for 1.2.3.4
6513 192.168.0.0/16:    data for 192.168.0.0/16
6514 "abcd::cdab":      data for abcd::cdab
6515 "abcd:abcd::/32"   data for abcd:abcd::/32
6516 .endd
6517 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6518 file is searched linearly, using the CIDR masks where present, until a matching
6519 key is found. The first key that matches is used; there is no attempt to find a
6520 &"best"& match. Apart from the way the keys are matched, the processing for
6521 &(iplsearch)& is the same as for &(lsearch)&.
6522
6523 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6524 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6525 lookup types support only literal keys.
6526
6527 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6528 the implicit key is the host's IP address rather than its name (see section
6529 &<<SECThoslispatsikey>>&).
6530 .next
6531 .cindex "linear search"
6532 .cindex "lookup" "lsearch"
6533 .cindex "lsearch lookup type"
6534 .cindex "case sensitivity" "in lsearch lookup"
6535 &(lsearch)&: The given file is a text file that is searched linearly for a
6536 line beginning with the search key, terminated by a colon or white space or the
6537 end of the line. The search is case-insensitive; that is, upper and lower case
6538 letters are treated as the same. The first occurrence of the key that is found
6539 in the file is used.
6540
6541 White space between the key and the colon is permitted. The remainder of the
6542 line, with leading and trailing white space removed, is the data. This can be
6543 continued onto subsequent lines by starting them with any amount of white
6544 space, but only a single space character is included in the data at such a
6545 junction. If the data begins with a colon, the key must be terminated by a
6546 colon, for example:
6547 .code
6548 baduser:  :fail:
6549 .endd
6550 Empty lines and lines beginning with # are ignored, even if they occur in the
6551 middle of an item. This is the traditional textual format of alias files. Note
6552 that the keys in an &(lsearch)& file are literal strings. There is no
6553 wildcarding of any kind.
6554
6555 .cindex "lookup" "lsearch &-- colons in keys"
6556 .cindex "white space" "in lsearch key"
6557 In most &(lsearch)& files, keys are not required to contain colons or #
6558 characters, or white space. However, if you need this feature, it is available.
6559 If a key begins with a doublequote character, it is terminated only by a
6560 matching quote (or end of line), and the normal escaping rules apply to its
6561 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6562 quoted keys (exactly as for unquoted keys). There is no special handling of
6563 quotes for the data part of an &(lsearch)& line.
6564
6565 .next
6566 .cindex "NIS lookup type"
6567 .cindex "lookup" "NIS"
6568 .cindex "binary zero" "in lookup key"
6569 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6570 the given key, without a terminating binary zero. There is a variant called
6571 &(nis0)& which does include the terminating binary zero in the key. This is
6572 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6573 aliases; the full map names must be used.
6574
6575 .next
6576 .cindex "wildlsearch lookup type"
6577 .cindex "lookup" "wildlsearch"
6578 .cindex "nwildlsearch lookup type"
6579 .cindex "lookup" "nwildlsearch"
6580 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6581 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6582 the file may be wildcarded. The difference between these two lookup types is
6583 that for &(wildlsearch)&, each key in the file is string-expanded before being
6584 used, whereas for &(nwildlsearch)&, no expansion takes place.
6585
6586 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6587 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6588 file that are regular expressions can be made case-sensitive by the use of
6589 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6590
6591 . ==== As this is a nested list, any displays it contains must be indented
6592 . ==== as otherwise they are too far to the left.
6593
6594 .olist
6595 The string may begin with an asterisk to mean &"ends with"&. For example:
6596 .code
6597     *.a.b.c       data for anything.a.b.c
6598     *fish         data for anythingfish
6599 .endd
6600 .next
6601 The string may begin with a circumflex to indicate a regular expression. For
6602 example, for &(wildlsearch)&:
6603 .code
6604     ^\N\d+\.a\.b\N    data for <digits>.a.b
6605 .endd
6606 Note the use of &`\N`& to disable expansion of the contents of the regular
6607 expression. If you are using &(nwildlsearch)&, where the keys are not
6608 string-expanded, the equivalent entry is:
6609 .code
6610     ^\d+\.a\.b        data for <digits>.a.b
6611 .endd
6612 The case-insensitive flag is set at the start of compiling the regular
6613 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6614 For example, to make the entire pattern case-sensitive:
6615 .code
6616     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6617 .endd
6618
6619 If the regular expression contains white space or colon characters, you must
6620 either quote it (see &(lsearch)& above), or represent these characters in other
6621 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6622 colon. This may be easier than quoting, because if you quote, you have to
6623 escape all the backslashes inside the quotes.
6624
6625 &*Note*&: It is not possible to capture substrings in a regular expression
6626 match for later use, because the results of all lookups are cached. If a lookup
6627 is repeated, the result is taken from the cache, and no actual pattern matching
6628 takes place. The values of all the numeric variables are unset after a
6629 &((n)wildlsearch)& match.
6630
6631 .next
6632 Although I cannot see it being of much use, the general matching function that
6633 is used to implement &((n)wildlsearch)& means that the string may begin with a
6634 lookup name terminated by a semicolon, and followed by lookup data. For
6635 example:
6636 .code
6637     cdb;/some/file  data for keys that match the file
6638 .endd
6639 The data that is obtained from the nested lookup is discarded.
6640 .endlist olist
6641
6642 Keys that do not match any of these patterns are interpreted literally. The
6643 continuation rules for the data are the same as for &(lsearch)&, and keys may
6644 be followed by optional colons.
6645
6646 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6647 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6648 lookup types support only literal keys.
6649 .endlist ilist
6650
6651
6652 .section "Query-style lookup types" "SECTquerystylelookups"
6653 .cindex "lookup" "query-style types"
6654 .cindex "query-style lookup" "list of types"
6655 The supported query-style lookup types are listed below. Further details about
6656 many of them are given in later sections.
6657
6658 .ilist
6659 .cindex "DNS" "as a lookup type"
6660 .cindex "lookup" "DNS"
6661 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6662 are given in the supplied query. The resulting data is the contents of the
6663 records. See section &<<SECTdnsdb>>&.
6664 .next
6665 .cindex "InterBase lookup type"
6666 .cindex "lookup" "InterBase"
6667 &(ibase)&: This does a lookup in an InterBase database.
6668 .next
6669 .cindex "LDAP" "lookup type"
6670 .cindex "lookup" "LDAP"
6671 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6672 returns attributes from a single entry. There is a variant called &(ldapm)&
6673 that permits values from multiple entries to be returned. A third variant
6674 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6675 any attribute values. See section &<<SECTldap>>&.
6676 .next
6677 .cindex "MySQL" "lookup type"
6678 .cindex "lookup" "MySQL"
6679 &(mysql)&: The format of the query is an SQL statement that is passed to a
6680 MySQL database. See section &<<SECTsql>>&.
6681 .next
6682 .cindex "NIS+ lookup type"
6683 .cindex "lookup" "NIS+"
6684 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6685 the field to be returned. See section &<<SECTnisplus>>&.
6686 .next
6687 .cindex "Oracle" "lookup type"
6688 .cindex "lookup" "Oracle"
6689 &(oracle)&: The format of the query is an SQL statement that is passed to an
6690 Oracle database. See section &<<SECTsql>>&.
6691 .next
6692 .cindex "lookup" "passwd"
6693 .cindex "passwd lookup type"
6694 .cindex "&_/etc/passwd_&"
6695 &(passwd)& is a query-style lookup with queries that are just user names. The
6696 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6697 success, the result string is the same as you would get from an &(lsearch)&
6698 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6699 password value. For example:
6700 .code
6701 *:42:42:King Rat:/home/kr:/bin/bash
6702 .endd
6703 .next
6704 .cindex "PostgreSQL lookup type"
6705 .cindex "lookup" "PostgreSQL"
6706 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6707 PostgreSQL database. See section &<<SECTsql>>&.
6708
6709 .next
6710 .cindex "Redis lookup type"
6711 .cindex lookup Redis
6712 &(redis)&: The format of the query is an SQL statement that is passed to a
6713 Redis database. See section &<<SECTsql>>&.
6714
6715 .next
6716 .cindex "sqlite lookup type"
6717 .cindex "lookup" "sqlite"
6718 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6719 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6720
6721 .next
6722 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6723 not likely to be useful in normal operation.
6724 .next
6725 .cindex "whoson lookup type"
6726 .cindex "lookup" "whoson"
6727 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6728 allows a server to check whether a particular (dynamically allocated) IP
6729 address is currently allocated to a known (trusted) user and, optionally, to
6730 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6731 at one time for &"POP before SMTP"& authentication, but that approach has been
6732 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6733 &"POP before SMTP"& checking using ACL statements such as
6734 .code
6735 require condition = \
6736   ${lookup whoson {$sender_host_address}{yes}{no}}
6737 .endd
6738 The query consists of a single IP address. The value returned is the name of
6739 the authenticated user, which is stored in the variable &$value$&. However, in
6740 this example, the data in &$value$& is not used; the result of the lookup is
6741 one of the fixed strings &"yes"& or &"no"&.
6742 .endlist
6743
6744
6745
6746 .section "Temporary errors in lookups" "SECID63"
6747 .cindex "lookup" "temporary error in"
6748 Lookup functions can return temporary error codes if the lookup cannot be
6749 completed. For example, an SQL or LDAP database might be unavailable. For this
6750 reason, it is not advisable to use a lookup that might do this for critical
6751 options such as a list of local domains.
6752
6753 When a lookup cannot be completed in a router or transport, delivery
6754 of the message (to the relevant address) is deferred, as for any other
6755 temporary error. In other circumstances Exim may assume the lookup has failed,
6756 or may give up altogether.
6757
6758
6759
6760 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6761 .cindex "wildcard lookups"
6762 .cindex "lookup" "default values"
6763 .cindex "lookup" "wildcard"
6764 .cindex "lookup" "* added to type"
6765 .cindex "default" "in single-key lookups"
6766 In this context, a &"default value"& is a value specified by the administrator
6767 that is to be used if a lookup fails.
6768
6769 &*Note:*& This section applies only to single-key lookups. For query-style
6770 lookups, the facilities of the query language must be used. An attempt to
6771 specify a default for a query-style lookup provokes an error.
6772
6773 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6774 and the initial lookup fails, the key &"*"& is looked up in the file to
6775 provide a default value. See also the section on partial matching below.
6776
6777 .cindex "*@ with single-key lookup"
6778 .cindex "lookup" "*@ added to type"
6779 .cindex "alias file" "per-domain default"
6780 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6781 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6782 character, a second lookup is done with everything before the last @ replaced
6783 by *. This makes it possible to provide per-domain defaults in alias files
6784 that include the domains in the keys. If the second lookup fails (or doesn't
6785 take place because there is no @ in the key), &"*"& is looked up.
6786 For example, a &(redirect)& router might contain:
6787 .code
6788 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6789 .endd
6790 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6791 looks up these keys, in this order:
6792 .code
6793 jane@eyre.example
6794 *@eyre.example
6795 *
6796 .endd
6797 The data is taken from whichever key it finds first. &*Note*&: In an
6798 &(lsearch)& file, this does not mean the first of these keys in the file. A
6799 complete scan is done for each key, and only if it is not found at all does
6800 Exim move on to try the next key.
6801
6802
6803
6804 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6805 .cindex "partial matching"
6806 .cindex "wildcard lookups"
6807 .cindex "lookup" "partial matching"
6808 .cindex "lookup" "wildcard"
6809 .cindex "asterisk" "in search type"
6810 The normal operation of a single-key lookup is to search the file for an exact
6811 match with the given key. However, in a number of situations where domains are
6812 being looked up, it is useful to be able to do partial matching. In this case,
6813 information in the file that has a key starting with &"*."& is matched by any
6814 domain that ends with the components that follow the full stop. For example, if
6815 a key in a DBM file is
6816 .code
6817 *.dates.fict.example
6818 .endd
6819 then when partial matching is enabled this is matched by (amongst others)
6820 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6821 by &'dates.fict.example'&, if that does not appear as a separate key in the
6822 file.
6823
6824 &*Note*&: Partial matching is not available for query-style lookups. It is
6825 also not available for any lookup items in address lists (see section
6826 &<<SECTaddresslist>>&).
6827
6828 Partial matching is implemented by doing a series of separate lookups using
6829 keys constructed by modifying the original subject key. This means that it can
6830 be used with any of the single-key lookup types, provided that
6831 partial matching keys
6832 beginning with a special prefix (default &"*."&) are included in the data file.
6833 Keys in the file that do not begin with the prefix are matched only by
6834 unmodified subject keys when partial matching is in use.
6835
6836 Partial matching is requested by adding the string &"partial-"& to the front of
6837 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6838 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6839 is added at the start of the subject key, and it is looked up again. If that
6840 fails, further lookups are tried with dot-separated components removed from the
6841 start of the subject key, one-by-one, and &"*."& added on the front of what
6842 remains.
6843
6844 A minimum number of two non-* components are required. This can be adjusted
6845 by including a number before the hyphen in the search type. For example,
6846 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6847 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6848 subject key is &'2250.dates.fict.example'& then the following keys are looked
6849 up when the minimum number of non-* components is two:
6850 .code
6851 2250.dates.fict.example
6852 *.2250.dates.fict.example
6853 *.dates.fict.example
6854 *.fict.example
6855 .endd
6856 As soon as one key in the sequence is successfully looked up, the lookup
6857 finishes.
6858
6859 .cindex "lookup" "partial matching &-- changing prefix"
6860 .cindex "prefix" "for partial matching"
6861 The use of &"*."& as the partial matching prefix is a default that can be
6862 changed. The motivation for this feature is to allow Exim to operate with file
6863 formats that are used by other MTAs. A different prefix can be supplied in
6864 parentheses instead of the hyphen after &"partial"&. For example:
6865 .code
6866 domains = partial(.)lsearch;/some/file
6867 .endd
6868 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6869 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6870 components is unchanged). The prefix may consist of any punctuation characters
6871 other than a closing parenthesis. It may be empty, for example:
6872 .code
6873 domains = partial1()cdb;/some/file
6874 .endd
6875 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6876 &`a.b.c`&, &`b.c`&, and &`c`&.
6877
6878 If &"partial0"& is specified, what happens at the end (when the lookup with
6879 just one non-wild component has failed, and the original key is shortened right
6880 down to the null string) depends on the prefix:
6881
6882 .ilist
6883 If the prefix has zero length, the whole lookup fails.
6884 .next
6885 If the prefix has length 1, a lookup for just the prefix is done. For
6886 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6887 .next
6888 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6889 remainder is looked up. With the default prefix, therefore, the final lookup is
6890 for &"*"& on its own.
6891 .next
6892 Otherwise, the whole prefix is looked up.
6893 .endlist
6894
6895
6896 If the search type ends in &"*"& or &"*@"& (see section
6897 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6898 this implies happens after all partial lookups have failed. If &"partial0"& is
6899 specified, adding &"*"& to the search type has no effect with the default
6900 prefix, because the &"*"& key is already included in the sequence of partial
6901 lookups. However, there might be a use for lookup types such as
6902 &"partial0(.)lsearch*"&.
6903
6904 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6905 in domain lists and the like. Partial matching works only in terms of
6906 dot-separated components; a key such as &`*fict.example`&
6907 in a database file is useless, because the asterisk in a partial matching
6908 subject key is always followed by a dot.
6909
6910
6911
6912
6913 .section "Lookup caching" "SECID64"
6914 .cindex "lookup" "caching"
6915 .cindex "caching" "lookup data"
6916 Exim caches all lookup results in order to avoid needless repetition of
6917 lookups. However, because (apart from the daemon) Exim operates as a collection
6918 of independent, short-lived processes, this caching applies only within a
6919 single Exim process. There is no inter-process lookup caching facility.
6920
6921 For single-key lookups, Exim keeps the relevant files open in case there is
6922 another lookup that needs them. In some types of configuration this can lead to
6923 many files being kept open for messages with many recipients. To avoid hitting
6924 the operating system limit on the number of simultaneously open files, Exim
6925 closes the least recently used file when it needs to open more files than its
6926 own internal limit, which can be changed via the &%lookup_open_max%& option.
6927
6928 The single-key lookup files are closed and the lookup caches are flushed at
6929 strategic points during delivery &-- for example, after all routing is
6930 complete.
6931
6932
6933
6934
6935 .section "Quoting lookup data" "SECID65"
6936 .cindex "lookup" "quoting"
6937 .cindex "quoting" "in lookups"
6938 When data from an incoming message is included in a query-style lookup, there
6939 is the possibility of special characters in the data messing up the syntax of
6940 the query. For example, a NIS+ query that contains
6941 .code
6942 [name=$local_part]
6943 .endd
6944 will be broken if the local part happens to contain a closing square bracket.
6945 For NIS+, data can be enclosed in double quotes like this:
6946 .code
6947 [name="$local_part"]
6948 .endd
6949 but this still leaves the problem of a double quote in the data. The rule for
6950 NIS+ is that double quotes must be doubled. Other lookup types have different
6951 rules, and to cope with the differing requirements, an expansion operator
6952 of the following form is provided:
6953 .code
6954 ${quote_<lookup-type>:<string>}
6955 .endd
6956 For example, the safest way to write the NIS+ query is
6957 .code
6958 [name="${quote_nisplus:$local_part}"]
6959 .endd
6960 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6961 operator can be used for all lookup types, but has no effect for single-key
6962 lookups, since no quoting is ever needed in their key strings.
6963
6964
6965
6966
6967 .section "More about dnsdb" "SECTdnsdb"
6968 .cindex "dnsdb lookup"
6969 .cindex "lookup" "dnsdb"
6970 .cindex "DNS" "as a lookup type"
6971 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6972 of a record type and a domain name, separated by an equals sign. For example,
6973 an expansion string could contain:
6974 .code
6975 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6976 .endd
6977 If the lookup succeeds, the result is placed in &$value$&, which in this case
6978 is used on its own as the result. If the lookup does not succeed, the
6979 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6980 &<<SECTforexpfai>>& for an explanation of what this means.
6981
6982 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6983 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6984 If no type is given, TXT is assumed.
6985
6986 For any record type, if multiple records are found, the data is returned as a
6987 concatenation, with newline as the default separator. The order, of course,
6988 depends on the DNS resolver. You can specify a different separator character
6989 between multiple records by putting a right angle-bracket followed immediately
6990 by the new separator at the start of the query. For example:
6991 .code
6992 ${lookup dnsdb{>: a=host1.example}}
6993 .endd
6994 It is permitted to specify a space as the separator character. Further
6995 white space is ignored.
6996 For lookup types that return multiple fields per record,
6997 an alternate field separator can be specified using a comma after the main
6998 separator character, followed immediately by the field separator.
6999
7000 .cindex "PTR record" "in &(dnsdb)& lookup"
7001 When the type is PTR,
7002 the data can be an IP address, written as normal; inversion and the addition of
7003 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7004 .code
7005 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7006 .endd
7007 If the data for a PTR record is not a syntactically valid IP address, it is not
7008 altered and nothing is added.
7009
7010 .cindex "MX record" "in &(dnsdb)& lookup"
7011 .cindex "SRV record" "in &(dnsdb)& lookup"
7012 For an MX lookup, both the preference value and the host name are returned for
7013 each record, separated by a space. For an SRV lookup, the priority, weight,
7014 port, and host name are returned for each record, separated by spaces.
7015 The field separator can be modified as above.
7016
7017 .cindex "TXT record" "in &(dnsdb)& lookup"
7018 .cindex "SPF record" "in &(dnsdb)& lookup"
7019 For TXT records with multiple items of data, only the first item is returned,
7020 unless a field separator is specified.
7021 To concatenate items without a separator, use a semicolon instead.
7022 For SPF records the
7023 default behaviour is to concatenate multiple items without using a separator.
7024 .code
7025 ${lookup dnsdb{>\n,: txt=a.b.example}}
7026 ${lookup dnsdb{>\n; txt=a.b.example}}
7027 ${lookup dnsdb{spf=example.org}}
7028 .endd
7029 It is permitted to specify a space as the separator character. Further
7030 white space is ignored.
7031
7032 .cindex "SOA record" "in &(dnsdb)& lookup"
7033 For an SOA lookup, while no result is obtained the lookup is redone with
7034 successively more leading components dropped from the given domain.
7035 Only the primary-nameserver field is returned unless a field separator is
7036 specified.
7037 .code
7038 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7039 .endd
7040
7041 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7042 .cindex "dnsdb modifiers"
7043 .cindex "modifiers" "dnsdb"
7044 .cindex "options" "dnsdb"
7045 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7046 each followed by a comma,
7047 that may appear before the record type.
7048
7049 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7050 temporary DNS error for any of them, the behaviour is controlled by
7051 a defer-option modifier.
7052 The possible keywords are
7053 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7054 With &"strict"& behaviour, any temporary DNS error causes the
7055 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7056 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7057 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7058 error causes the whole lookup to defer only if none of the other lookups
7059 succeed. The default is &"lax"&, so the following lookups are equivalent:
7060 .code
7061 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7062 ${lookup dnsdb{a=one.host.com:two.host.com}}
7063 .endd
7064 Thus, in the default case, as long as at least one of the DNS lookups
7065 yields some data, the lookup succeeds.
7066
7067 .cindex "DNSSEC" "dns lookup"
7068 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7069 The possible keywords are
7070 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7071 With &"strict"& or &"lax"& DNSSEC information is requested
7072 with the lookup.
7073 With &"strict"& a response from the DNS resolver that
7074 is not labelled as authenticated data
7075 is treated as equivalent to a temporary DNS error.
7076 The default is &"never"&.
7077
7078 See also the &$lookup_dnssec_authenticated$& variable.
7079
7080 .cindex timeout "dns lookup"
7081 .cindex "DNS" timeout
7082 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7083 The form is &"retrans_VAL"& where VAL is an Exim time specification
7084 (e.g. &"5s"&).
7085 The default value is set by the main configuration option &%dns_retrans%&.
7086
7087 Retries for the dnsdb lookup can be controlled by a retry modifier.
7088 The form if &"retry_VAL"& where VAL is an integer.
7089 The default count is set by the main configuration option &%dns_retry%&.
7090
7091 .cindex cacheing "of dns lookup"
7092 .cindex TTL "of dns lookup"
7093 .cindex DNS TTL
7094 Dnsdb lookup results are cached within a single process (and its children).
7095 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7096 value of the set of returned DNS records.
7097
7098
7099 .section "Pseudo dnsdb record types" "SECID66"
7100 .cindex "MX record" "in &(dnsdb)& lookup"
7101 By default, both the preference value and the host name are returned for
7102 each MX record, separated by a space. If you want only host names, you can use
7103 the pseudo-type MXH:
7104 .code
7105 ${lookup dnsdb{mxh=a.b.example}}
7106 .endd
7107 In this case, the preference values are omitted, and just the host names are
7108 returned.
7109
7110 .cindex "name server for enclosing domain"
7111 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7112 records on the given domain, but if none are found, it removes the first
7113 component of the domain name, and tries again. This process continues until NS
7114 records are found or there are no more components left (or there is a DNS
7115 error). In other words, it may return the name servers for a top-level domain,
7116 but it never returns the root name servers. If there are no NS records for the
7117 top-level domain, the lookup fails. Consider these examples:
7118 .code
7119 ${lookup dnsdb{zns=xxx.quercite.com}}
7120 ${lookup dnsdb{zns=xxx.edu}}
7121 .endd
7122 Assuming that in each case there are no NS records for the full domain name,
7123 the first returns the name servers for &%quercite.com%&, and the second returns
7124 the name servers for &%edu%&.
7125
7126 You should be careful about how you use this lookup because, unless the
7127 top-level domain does not exist, the lookup always returns some host names. The
7128 sort of use to which this might be put is for seeing if the name servers for a
7129 given domain are on a blacklist. You can probably assume that the name servers
7130 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7131 such a list.
7132
7133 .cindex "CSA" "in &(dnsdb)& lookup"
7134 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7135 records according to the CSA rules, which are described in section
7136 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7137 not sufficient because of the extra parent domain search behaviour of CSA. The
7138 result of a successful lookup such as:
7139 .code
7140 ${lookup dnsdb {csa=$sender_helo_name}}
7141 .endd
7142 has two space-separated fields: an authorization code and a target host name.
7143 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7144 authorization required but absent, or &"?"& for unknown.
7145
7146 .cindex "A+" "in &(dnsdb)& lookup"
7147 The pseudo-type A+ performs an AAAA
7148 and then an A lookup.  All results are returned; defer processing
7149 (see below) is handled separately for each lookup.  Example:
7150 .code
7151 ${lookup dnsdb {>; a+=$sender_helo_name}}
7152 .endd
7153
7154
7155 .section "Multiple dnsdb lookups" "SECID67"
7156 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7157 However, you can specify a list of domains or IP addresses in a single
7158 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7159 the default separator, but with the ability to change this. For example:
7160 .code
7161 ${lookup dnsdb{one.domain.com:two.domain.com}}
7162 ${lookup dnsdb{a=one.host.com:two.host.com}}
7163 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7164 .endd
7165 In order to retain backwards compatibility, there is one special case: if
7166 the lookup type is PTR and no change of separator is specified, Exim looks
7167 to see if the rest of the string is precisely one IPv6 address. In this
7168 case, it does not treat it as a list.
7169
7170 The data from each lookup is concatenated, with newline separators by default,
7171 in the same way that multiple DNS records for a single item are handled. A
7172 different separator can be specified, as described above.
7173
7174
7175
7176
7177 .section "More about LDAP" "SECTldap"
7178 .cindex "LDAP" "lookup, more about"
7179 .cindex "lookup" "LDAP"
7180 .cindex "Solaris" "LDAP"
7181 The original LDAP implementation came from the University of Michigan; this has
7182 become &"Open LDAP"&, and there are now two different releases. Another
7183 implementation comes from Netscape, and Solaris 7 and subsequent releases
7184 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7185 the lookup function level, their error handling is different. For this reason
7186 it is necessary to set a compile-time variable when building Exim with LDAP, to
7187 indicate which LDAP library is in use. One of the following should appear in
7188 your &_Local/Makefile_&:
7189 .code
7190 LDAP_LIB_TYPE=UMICHIGAN
7191 LDAP_LIB_TYPE=OPENLDAP1
7192 LDAP_LIB_TYPE=OPENLDAP2
7193 LDAP_LIB_TYPE=NETSCAPE
7194 LDAP_LIB_TYPE=SOLARIS
7195 .endd
7196 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7197 same interface as the University of Michigan version.
7198
7199 There are three LDAP lookup types in Exim. These behave slightly differently in
7200 the way they handle the results of a query:
7201
7202 .ilist
7203 &(ldap)& requires the result to contain just one entry; if there are more, it
7204 gives an error.
7205 .next
7206 &(ldapdn)& also requires the result to contain just one entry, but it is the
7207 Distinguished Name that is returned rather than any attribute values.
7208 .next
7209 &(ldapm)& permits the result to contain more than one entry; the attributes
7210 from all of them are returned.
7211 .endlist
7212
7213
7214 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7215 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7216 the data returned by a successful lookup is described in the next section.
7217 First we explain how LDAP queries are coded.
7218
7219
7220 .section "Format of LDAP queries" "SECTforldaque"
7221 .cindex "LDAP" "query format"
7222 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7223 the configuration of a &(redirect)& router one might have this setting:
7224 .code
7225 data = ${lookup ldap \
7226   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7227   c=UK?mailbox?base?}}
7228 .endd
7229 .cindex "LDAP" "with TLS"
7230 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7231 secure (encrypted) LDAP connections. The second of these ensures that an
7232 encrypted TLS connection is used.
7233
7234 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7235 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7236 See the &%ldap_start_tls%& option.
7237
7238 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7239 controlled. Every part of the TLS configuration can be configured by settings in
7240 &_exim.conf_&. Depending on the version of the client libraries installed on
7241 your system, some of the initialization may have required setting options in
7242 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7243 certificates. This revealed a nuance where the current UID that exim was
7244 running as could affect which config files it read. With Exim 4.83, these
7245 methods become optional, only taking effect if not specifically set in
7246 &_exim.conf_&.
7247
7248
7249 .section "LDAP quoting" "SECID68"
7250 .cindex "LDAP" "quoting"
7251 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7252 and the second because the LDAP query is represented as a URL. Furthermore,
7253 within an LDAP query, two different kinds of quoting are required. For this
7254 reason, there are two different LDAP-specific quoting operators.
7255
7256 The &%quote_ldap%& operator is designed for use on strings that are part of
7257 filter specifications. Conceptually, it first does the following conversions on
7258 the string:
7259 .code
7260 *   =>   \2A
7261 (   =>   \28
7262 )   =>   \29
7263 \   =>   \5C
7264 .endd
7265 in accordance with RFC 2254. The resulting string is then quoted according
7266 to the rules for URLs, that is, all non-alphanumeric characters except
7267 .code
7268 ! $ ' - . _ ( ) * +
7269 .endd
7270 are converted to their hex values, preceded by a percent sign. For example:
7271 .code
7272 ${quote_ldap: a(bc)*, a<yz>; }
7273 .endd
7274 yields
7275 .code
7276 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7277 .endd
7278 Removing the URL quoting, this is (with a leading and a trailing space):
7279 .code
7280 a\28bc\29\2A, a<yz>;
7281 .endd
7282 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7283 base DN specifications in queries. Conceptually, it first converts the string
7284 by inserting a backslash in front of any of the following characters:
7285 .code
7286 , + " \ < > ;
7287 .endd
7288 It also inserts a backslash before any leading spaces or # characters, and
7289 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7290 is then quoted according to the rules for URLs. For example:
7291 .code
7292 ${quote_ldap_dn: a(bc)*, a<yz>; }
7293 .endd
7294 yields
7295 .code
7296 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7297 .endd
7298 Removing the URL quoting, this is (with a trailing space):
7299 .code
7300 \ a(bc)*\, a\<yz\>\;\
7301 .endd
7302 There are some further comments about quoting in the section on LDAP
7303 authentication below.
7304
7305
7306 .section "LDAP connections" "SECID69"
7307 .cindex "LDAP" "connections"
7308 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7309 is in use, via a Unix domain socket. The example given above does not specify
7310 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7311 by starting it with
7312 .code
7313 ldap://<hostname>:<port>/...
7314 .endd
7315 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7316 used. When no server is specified in a query, a list of default servers is
7317 taken from the &%ldap_default_servers%& configuration option. This supplies a
7318 colon-separated list of servers which are tried in turn until one successfully
7319 handles a query, or there is a serious error. Successful handling either
7320 returns the requested data, or indicates that it does not exist. Serious errors
7321 are syntactical, or multiple values when only a single value is expected.
7322 Errors which cause the next server to be tried are connection failures, bind
7323 failures, and timeouts.
7324
7325 For each server name in the list, a port number can be given. The standard way
7326 of specifying a host and port is to use a colon separator (RFC 1738). Because
7327 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7328 doubled. For example
7329 .code
7330 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7331 .endd
7332 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7333 to the LDAP library with no server name, and the library's default (normally
7334 the local host) is used.
7335
7336 If you are using the OpenLDAP library, you can connect to an LDAP server using
7337 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7338 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7339 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7340 not available.
7341
7342 For this type of connection, instead of a host name for the server, a pathname
7343 for the socket is required, and the port number is not relevant. The pathname
7344 can be specified either as an item in &%ldap_default_servers%&, or inline in
7345 the query. In the former case, you can have settings such as
7346 .code
7347 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7348 .endd
7349 When the pathname is given in the query, you have to escape the slashes as
7350 &`%2F`& to fit in with the LDAP URL syntax. For example:
7351 .code
7352 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7353 .endd
7354 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7355 a pathname, it uses the Unix domain socket code, even if the query actually
7356 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7357 socket connection. This behaviour means that you can use a setting of
7358 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7359 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7360 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7361 backup host.
7362
7363 If an explicit &`ldapi`& type is given in a query when a host name is
7364 specified, an error is diagnosed. However, if there are more items in
7365 &%ldap_default_servers%&, they are tried. In other words:
7366
7367 .ilist
7368 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7369 interface.
7370 .next
7371 Using &`ldapi`& with a host name causes an error.
7372 .endlist
7373
7374
7375 Using &`ldapi`& with no host or path in the query, and no setting of
7376 &%ldap_default_servers%&, does whatever the library does by default.
7377
7378
7379
7380 .section "LDAP authentication and control information" "SECID70"
7381 .cindex "LDAP" "authentication"
7382 The LDAP URL syntax provides no way of passing authentication and other control
7383 information to the server. To make this possible, the URL in an LDAP query may
7384 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7385 spaces. If a value contains spaces it must be enclosed in double quotes, and
7386 when double quotes are used, backslash is interpreted in the usual way inside
7387 them. The following names are recognized:
7388 .display
7389 &`DEREFERENCE`&  set the dereferencing parameter
7390 &`NETTIME    `&  set a timeout for a network operation
7391 &`USER       `&  set the DN, for authenticating the LDAP bind
7392 &`PASS       `&  set the password, likewise
7393 &`REFERRALS  `&  set the referrals parameter
7394 &`SERVERS    `&  set alternate server list for this query only
7395 &`SIZE       `&  set the limit for the number of entries returned
7396 &`TIME       `&  set the maximum waiting time for a query
7397 .endd
7398 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7399 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7400 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7401 library from trying to follow referrals issued by the LDAP server.
7402
7403 .cindex LDAP timeout
7404 .cindex timeout "LDAP lookup"
7405 The name CONNECT is an obsolete name for NETTIME, retained for
7406 backwards compatibility. This timeout (specified as a number of seconds) is
7407 enforced from the client end for operations that can be carried out over a
7408 network. Specifically, it applies to network connections and calls to the
7409 &'ldap_result()'& function. If the value is greater than zero, it is used if
7410 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7411 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7412 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7413 Netscape SDK; for OpenLDAP no action is taken.
7414
7415 The TIME parameter (also a number of seconds) is passed to the server to
7416 set a server-side limit on the time taken to complete a search.
7417
7418 The SERVERS parameter allows you to specify an alternate list of ldap servers
7419 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7420 default list of ldap servers, and a single lookup can specify a single ldap
7421 server to use.  But when you need to do a lookup with a list of servers that is
7422 different than the default list (maybe different order, maybe a completely
7423 different set of servers), the SERVERS parameter allows you to specify this
7424 alternate list (colon-separated).
7425
7426 Here is an example of an LDAP query in an Exim lookup that uses some of these
7427 values. This is a single line, folded to fit on the page:
7428 .code
7429 ${lookup ldap
7430   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7431   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7432   {$value}fail}
7433 .endd
7434 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7435 any of the auxiliary data. Exim configuration settings that include lookups
7436 which contain password information should be preceded by &"hide"& to prevent
7437 non-admin users from using the &%-bP%& option to see their values.
7438
7439 The auxiliary data items may be given in any order. The default is no
7440 connection timeout (the system timeout is used), no user or password, no limit
7441 on the number of entries returned, and no time limit on queries.
7442
7443 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7444 removes any URL quoting that it may contain before passing it LDAP. Apparently
7445 some libraries do this for themselves, but some do not. Removing the URL
7446 quoting has two advantages:
7447
7448 .ilist
7449 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7450 DNs as with DNs inside actual queries.
7451 .next
7452 It permits spaces inside USER= DNs.
7453 .endlist
7454
7455 For example, a setting such as
7456 .code
7457 USER=cn=${quote_ldap_dn:$1}
7458 .endd
7459 should work even if &$1$& contains spaces.
7460
7461 Expanded data for the PASS= value should be quoted using the &%quote%&
7462 expansion operator, rather than the LDAP quote operators. The only reason this
7463 field needs quoting is to ensure that it conforms to the Exim syntax, which
7464 does not allow unquoted spaces. For example:
7465 .code
7466 PASS=${quote:$3}
7467 .endd
7468 The LDAP authentication mechanism can be used to check passwords as part of
7469 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7470 &<<CHAPexpand>>&.
7471
7472
7473
7474 .section "Format of data returned by LDAP" "SECID71"
7475 .cindex "LDAP" "returned data formats"
7476 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7477 as a sequence of values, for example
7478 .code
7479 cn=manager,o=University of Cambridge,c=UK
7480 .endd
7481 The &(ldap)& lookup type generates an error if more than one entry matches the
7482 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7483 the result between the data from different entries. It is possible for multiple
7484 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7485 you know that whatever values are returned all came from a single entry in the
7486 directory.
7487
7488 In the common case where you specify a single attribute in your LDAP query, the
7489 result is not quoted, and does not contain the attribute name. If the attribute
7490 has multiple values, they are separated by commas. Any comma that is
7491 part of an attribute's value is doubled.
7492
7493 If you specify multiple attributes, the result contains space-separated, quoted
7494 strings, each preceded by the attribute name and an equals sign. Within the
7495 quotes, the quote character, backslash, and newline are escaped with
7496 backslashes, and commas are used to separate multiple values for the attribute.
7497 Any commas in attribute values are doubled
7498 (permitting treatment of the values as a comma-separated list).
7499 Apart from the escaping, the string within quotes takes the same form as the
7500 output when a single attribute is requested. Specifying no attributes is the
7501 same as specifying all of an entry's attributes.
7502
7503 Here are some examples of the output format. The first line of each pair is an
7504 LDAP query, and the second is the data that is returned. The attribute called
7505 &%attr1%& has two values, one of them with an embedded comma, whereas
7506 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7507 (they have SUP &%attr%& in their schema definitions).
7508
7509 .code
7510 ldap:///o=base?attr1?sub?(uid=fred)
7511 value1.1,value1,,2
7512
7513 ldap:///o=base?attr2?sub?(uid=fred)
7514 value two
7515
7516 ldap:///o=base?attr?sub?(uid=fred)
7517 value1.1,value1,,2,value two
7518
7519 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7520 attr1="value1.1,value1,,2" attr2="value two"
7521
7522 ldap:///o=base??sub?(uid=fred)
7523 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7524 .endd
7525 You can
7526 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7527 results of LDAP lookups.
7528 The &%extract%& operator in string expansions can be used to pick out
7529 individual fields from data that consists of &'key'&=&'value'& pairs.
7530 The &%listextract%& operator should be used to pick out individual values
7531 of attributes, even when only a single value is expected.
7532 The doubling of embedded commas allows you to use the returned data as a
7533 comma separated list (using the "<," syntax for changing the input list separator).
7534
7535
7536
7537
7538 .section "More about NIS+" "SECTnisplus"
7539 .cindex "NIS+ lookup type"
7540 .cindex "lookup" "NIS+"
7541 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7542 and field name. If this is given, the result of a successful query is the
7543 contents of the named field; otherwise the result consists of a concatenation
7544 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7545 values containing spaces are quoted. For example, the query
7546 .code
7547 [name=mg1456],passwd.org_dir
7548 .endd
7549 might return the string
7550 .code
7551 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7552 home=/home/mg1456 shell=/bin/bash shadow=""
7553 .endd
7554 (split over two lines here to fit on the page), whereas
7555 .code
7556 [name=mg1456],passwd.org_dir:gcos
7557 .endd
7558 would just return
7559 .code
7560 Martin Guerre
7561 .endd
7562 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7563 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7564 operator is to double any quote characters within the text.
7565
7566
7567
7568 .section "SQL lookups" "SECTsql"
7569 .cindex "SQL lookup types"
7570 .cindex "MySQL" "lookup type"
7571 .cindex "PostgreSQL lookup type"
7572 .cindex "lookup" "MySQL"
7573 .cindex "lookup" "PostgreSQL"
7574 .cindex "Oracle" "lookup type"
7575 .cindex "lookup" "Oracle"
7576 .cindex "InterBase lookup type"
7577 .cindex "lookup" "InterBase"
7578 .cindex "Redis lookup type"
7579 .cindex lookup Redis
7580 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7581 and SQLite
7582 databases. Queries for these databases contain SQL statements, so an example
7583 might be
7584 .code
7585 ${lookup mysql{select mailbox from users where id='userx'}\
7586   {$value}fail}
7587 .endd
7588 If the result of the query contains more than one field, the data for each
7589 field in the row is returned, preceded by its name, so the result of
7590 .code
7591 ${lookup pgsql{select home,name from users where id='userx'}\
7592   {$value}}
7593 .endd
7594 might be
7595 .code
7596 home=/home/userx name="Mister X"
7597 .endd
7598 Empty values and values containing spaces are double quoted, with embedded
7599 quotes escaped by a backslash. If the result of the query contains just one
7600 field, the value is passed back verbatim, without a field name, for example:
7601 .code
7602 Mister X
7603 .endd
7604 If the result of the query yields more than one row, it is all concatenated,
7605 with a newline between the data for each row.
7606
7607
7608 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7609 .cindex "MySQL" "lookup type"
7610 .cindex "PostgreSQL lookup type"
7611 .cindex "lookup" "MySQL"
7612 .cindex "lookup" "PostgreSQL"
7613 .cindex "Oracle" "lookup type"
7614 .cindex "lookup" "Oracle"
7615 .cindex "InterBase lookup type"
7616 .cindex "lookup" "InterBase"
7617 .cindex "Redis lookup type"
7618 .cindex lookup Redis
7619 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7620 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7621 or &%redis_servers%&
7622 option (as appropriate) must be set to a colon-separated list of server
7623 information.
7624 (For MySQL and PostgreSQL, the global option need not be set if all
7625 queries contain their own server information &-- see section
7626 &<<SECTspeserque>>&.)
7627 For all but Redis
7628 each item in the list is a slash-separated list of four
7629 items: host name, database name, user name, and password. In the case of
7630 Oracle, the host name field is used for the &"service name"&, and the database
7631 name field is not used and should be empty. For example:
7632 .code
7633 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7634 .endd
7635 Because password data is sensitive, you should always precede the setting with
7636 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7637 option. Here is an example where two MySQL servers are listed:
7638 .code
7639 hide mysql_servers = localhost/users/root/secret:\
7640                      otherhost/users/root/othersecret
7641 .endd
7642 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7643 because this is a colon-separated list, the colon has to be doubled. For each
7644 query, these parameter groups are tried in order until a connection is made and
7645 a query is successfully processed. The result of a query may be that no data is
7646 found, but that is still a successful query. In other words, the list of
7647 servers provides a backup facility, not a list of different places to look.
7648
7649 For Redis the global option need not be specified if all queries contain their
7650 own server information &-- see section &<<SECTspeserque>>&.
7651 If specified, the option must be set to a colon-separated list of server
7652 information.
7653 Each item in the list is a slash-separated list of three items:
7654 host, database number, and password.
7655 .olist
7656 The host is required and may be either an IPv4 address and optional
7657 port number (separated by a colon, which needs doubling due to the
7658 higher-level list), or a Unix socket pathname enclosed in parentheses
7659 .next
7660 The database number is optional; if present that number is selected in the backend
7661 .next
7662 The password is optional; if present it is used to authenticate to the backend
7663 .endlist
7664
7665 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7666 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7667 respectively, and the characters single-quote, double-quote, and backslash
7668 itself are escaped with backslashes.
7669
7670 The &%quote_redis%& expansion operator
7671 escapes whitespace and backslash characters with a backslash.
7672
7673 .section "Specifying the server in the query" "SECTspeserque"
7674 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7675 it is possible to specify a list of servers with an individual query. This is
7676 done by starting the query with
7677 .display
7678 &`servers=`&&'server1:server2:server3:...'&&`;`&
7679 .endd
7680 Each item in the list may take one of two forms:
7681 .olist
7682 If it contains no slashes it is assumed to be just a host name. The appropriate
7683 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7684 of the same name, and the remaining parameters (database, user, password) are
7685 taken from there.
7686 .next
7687 If it contains any slashes, it is taken as a complete parameter set.
7688 .endlist
7689 The list of servers is used in exactly the same way as the global list.
7690 Once a connection to a server has happened and a query has been
7691 successfully executed, processing of the lookup ceases.
7692
7693 This feature is intended for use in master/slave situations where updates
7694 are occurring and you want to update the master rather than a slave. If the
7695 master is in the list as a backup for reading, you might have a global setting
7696 like this:
7697 .code
7698 mysql_servers = slave1/db/name/pw:\
7699                 slave2/db/name/pw:\
7700                 master/db/name/pw
7701 .endd
7702 In an updating lookup, you could then write:
7703 .code
7704 ${lookup mysql{servers=master; UPDATE ...} }
7705 .endd
7706 That query would then be sent only to the master server. If, on the other hand,
7707 the master is not to be used for reading, and so is not present in the global
7708 option, you can still update it by a query of this form:
7709 .code
7710 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7711 .endd
7712
7713
7714 .section "Special MySQL features" "SECID73"
7715 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7716 causes a connection to the server on the local host by means of a Unix domain
7717 socket. An alternate socket can be specified in parentheses.
7718 An option group name for MySQL option files can be specified in square brackets;
7719 the default value is &"exim"&.
7720 The full syntax of each item in &%mysql_servers%& is:
7721 .display
7722 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7723   <&'database'&>/<&'user'&>/<&'password'&>
7724 .endd
7725 Any of the four sub-parts of the first field can be omitted. For normal use on
7726 the local host it can be left blank or set to just &"localhost"&.
7727
7728 No database need be supplied &-- but if it is absent here, it must be given in
7729 the queries.
7730
7731 If a MySQL query is issued that does not request any data (an insert, update,
7732 or delete command), the result of the lookup is the number of rows affected.
7733
7734 &*Warning*&: This can be misleading. If an update does not actually change
7735 anything (for example, setting a field to the value it already has), the result
7736 is zero because no rows are affected.
7737
7738
7739 .section "Special PostgreSQL features" "SECID74"
7740 PostgreSQL lookups can also use Unix domain socket connections to the database.
7741 This is usually faster and costs less CPU time than a TCP/IP connection.
7742 However it can be used only if the mail server runs on the same machine as the
7743 database server. A configuration line for PostgreSQL via Unix domain sockets
7744 looks like this:
7745 .code
7746 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7747 .endd
7748 In other words, instead of supplying a host name, a path to the socket is
7749 given. The path name is enclosed in parentheses so that its slashes aren't
7750 visually confused with the delimiters for the other server parameters.
7751
7752 If a PostgreSQL query is issued that does not request any data (an insert,
7753 update, or delete command), the result of the lookup is the number of rows
7754 affected.
7755
7756 .section "More about SQLite" "SECTsqlite"
7757 .cindex "lookup" "SQLite"
7758 .cindex "sqlite lookup type"
7759 SQLite is different to the other SQL lookups because a file name is required in
7760 addition to the SQL query. An SQLite database is a single file, and there is no
7761 daemon as in the other SQL databases. The interface to Exim requires the name
7762 of the file, as an absolute path, to be given at the start of the query. It is
7763 separated from the query by white space. This means that the path name cannot
7764 contain white space. Here is a lookup expansion example:
7765 .code
7766 ${lookup sqlite {/some/thing/sqlitedb \
7767   select name from aliases where id='userx';}}
7768 .endd
7769 In a list, the syntax is similar. For example:
7770 .code
7771 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7772    select * from relays where ip='$sender_host_address';
7773 .endd
7774 The only character affected by the &%quote_sqlite%& operator is a single
7775 quote, which it doubles.
7776
7777 .cindex timeout SQLite
7778 .cindex sqlite "lookup timeout"
7779 The SQLite library handles multiple simultaneous accesses to the database
7780 internally. Multiple readers are permitted, but only one process can
7781 update at once. Attempts to access the database while it is being updated
7782 are rejected after a timeout period, during which the SQLite library
7783 waits for the lock to be released. In Exim, the default timeout is set
7784 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7785 option.
7786 .ecindex IIDfidalo1
7787 .ecindex IIDfidalo2
7788
7789
7790 . ////////////////////////////////////////////////////////////////////////////
7791 . ////////////////////////////////////////////////////////////////////////////
7792
7793 .chapter "Domain, host, address, and local part lists" &&&
7794          "CHAPdomhosaddlists" &&&
7795          "Domain, host, and address lists"
7796 .scindex IIDdohoadli "lists of domains; hosts; etc."
7797 A number of Exim configuration options contain lists of domains, hosts,
7798 email addresses, or local parts. For example, the &%hold_domains%& option
7799 contains a list of domains whose delivery is currently suspended. These lists
7800 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7801 arguments to expansion conditions such as &%match_domain%&.
7802
7803 Each item in one of these lists is a pattern to be matched against a domain,
7804 host, email address, or local part, respectively. In the sections below, the
7805 different types of pattern for each case are described, but first we cover some
7806 general facilities that apply to all four kinds of list.
7807
7808 Note that other parts of Exim use a &'string list'& which does not
7809 support all the complexity available in
7810 domain, host, address and local part lists.
7811
7812
7813
7814 .section "Expansion of lists" "SECTlistexpand"
7815 .cindex "expansion" "of lists"
7816 Each list is expanded as a single string before it is used.
7817
7818 .new
7819 &'Exception: the router headers_remove option, where list-item
7820 splitting is done before string-expansion.'&
7821 .wen
7822
7823 The result of
7824 expansion must be a list, possibly containing empty items, which is split up
7825 into separate items for matching. By default, colon is the separator character,
7826 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7827 &<<SECTempitelis>>& for details of the list syntax; the second of these
7828 discusses the way to specify empty list items.
7829
7830
7831 If the string expansion is forced to fail, Exim behaves as if the item it is
7832 testing (domain, host, address, or local part) is not in the list. Other
7833 expansion failures cause temporary errors.
7834
7835 If an item in a list is a regular expression, backslashes, dollars and possibly
7836 other special characters in the expression must be protected against
7837 misinterpretation by the string expander. The easiest way to do this is to use
7838 the &`\N`& expansion feature to indicate that the contents of the regular
7839 expression should not be expanded. For example, in an ACL you might have:
7840 .code
7841 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7842                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7843 .endd
7844 The first item is a regular expression that is protected from expansion by
7845 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7846 senders based on the receiving domain.
7847
7848
7849
7850
7851 .section "Negated items in lists" "SECID76"
7852 .cindex "list" "negation"
7853 .cindex "negation" "in lists"
7854 Items in a list may be positive or negative. Negative items are indicated by a
7855 leading exclamation mark, which may be followed by optional white space. A list
7856 defines a set of items (domains, etc). When Exim processes one of these lists,
7857 it is trying to find out whether a domain, host, address, or local part
7858 (respectively) is in the set that is defined by the list. It works like this:
7859
7860 The list is scanned from left to right. If a positive item is matched, the
7861 subject that is being checked is in the set; if a negative item is matched, the
7862 subject is not in the set. If the end of the list is reached without the
7863 subject having matched any of the patterns, it is in the set if the last item
7864 was a negative one, but not if it was a positive one. For example, the list in
7865 .code
7866 domainlist relay_to_domains = !a.b.c : *.b.c
7867 .endd
7868 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7869 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7870 list is positive. However, if the setting were
7871 .code
7872 domainlist relay_to_domains = !a.b.c
7873 .endd
7874 then all domains other than &'a.b.c'& would match because the last item in the
7875 list is negative. In other words, a list that ends with a negative item behaves
7876 as if it had an extra item &`:*`& on the end.
7877
7878 Another way of thinking about positive and negative items in lists is to read
7879 the connector as &"or"& after a positive item and as &"and"& after a negative
7880 item.
7881
7882
7883
7884 .section "File names in lists" "SECTfilnamlis"
7885 .cindex "list" "file name in"
7886 If an item in a domain, host, address, or local part list is an absolute file
7887 name (beginning with a slash character), each line of the file is read and
7888 processed as if it were an independent item in the list, except that further
7889 file names are not allowed,
7890 and no expansion of the data from the file takes place.
7891 Empty lines in the file are ignored, and the file may also contain comment
7892 lines:
7893
7894 .ilist
7895 For domain and host lists, if a # character appears anywhere in a line of the
7896 file, it and all following characters are ignored.
7897 .next
7898 Because local parts may legitimately contain # characters, a comment in an
7899 address list or local part list file is recognized only if # is preceded by
7900 white space or the start of the line. For example:
7901 .code
7902 not#comment@x.y.z   # but this is a comment
7903 .endd
7904 .endlist
7905
7906 Putting a file name in a list has the same effect as inserting each line of the
7907 file as an item in the list (blank lines and comments excepted). However, there
7908 is one important difference: the file is read each time the list is processed,
7909 so if its contents vary over time, Exim's behaviour changes.
7910
7911 If a file name is preceded by an exclamation mark, the sense of any match
7912 within the file is inverted. For example, if
7913 .code
7914 hold_domains = !/etc/nohold-domains
7915 .endd
7916 and the file contains the lines
7917 .code
7918 !a.b.c
7919 *.b.c
7920 .endd
7921 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7922 any domain matching &`*.b.c`& is not.
7923
7924
7925
7926 .section "An lsearch file is not an out-of-line list" "SECID77"
7927 As will be described in the sections that follow, lookups can be used in lists
7928 to provide indexed methods of checking list membership. There has been some
7929 confusion about the way &(lsearch)& lookups work in lists. Because
7930 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7931 sometimes thought that it is allowed to contain wild cards and other kinds of
7932 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7933 always fixed strings, just as for any other single-key lookup type.
7934
7935 If you want to use a file to contain wild-card patterns that form part of a
7936 list, just give the file name on its own, without a search type, as described
7937 in the previous section. You could also use the &(wildlsearch)& or
7938 &(nwildlsearch)&, but there is no advantage in doing this.
7939
7940
7941
7942
7943 .section "Named lists" "SECTnamedlists"
7944 .cindex "named lists"
7945 .cindex "list" "named"
7946 A list of domains, hosts, email addresses, or local parts can be given a name
7947 which is then used to refer to the list elsewhere in the configuration. This is
7948 particularly convenient if the same list is required in several different
7949 places. It also allows lists to be given meaningful names, which can improve
7950 the readability of the configuration. For example, it is conventional to define
7951 a domain list called &'local_domains'& for all the domains that are handled
7952 locally on a host, using a configuration line such as
7953 .code
7954 domainlist local_domains = localhost:my.dom.example
7955 .endd
7956 Named lists are referenced by giving their name preceded by a plus sign, so,
7957 for example, a router that is intended to handle local domains would be
7958 configured with the line
7959 .code
7960 domains = +local_domains
7961 .endd
7962 The first router in a configuration is often one that handles all domains
7963 except the local ones, using a configuration with a negated item like this:
7964 .code
7965 dnslookup:
7966   driver = dnslookup
7967   domains = ! +local_domains
7968   transport = remote_smtp
7969   no_more
7970 .endd
7971 The four kinds of named list are created by configuration lines starting with
7972 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7973 respectively. Then there follows the name that you are defining, followed by an
7974 equals sign and the list itself. For example:
7975 .code
7976 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7977 addresslist bad_senders = cdb;/etc/badsenders
7978 .endd
7979 A named list may refer to other named lists:
7980 .code
7981 domainlist  dom1 = first.example : second.example
7982 domainlist  dom2 = +dom1 : third.example
7983 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7984 .endd
7985 &*Warning*&: If the last item in a referenced list is a negative one, the
7986 effect may not be what you intended, because the negation does not propagate
7987 out to the higher level. For example, consider:
7988 .code
7989 domainlist  dom1 = !a.b
7990 domainlist  dom2 = +dom1 : *.b
7991 .endd
7992 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7993 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7994 means it matches the second list as well. The effect is not the same as
7995 .code
7996 domainlist  dom2 = !a.b : *.b
7997 .endd
7998 where &'x.y'& does not match. It's best to avoid negation altogether in
7999 referenced lists if you can.
8000
8001 Named lists may have a performance advantage. When Exim is routing an
8002 address or checking an incoming message, it caches the result of tests on named
8003 lists. So, if you have a setting such as
8004 .code
8005 domains = +local_domains
8006 .endd
8007 on several of your routers
8008 or in several ACL statements,
8009 the actual test is done only for the first one. However, the caching works only
8010 if there are no expansions within the list itself or any sublists that it
8011 references. In other words, caching happens only for lists that are known to be
8012 the same each time they are referenced.
8013
8014 By default, there may be up to 16 named lists of each type. This limit can be
8015 extended by changing a compile-time variable. The use of domain and host lists
8016 is recommended for concepts such as local domains, relay domains, and relay
8017 hosts. The default configuration is set up like this.
8018
8019
8020
8021 .section "Named lists compared with macros" "SECID78"
8022 .cindex "list" "named compared with macro"
8023 .cindex "macro" "compared with named list"
8024 At first sight, named lists might seem to be no different from macros in the
8025 configuration file. However, macros are just textual substitutions. If you
8026 write
8027 .code
8028 ALIST = host1 : host2
8029 auth_advertise_hosts = !ALIST
8030 .endd
8031 it probably won't do what you want, because that is exactly the same as
8032 .code
8033 auth_advertise_hosts = !host1 : host2
8034 .endd
8035 Notice that the second host name is not negated. However, if you use a host
8036 list, and write
8037 .code
8038 hostlist alist = host1 : host2
8039 auth_advertise_hosts = ! +alist
8040 .endd
8041 the negation applies to the whole list, and so that is equivalent to
8042 .code
8043 auth_advertise_hosts = !host1 : !host2
8044 .endd
8045
8046
8047 .section "Named list caching" "SECID79"
8048 .cindex "list" "caching of named"
8049 .cindex "caching" "named lists"
8050 While processing a message, Exim caches the result of checking a named list if
8051 it is sure that the list is the same each time. In practice, this means that
8052 the cache operates only if the list contains no $ characters, which guarantees
8053 that it will not change when it is expanded. Sometimes, however, you may have
8054 an expanded list that you know will be the same each time within a given
8055 message. For example:
8056 .code
8057 domainlist special_domains = \
8058            ${lookup{$sender_host_address}cdb{/some/file}}
8059 .endd
8060 This provides a list of domains that depends only on the sending host's IP
8061 address. If this domain list is referenced a number of times (for example,
8062 in several ACL lines, or in several routers) the result of the check is not
8063 cached by default, because Exim does not know that it is going to be the
8064 same list each time.
8065
8066 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8067 cache the result anyway. For example:
8068 .code
8069 domainlist_cache special_domains = ${lookup{...
8070 .endd
8071 If you do this, you should be absolutely sure that caching is going to do
8072 the right thing in all cases. When in doubt, leave it out.
8073
8074
8075
8076 .section "Domain lists" "SECTdomainlist"
8077 .cindex "domain list" "patterns for"
8078 .cindex "list" "domain list"
8079 Domain lists contain patterns that are to be matched against a mail domain.
8080 The following types of item may appear in domain lists:
8081
8082 .ilist
8083 .cindex "primary host name"
8084 .cindex "host name" "matched in domain list"
8085 .oindex "&%primary_hostname%&"
8086 .cindex "domain list" "matching primary host name"
8087 .cindex "@ in a domain list"
8088 If a pattern consists of a single @ character, it matches the local host name,
8089 as set by the &%primary_hostname%& option (or defaulted). This makes it
8090 possible to use the same configuration file on several different hosts that
8091 differ only in their names.
8092 .next
8093 .cindex "@[] in a domain list"
8094 .cindex "domain list" "matching local IP interfaces"
8095 .cindex "domain literal"
8096 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8097 in square brackets (as in an email address that contains a domain literal), but
8098 only if that IP address is recognized as local for email routing purposes. The
8099 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8100 control which of a host's several IP addresses are treated as local.
8101 In today's Internet, the use of domain literals is controversial.
8102 .next
8103 .cindex "@mx_any"
8104 .cindex "@mx_primary"
8105 .cindex "@mx_secondary"
8106 .cindex "domain list" "matching MX pointers to local host"
8107 If a pattern consists of the string &`@mx_any`& it matches any domain that
8108 has an MX record pointing to the local host or to any host that is listed in
8109 .oindex "&%hosts_treat_as_local%&"
8110 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8111 are similar, except that the first matches only when a primary MX target is the
8112 local host, and the second only when no primary MX target is the local host,
8113 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8114 preference value &-- there may of course be more than one of them.
8115
8116 The MX lookup that takes place when matching a pattern of this type is
8117 performed with the resolver options for widening names turned off. Thus, for
8118 example, a single-component domain will &'not'& be expanded by adding the
8119 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8120 options of the &(dnslookup)& router for a discussion of domain widening.
8121
8122 Sometimes you may want to ignore certain IP addresses when using one of these
8123 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8124 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8125 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8126 on a router). For example:
8127 .code
8128 domains = @mx_any/ignore=127.0.0.1
8129 .endd
8130 This example matches any domain that has an MX record pointing to one of
8131 the local host's IP addresses other than 127.0.0.1.
8132
8133 The list of IP addresses is in fact processed by the same code that processes
8134 host lists, so it may contain CIDR-coded network specifications and it may also
8135 contain negative items.
8136
8137 Because the list of IP addresses is a sublist within a domain list, you have to
8138 be careful about delimiters if there is more than one address. Like any other
8139 list, the default delimiter can be changed. Thus, you might have:
8140 .code
8141 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8142           an.other.domain : ...
8143 .endd
8144 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8145 involved, it is easiest to change the delimiter for the main list as well:
8146 .code
8147 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8148           an.other.domain ? ...
8149 .endd
8150 .next
8151 .cindex "asterisk" "in domain list"
8152 .cindex "domain list" "asterisk in"
8153 .cindex "domain list" "matching &""ends with""&"
8154 If a pattern starts with an asterisk, the remaining characters of the pattern
8155 are compared with the terminating characters of the domain. The use of &"*"& in
8156 domain lists differs from its use in partial matching lookups. In a domain
8157 list, the character following the asterisk need not be a dot, whereas partial
8158 matching works only in terms of dot-separated components. For example, a domain
8159 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8160 &'cipher.key.ex'&.
8161
8162 .next
8163 .cindex "regular expressions" "in domain list"
8164 .cindex "domain list" "matching regular expression"
8165 If a pattern starts with a circumflex character, it is treated as a regular
8166 expression, and matched against the domain using a regular expression matching
8167 function. The circumflex is treated as part of the regular expression.
8168 Email domains are case-independent, so this regular expression match is by
8169 default case-independent, but you can make it case-dependent by starting it
8170 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8171 are given in chapter &<<CHAPregexp>>&.
8172
8173 &*Warning*&: Because domain lists are expanded before being processed, you
8174 must escape any backslash and dollar characters in the regular expression, or
8175 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8176 it is not to be expanded (unless you really do want to build a regular
8177 expression by expansion, of course).
8178 .next
8179 .cindex "lookup" "in domain list"
8180 .cindex "domain list" "matching by lookup"
8181 If a pattern starts with the name of a single-key lookup type followed by a
8182 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8183 must be a file name in a suitable format for the lookup type. For example, for
8184 &"cdb;"& it must be an absolute path:
8185 .code
8186 domains = cdb;/etc/mail/local_domains.cdb
8187 .endd
8188 The appropriate type of lookup is done on the file using the domain name as the
8189 key. In most cases, the data that is looked up is not used; Exim is interested
8190 only in whether or not the key is present in the file. However, when a lookup
8191 is used for the &%domains%& option on a router
8192 or a &%domains%& condition in an ACL statement, the data is preserved in the
8193 &$domain_data$& variable and can be referred to in other router options or
8194 other statements in the same ACL.
8195
8196 .next
8197 Any of the single-key lookup type names may be preceded by
8198 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8199 .code
8200 domains = partial-dbm;/partial/domains
8201 .endd
8202 This causes partial matching logic to be invoked; a description of how this
8203 works is given in section &<<SECTpartiallookup>>&.
8204
8205 .next
8206 .cindex "asterisk" "in lookup type"
8207 Any of the single-key lookup types may be followed by an asterisk. This causes
8208 a default lookup for a key consisting of a single asterisk to be done if the
8209 original lookup fails. This is not a useful feature when using a domain list to
8210 select particular domains (because any domain would match), but it might have
8211 value if the result of the lookup is being used via the &$domain_data$&
8212 expansion variable.
8213 .next
8214 If the pattern starts with the name of a query-style lookup type followed by a
8215 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8216 pattern must be an appropriate query for the lookup type, as described in
8217 chapter &<<CHAPfdlookup>>&. For example:
8218 .code
8219 hold_domains = mysql;select domain from holdlist \
8220   where domain = '${quote_mysql:$domain}';
8221 .endd
8222 In most cases, the data that is looked up is not used (so for an SQL query, for
8223 example, it doesn't matter what field you select). Exim is interested only in
8224 whether or not the query succeeds. However, when a lookup is used for the
8225 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8226 variable and can be referred to in other options.
8227 .next
8228 .cindex "domain list" "matching literal domain name"
8229 If none of the above cases apply, a caseless textual comparison is made
8230 between the pattern and the domain.
8231 .endlist
8232
8233 Here is an example that uses several different kinds of pattern:
8234 .code
8235 domainlist funny_domains = \
8236   @ : \
8237   lib.unseen.edu : \
8238   *.foundation.fict.example : \
8239   \N^[1-2]\d{3}\.fict\.example$\N : \
8240   partial-dbm;/opt/data/penguin/book : \
8241   nis;domains.byname : \
8242   nisplus;[name=$domain,status=local],domains.org_dir
8243 .endd
8244 There are obvious processing trade-offs among the various matching modes. Using
8245 an asterisk is faster than a regular expression, and listing a few names
8246 explicitly probably is too. The use of a file or database lookup is expensive,
8247 but may be the only option if hundreds of names are required. Because the
8248 patterns are tested in order, it makes sense to put the most commonly matched
8249 patterns earlier.
8250
8251
8252
8253 .section "Host lists" "SECThostlist"
8254 .cindex "host list" "patterns in"
8255 .cindex "list" "host list"
8256 Host lists are used to control what remote hosts are allowed to do. For
8257 example, some hosts may be allowed to use the local host as a relay, and some
8258 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8259 two different ways, by name or by IP address. In a host list, some types of
8260 pattern are matched to a host name, and some are matched to an IP address.
8261 You need to be particularly careful with this when single-key lookups are
8262 involved, to ensure that the right value is being used as the key.
8263
8264
8265 .section "Special host list patterns" "SECID80"
8266 .cindex "empty item in hosts list"
8267 .cindex "host list" "empty string in"
8268 If a host list item is the empty string, it matches only when no remote host is
8269 involved. This is the case when a message is being received from a local
8270 process using SMTP on the standard input, that is, when a TCP/IP connection is
8271 not used.
8272
8273 .cindex "asterisk" "in host list"
8274 The special pattern &"*"& in a host list matches any host or no host. Neither
8275 the IP address nor the name is actually inspected.
8276
8277
8278
8279 .section "Host list patterns that match by IP address" "SECThoslispatip"
8280 .cindex "host list" "matching IP addresses"
8281 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8282 the incoming address actually appears in the IPv6 host as
8283 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8284 list, it is converted into a traditional IPv4 address first. (Not all operating
8285 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8286 concerns.)
8287
8288 The following types of pattern in a host list check the remote host by
8289 inspecting its IP address:
8290
8291 .ilist
8292 If the pattern is a plain domain name (not a regular expression, not starting
8293 with *, not a lookup of any kind), Exim calls the operating system function
8294 to find the associated IP address(es). Exim uses the newer
8295 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8296 This typically causes a forward DNS lookup of the name. The result is compared
8297 with the IP address of the subject host.
8298
8299 If there is a temporary problem (such as a DNS timeout) with the host name
8300 lookup, a temporary error occurs. For example, if the list is being used in an
8301 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8302 temporary SMTP error code. If no IP address can be found for the host name,
8303 what happens is described in section &<<SECTbehipnot>>& below.
8304
8305 .next
8306 .cindex "@ in a host list"
8307 If the pattern is &"@"&, the primary host name is substituted and used as a
8308 domain name, as just described.
8309
8310 .next
8311 If the pattern is an IP address, it is matched against the IP address of the
8312 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8313 IPv6 addresses can be given in colon-separated format, but the colons have to
8314 be doubled so as not to be taken as item separators when the default list
8315 separator is used. IPv6 addresses are recognized even when Exim is compiled
8316 without IPv6 support. This means that if they appear in a host list on an
8317 IPv4-only host, Exim will not treat them as host names. They are just addresses
8318 that can never match a client host.
8319
8320 .next
8321 .cindex "@[] in a host list"
8322 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8323 the local host. For example, if the local host is an IPv4 host with one
8324 interface address 10.45.23.56, these two ACL statements have the same effect:
8325 .code
8326 accept hosts = 127.0.0.1 : 10.45.23.56
8327 accept hosts = @[]
8328 .endd
8329 .next
8330 .cindex "CIDR notation"
8331 If the pattern is an IP address followed by a slash and a mask length (for
8332 example 10.11.42.0/24), it is matched against the IP address of the subject
8333 host under the given mask. This allows, an entire network of hosts to be
8334 included (or excluded) by a single item. The mask uses CIDR notation; it
8335 specifies the number of address bits that must match, starting from the most
8336 significant end of the address.
8337
8338 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8339 of a range of addresses. It is the number of bits in the network portion of the
8340 address. The above example specifies a 24-bit netmask, so it matches all 256
8341 addresses in the 10.11.42.0 network. An item such as
8342 .code
8343 192.168.23.236/31
8344 .endd
8345 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8346 32 for an IPv4 address is the same as no mask at all; just a single address
8347 matches.
8348
8349 Here is another example which shows an IPv4 and an IPv6 network:
8350 .code
8351 recipient_unqualified_hosts = 192.168.0.0/16: \
8352                               3ffe::ffff::836f::::/48
8353 .endd
8354 The doubling of list separator characters applies only when these items
8355 appear inline in a host list. It is not required when indirecting via a file.
8356 For example:
8357 .code
8358 recipient_unqualified_hosts = /opt/exim/unqualnets
8359 .endd
8360 could make use of a file containing
8361 .code
8362 172.16.0.0/12
8363 3ffe:ffff:836f::/48
8364 .endd
8365 to have exactly the same effect as the previous example. When listing IPv6
8366 addresses inline, it is usually more convenient to use the facility for
8367 changing separator characters. This list contains the same two networks:
8368 .code
8369 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8370                                  3ffe:ffff:836f::/48
8371 .endd
8372 The separator is changed to semicolon by the leading &"<;"& at the start of the
8373 list.
8374 .endlist
8375
8376
8377
8378 .section "Host list patterns for single-key lookups by host address" &&&
8379          "SECThoslispatsikey"
8380 .cindex "host list" "lookup of IP address"
8381 When a host is to be identified by a single-key lookup of its complete IP
8382 address, the pattern takes this form:
8383 .display
8384 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8385 .endd
8386 For example:
8387 .code
8388 hosts_lookup = net-cdb;/hosts-by-ip.db
8389 .endd
8390 The text form of the IP address of the subject host is used as the lookup key.
8391 IPv6 addresses are converted to an unabbreviated form, using lower case
8392 letters, with dots as separators because colon is the key terminator in
8393 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8394 quoting the keys, but this is a facility that was added later.] The data
8395 returned by the lookup is not used.
8396
8397 .cindex "IP address" "masking"
8398 .cindex "host list" "masked IP address"
8399 Single-key lookups can also be performed using masked IP addresses, using
8400 patterns of this form:
8401 .display
8402 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8403 .endd
8404 For example:
8405 .code
8406 net24-dbm;/networks.db
8407 .endd
8408 The IP address of the subject host is masked using <&'number'&> as the mask
8409 length. A textual string is constructed from the masked value, followed by the
8410 mask, and this is used as the lookup key. For example, if the host's IP address
8411 is 192.168.34.6, the key that is looked up for the above example is
8412 &"192.168.34.0/24"&.
8413
8414 When an IPv6 address is converted to a string, dots are normally used instead
8415 of colons, so that keys in &(lsearch)& files need not contain colons (which
8416 terminate &(lsearch)& keys). This was implemented some time before the ability
8417 to quote keys was made available in &(lsearch)& files. However, the more
8418 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8419 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8420 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8421 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8422 addresses are always used.
8423
8424 Ideally, it would be nice to tidy up this anomalous situation by changing to
8425 colons in all cases, given that quoting is now available for &(lsearch)&.
8426 However, this would be an incompatible change that might break some existing
8427 configurations.
8428
8429 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8430 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8431 the former case the key strings include the mask value, whereas in the latter
8432 case the IP address is used on its own.
8433
8434
8435
8436 .section "Host list patterns that match by host name" "SECThoslispatnam"
8437 .cindex "host" "lookup failures"
8438 .cindex "unknown host name"
8439 .cindex "host list" "matching host name"
8440 There are several types of pattern that require Exim to know the name of the
8441 remote host. These are either wildcard patterns or lookups by name. (If a
8442 complete hostname is given without any wildcarding, it is used to find an IP
8443 address to match against, as described in section &<<SECThoslispatip>>&
8444 above.)
8445
8446 If the remote host name is not already known when Exim encounters one of these
8447 patterns, it has to be found from the IP address.
8448 Although many sites on the Internet are conscientious about maintaining reverse
8449 DNS data for their hosts, there are also many that do not do this.
8450 Consequently, a name cannot always be found, and this may lead to unwanted
8451 effects. Take care when configuring host lists with wildcarded name patterns.
8452 Consider what will happen if a name cannot be found.
8453
8454 Because of the problems of determining host names from IP addresses, matching
8455 against host names is not as common as matching against IP addresses.
8456
8457 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8458 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8459 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8460 are done can be changed by setting the &%host_lookup_order%& option. For
8461 security, once Exim has found one or more names, it looks up the IP addresses
8462 for these names and compares them with the IP address that it started with.
8463 Only those names whose IP addresses match are accepted. Any other names are
8464 discarded. If no names are left, Exim behaves as if the host name cannot be
8465 found. In the most common case there is only one name and one IP address.
8466
8467 There are some options that control what happens if a host name cannot be
8468 found. These are described in section &<<SECTbehipnot>>& below.
8469
8470 .cindex "host" "alias for"
8471 .cindex "alias for host"
8472 As a result of aliasing, hosts may have more than one name. When processing any
8473 of the following types of pattern, all the host's names are checked:
8474
8475 .ilist
8476 .cindex "asterisk" "in host list"
8477 If a pattern starts with &"*"& the remainder of the item must match the end of
8478 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8479 &'.b.c'&. This special simple form is provided because this is a very common
8480 requirement. Other kinds of wildcarding require the use of a regular
8481 expression.
8482 .next
8483 .cindex "regular expressions" "in host list"
8484 .cindex "host list" "regular expression in"
8485 If the item starts with &"^"& it is taken to be a regular expression which is
8486 matched against the host name. Host names are case-independent, so this regular
8487 expression match is by default case-independent, but you can make it
8488 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8489 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8490 example,
8491 .code
8492 ^(a|b)\.c\.d$
8493 .endd
8494 is a regular expression that matches either of the two hosts &'a.c.d'& or
8495 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8496 that backslash and dollar characters are not misinterpreted as part of the
8497 string expansion. The simplest way to do this is to use &`\N`& to mark that
8498 part of the string as non-expandable. For example:
8499 .code
8500 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8501 .endd
8502 &*Warning*&: If you want to match a complete host name, you must include the
8503 &`$`& terminating metacharacter in the regular expression, as in the above
8504 example. Without it, a match at the start of the host name is all that is
8505 required.
8506 .endlist
8507
8508
8509
8510
8511 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8512 .cindex "host" "lookup failures, permanent"
8513 While processing a host list, Exim may need to look up an IP address from a
8514 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8515 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8516 behaviour when it fails to find the information it is seeking is the same.
8517
8518 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8519 apply to temporary DNS errors, whose handling is described in the next section.
8520
8521 .cindex "&`+include_unknown`&"
8522 .cindex "&`+ignore_unknown`&"
8523 Exim parses a host list from left to right. If it encounters a permanent
8524 lookup failure in any item in the host list before it has found a match,
8525 Exim treats it as a failure and the default behavior is as if the host
8526 does not match the list. This may not always be what you want to happen.
8527 To change Exim's behaviour, the special items &`+include_unknown`& or
8528 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8529 not recognized in an indirected file).
8530
8531 .ilist
8532 If any item that follows &`+include_unknown`& requires information that
8533 cannot found, Exim behaves as if the host does match the list. For example,
8534 .code
8535 host_reject_connection = +include_unknown:*.enemy.ex
8536 .endd
8537 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8538 any hosts whose name it cannot find.
8539
8540 .next
8541 If any item that follows &`+ignore_unknown`& requires information that cannot
8542 be found, Exim ignores that item and proceeds to the rest of the list. For
8543 example:
8544 .code
8545 accept hosts = +ignore_unknown : friend.example : \
8546                192.168.4.5
8547 .endd
8548 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8549 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8550 name can be found for 192.168.4.5, it is rejected.
8551 .endlist
8552
8553 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8554 list. The effect of each one lasts until the next, or until the end of the
8555 list.
8556
8557 .section "Mixing wildcarded host names and addresses in host lists" &&&
8558          "SECTmixwilhos"
8559 .cindex "host list" "mixing names and addresses in"
8560
8561 This section explains the host/ip processing logic with the same concepts
8562 as the previous section, but specifically addresses what happens when a
8563 wildcarded hostname is one of the items in the hostlist.
8564
8565 .ilist
8566 If you have name lookups or wildcarded host names and
8567 IP addresses in the same host list, you should normally put the IP
8568 addresses first. For example, in an ACL you could have:
8569 .code
8570 accept hosts = 10.9.8.7 : *.friend.example
8571 .endd
8572 The reason you normally would order it this way lies in the
8573 left-to-right way that Exim processes lists.  It can test IP addresses
8574 without doing any DNS lookups, but when it reaches an item that requires
8575 a host name, it fails if it cannot find a host name to compare with the
8576 pattern. If the above list is given in the opposite order, the
8577 &%accept%& statement fails for a host whose name cannot be found, even
8578 if its IP address is 10.9.8.7.
8579
8580 .next
8581 If you really do want to do the name check first, and still recognize the IP
8582 address, you can rewrite the ACL like this:
8583 .code
8584 accept hosts = *.friend.example
8585 accept hosts = 10.9.8.7
8586 .endd
8587 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8588 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8589 &`+ignore_unknown`&, which was discussed in depth in the first example in
8590 this section.
8591 .endlist
8592
8593
8594 .section "Temporary DNS errors when looking up host information" &&&
8595          "SECTtemdnserr"
8596 .cindex "host" "lookup failures, temporary"
8597 .cindex "&`+include_defer`&"
8598 .cindex "&`+ignore_defer`&"
8599 A temporary DNS lookup failure normally causes a defer action (except when
8600 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8601 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8602 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8603 section. These options should be used with care, probably only in non-critical
8604 host lists such as whitelists.
8605
8606
8607
8608 .section "Host list patterns for single-key lookups by host name" &&&
8609          "SECThoslispatnamsk"
8610 .cindex "unknown host name"
8611 .cindex "host list" "matching host name"
8612 If a pattern is of the form
8613 .display
8614 <&'single-key-search-type'&>;<&'search-data'&>
8615 .endd
8616 for example
8617 .code
8618 dbm;/host/accept/list
8619 .endd
8620 a single-key lookup is performed, using the host name as its key. If the
8621 lookup succeeds, the host matches the item. The actual data that is looked up
8622 is not used.
8623
8624 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8625 keys in the file, not IP addresses. If you want to do lookups based on IP
8626 addresses, you must precede the search type with &"net-"& (see section
8627 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8628 two items in the same list, one doing an address lookup and one doing a name
8629 lookup, both using the same file.
8630
8631
8632
8633 .section "Host list patterns for query-style lookups" "SECID81"
8634 If a pattern is of the form
8635 .display
8636 <&'query-style-search-type'&>;<&'query'&>
8637 .endd
8638 the query is obeyed, and if it succeeds, the host matches the item. The actual
8639 data that is looked up is not used. The variables &$sender_host_address$& and
8640 &$sender_host_name$& can be used in the query. For example:
8641 .code
8642 hosts_lookup = pgsql;\
8643   select ip from hostlist where ip='$sender_host_address'
8644 .endd
8645 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8646 can use the &%sg%& expansion item to change this if you need to. If you want to
8647 use masked IP addresses in database queries, you can use the &%mask%& expansion
8648 operator.
8649
8650 If the query contains a reference to &$sender_host_name$&, Exim automatically
8651 looks up the host name if it has not already done so. (See section
8652 &<<SECThoslispatnam>>& for comments on finding host names.)
8653
8654 Historical note: prior to release 4.30, Exim would always attempt to find a
8655 host name before running the query, unless the search type was preceded by
8656 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8657 still recognized for query-style lookups, but its presence or absence has no
8658 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8659 See section &<<SECThoslispatsikey>>&.)
8660
8661
8662
8663
8664
8665 .section "Address lists" "SECTaddresslist"
8666 .cindex "list" "address list"
8667 .cindex "address list" "empty item"
8668 .cindex "address list" "patterns"
8669 Address lists contain patterns that are matched against mail addresses. There
8670 is one special case to be considered: the sender address of a bounce message is
8671 always empty. You can test for this by providing an empty item in an address
8672 list. For example, you can set up a router to process bounce messages by
8673 using this option setting:
8674 .code
8675 senders = :
8676 .endd
8677 The presence of the colon creates an empty item. If you do not provide any
8678 data, the list is empty and matches nothing. The empty sender can also be
8679 detected by a regular expression that matches an empty string,
8680 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8681
8682 Non-empty items in an address list can be straightforward email addresses. For
8683 example:
8684 .code
8685 senders = jbc@askone.example : hs@anacreon.example
8686 .endd
8687 A certain amount of wildcarding is permitted. If a pattern contains an @
8688 character, but is not a regular expression and does not begin with a
8689 semicolon-terminated lookup type (described below), the local part of the
8690 subject address is compared with the local part of the pattern, which may start
8691 with an asterisk. If the local parts match, the domain is checked in exactly
8692 the same way as for a pattern in a domain list. For example, the domain can be
8693 wildcarded, refer to a named list, or be a lookup:
8694 .code
8695 deny senders = *@*.spamming.site:\
8696                *@+hostile_domains:\
8697                bozo@partial-lsearch;/list/of/dodgy/sites:\
8698                *@dbm;/bad/domains.db
8699 .endd
8700 .cindex "local part" "starting with !"
8701 .cindex "address list" "local part starting with !"
8702 If a local part that begins with an exclamation mark is required, it has to be
8703 specified using a regular expression, because otherwise the exclamation mark is
8704 treated as a sign of negation, as is standard in lists.
8705
8706 If a non-empty pattern that is not a regular expression or a lookup does not
8707 contain an @ character, it is matched against the domain part of the subject
8708 address. The only two formats that are recognized this way are a literal
8709 domain, or a domain pattern that starts with *. In both these cases, the effect
8710 is the same as if &`*@`& preceded the pattern. For example:
8711 .code
8712 deny senders = enemy.domain : *.enemy.domain
8713 .endd
8714
8715 The following kinds of more complicated address list pattern can match any
8716 address, including the empty address that is characteristic of bounce message
8717 senders:
8718
8719 .ilist
8720 .cindex "regular expressions" "in address list"
8721 .cindex "address list" "regular expression in"
8722 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8723 done against the complete address, with the pattern as the regular expression.
8724 You must take care that backslash and dollar characters are not misinterpreted
8725 as part of the string expansion. The simplest way to do this is to use &`\N`&
8726 to mark that part of the string as non-expandable. For example:
8727 .code
8728 deny senders = \N^.*this.*@example\.com$\N : \
8729                \N^\d{8}.+@spamhaus.example$\N : ...
8730 .endd
8731 The &`\N`& sequences are removed by the expansion, so these items do indeed
8732 start with &"^"& by the time they are being interpreted as address patterns.
8733
8734 .next
8735 .cindex "address list" "lookup for complete address"
8736 Complete addresses can be looked up by using a pattern that starts with a
8737 lookup type terminated by a semicolon, followed by the data for the lookup. For
8738 example:
8739 .code
8740 deny senders = cdb;/etc/blocked.senders : \
8741   mysql;select address from blocked where \
8742   address='${quote_mysql:$sender_address}'
8743 .endd
8744 Both query-style and single-key lookup types can be used. For a single-key
8745 lookup type, Exim uses the complete address as the key. However, empty keys are
8746 not supported for single-key lookups, so a match against the empty address
8747 always fails. This restriction does not apply to query-style lookups.
8748
8749 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8750 cannot be used, and is ignored if specified, with an entry being written to the
8751 panic log.
8752 .cindex "*@ with single-key lookup"
8753 However, you can configure lookup defaults, as described in section
8754 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8755 default. For example, with this lookup:
8756 .code
8757 accept senders = lsearch*@;/some/file
8758 .endd
8759 the file could contains lines like this:
8760 .code
8761 user1@domain1.example
8762 *@domain2.example
8763 .endd
8764 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8765 that are tried is:
8766 .code
8767 nimrod@jaeger.example
8768 *@jaeger.example
8769 *
8770 .endd
8771 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8772 would mean that every address matches, thus rendering the test useless.
8773
8774 &*Warning 2*&: Do not confuse these two kinds of item:
8775 .code
8776 deny recipients = dbm*@;/some/file
8777 deny recipients = *@dbm;/some/file
8778 .endd
8779 The first does a whole address lookup, with defaulting, as just described,
8780 because it starts with a lookup type. The second matches the local part and
8781 domain independently, as described in a bullet point below.
8782 .endlist
8783
8784
8785 The following kinds of address list pattern can match only non-empty addresses.
8786 If the subject address is empty, a match against any of these pattern types
8787 always fails.
8788
8789
8790 .ilist
8791 .cindex "@@ with single-key lookup"
8792 .cindex "address list" "@@ lookup type"
8793 .cindex "address list" "split local part and domain"
8794 If a pattern starts with &"@@"& followed by a single-key lookup item
8795 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8796 split into a local part and a domain. The domain is looked up in the file. If
8797 it is not found, there is no match. If it is found, the data that is looked up
8798 from the file is treated as a colon-separated list of local part patterns, each
8799 of which is matched against the subject local part in turn.
8800
8801 .cindex "asterisk" "in address list"
8802 The lookup may be a partial one, and/or one involving a search for a default
8803 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8804 patterns that are looked up can be regular expressions or begin with &"*"&, or
8805 even be further lookups. They may also be independently negated. For example,
8806 with
8807 .code
8808 deny senders = @@dbm;/etc/reject-by-domain
8809 .endd
8810 the data from which the DBM file is built could contain lines like
8811 .code
8812 baddomain.com:  !postmaster : *
8813 .endd
8814 to reject all senders except &%postmaster%& from that domain.
8815
8816 .cindex "local part" "starting with !"
8817 If a local part that actually begins with an exclamation mark is required, it
8818 has to be specified using a regular expression. In &(lsearch)& files, an entry
8819 may be split over several lines by indenting the second and subsequent lines,
8820 but the separating colon must still be included at line breaks. White space
8821 surrounding the colons is ignored. For example:
8822 .code
8823 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8824   spammer3 : spammer4
8825 .endd
8826 As in all colon-separated lists in Exim, a colon can be included in an item by
8827 doubling.
8828
8829 If the last item in the list starts with a right angle-bracket, the remainder
8830 of the item is taken as a new key to look up in order to obtain a continuation
8831 list of local parts. The new key can be any sequence of characters. Thus one
8832 might have entries like
8833 .code
8834 aol.com: spammer1 : spammer 2 : >*
8835 xyz.com: spammer3 : >*
8836 *:       ^\d{8}$
8837 .endd
8838 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8839 local parts for all domains, in addition to the specific local parts listed for
8840 each domain. Of course, using this feature costs another lookup each time a
8841 chain is followed, but the effort needed to maintain the data is reduced.
8842
8843 .cindex "loop" "in lookups"
8844 It is possible to construct loops using this facility, and in order to catch
8845 them, the chains may be no more than fifty items long.
8846
8847 .next
8848 The @@<&'lookup'&> style of item can also be used with a query-style
8849 lookup, but in this case, the chaining facility is not available. The lookup
8850 can only return a single list of local parts.
8851 .endlist
8852
8853 &*Warning*&: There is an important difference between the address list items
8854 in these two examples:
8855 .code
8856 senders = +my_list
8857 senders = *@+my_list
8858 .endd
8859 In the first one, &`my_list`& is a named address list, whereas in the second
8860 example it is a named domain list.
8861
8862
8863
8864
8865 .section "Case of letters in address lists" "SECTcasletadd"
8866 .cindex "case of local parts"
8867 .cindex "address list" "case forcing"
8868 .cindex "case forcing in address lists"
8869 Domains in email addresses are always handled caselessly, but for local parts
8870 case may be significant on some systems (see &%caseful_local_part%& for how
8871 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8872 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8873 blocking lists should be done in a case-independent manner. Since most address
8874 lists in Exim are used for this kind of control, Exim attempts to do this by
8875 default.
8876
8877 The domain portion of an address is always lowercased before matching it to an
8878 address list. The local part is lowercased by default, and any string
8879 comparisons that take place are done caselessly. This means that the data in
8880 the address list itself, in files included as plain file names, and in any file
8881 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8882 keys in files that are looked up by a search type other than &(lsearch)& (which
8883 works caselessly) must be in lower case, because these lookups are not
8884 case-independent.
8885
8886 .cindex "&`+caseful`&"
8887 To allow for the possibility of caseful address list matching, if an item in
8888 an address list is the string &"+caseful"&, the original case of the local
8889 part is restored for any comparisons that follow, and string comparisons are no
8890 longer case-independent. This does not affect the domain, which remains in
8891 lower case. However, although independent matches on the domain alone are still
8892 performed caselessly, regular expressions that match against an entire address
8893 become case-sensitive after &"+caseful"& has been seen.
8894
8895
8896
8897 .section "Local part lists" "SECTlocparlis"
8898 .cindex "list" "local part list"
8899 .cindex "local part" "list"
8900 Case-sensitivity in local part lists is handled in the same way as for address
8901 lists, as just described. The &"+caseful"& item can be used if required. In a
8902 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8903 set false, the subject is lowercased and the matching is initially
8904 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8905 matching in the local part list, but not elsewhere in the router. If
8906 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8907 option is case-sensitive from the start.
8908
8909 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8910 comments are handled in the same way as address lists &-- they are recognized
8911 only if the # is preceded by white space or the start of the line.
8912 Otherwise, local part lists are matched in the same way as domain lists, except
8913 that the special items that refer to the local host (&`@`&, &`@[]`&,
8914 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8915 Refer to section &<<SECTdomainlist>>& for details of the other available item
8916 types.
8917 .ecindex IIDdohoadli
8918
8919
8920
8921
8922 . ////////////////////////////////////////////////////////////////////////////
8923 . ////////////////////////////////////////////////////////////////////////////
8924
8925 .chapter "String expansions" "CHAPexpand"
8926 .scindex IIDstrexp "expansion" "of strings"
8927 Many strings in Exim's run time configuration are expanded before use. Some of
8928 them are expanded every time they are used; others are expanded only once.
8929
8930 When a string is being expanded it is copied verbatim from left to right except
8931 when a dollar or backslash character is encountered. A dollar specifies the
8932 start of a portion of the string that is interpreted and replaced as described
8933 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8934 escape character, as described in the following section.
8935
8936 Whether a string is expanded depends upon the context.  Usually this is solely
8937 dependent upon the option for which a value is sought; in this documentation,
8938 options for which string expansion is performed are marked with &dagger; after
8939 the data type.  ACL rules always expand strings.  A couple of expansion
8940 conditions do not expand some of the brace-delimited branches, for security
8941 reasons.
8942
8943
8944
8945 .section "Literal text in expanded strings" "SECTlittext"
8946 .cindex "expansion" "including literal text"
8947 An uninterpreted dollar can be included in an expanded string by putting a
8948 backslash in front of it. A backslash can be used to prevent any special
8949 character being treated specially in an expansion, including backslash itself.
8950 If the string appears in quotes in the configuration file, two backslashes are
8951 required because the quotes themselves cause interpretation of backslashes when
8952 the string is read in (see section &<<SECTstrings>>&).
8953
8954 .cindex "expansion" "non-expandable substrings"
8955 A portion of the string can specified as non-expandable by placing it between
8956 two occurrences of &`\N`&. This is particularly useful for protecting regular
8957 expressions, which often contain backslashes and dollar signs. For example:
8958 .code
8959 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8960 .endd
8961 On encountering the first &`\N`&, the expander copies subsequent characters
8962 without interpretation until it reaches the next &`\N`& or the end of the
8963 string.
8964
8965
8966
8967 .section "Character escape sequences in expanded strings" "SECID82"
8968 .cindex "expansion" "escape sequences"
8969 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8970 expanded string is recognized as an escape sequence for the character newline,
8971 carriage return, or tab, respectively. A backslash followed by up to three
8972 octal digits is recognized as an octal encoding for a single character, and a
8973 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8974 encoding.
8975
8976 These escape sequences are also recognized in quoted strings when they are read
8977 in. Their interpretation in expansions as well is useful for unquoted strings,
8978 and for other cases such as looked-up strings that are then expanded.
8979
8980
8981 .section "Testing string expansions" "SECID83"
8982 .cindex "expansion" "testing"
8983 .cindex "testing" "string expansion"
8984 .oindex "&%-be%&"
8985 Many expansions can be tested by calling Exim with the &%-be%& option. This
8986 takes the command arguments, or lines from the standard input if there are no
8987 arguments, runs them through the string expansion code, and writes the results
8988 to the standard output. Variables based on configuration values are set up, but
8989 since no message is being processed, variables such as &$local_part$& have no
8990 value. Nevertheless the &%-be%& option can be useful for checking out file and
8991 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8992 and &%nhash%&.
8993
8994 Exim gives up its root privilege when it is called with the &%-be%& option, and
8995 instead runs under the uid and gid it was called with, to prevent users from
8996 using &%-be%& for reading files to which they do not have access.
8997
8998 .oindex "&%-bem%&"
8999 If you want to test expansions that include variables whose values are taken
9000 from a message, there are two other options that can be used. The &%-bem%&
9001 option is like &%-be%& except that it is followed by a file name. The file is
9002 read as a message before doing the test expansions. For example:
9003 .code
9004 exim -bem /tmp/test.message '$h_subject:'
9005 .endd
9006 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9007 Exim message identifier. For example:
9008 .code
9009 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9010 .endd
9011 This loads the message from Exim's spool before doing the test expansions, and
9012 is therefore restricted to admin users.
9013
9014
9015 .section "Forced expansion failure" "SECTforexpfai"
9016 .cindex "expansion" "forced failure"
9017 A number of expansions that are described in the following section have
9018 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9019 (which are sometimes called &"curly brackets"&). Which of the two strings is
9020 used depends on some condition that is evaluated as part of the expansion. If,
9021 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9022 the entire string expansion fails in a way that can be detected by the code
9023 that requested the expansion. This is called &"forced expansion failure"&, and
9024 its consequences depend on the circumstances. In some cases it is no different
9025 from any other expansion failure, but in others a different action may be
9026 taken. Such variations are mentioned in the documentation of the option that is
9027 being expanded.
9028
9029
9030
9031
9032 .section "Expansion items" "SECTexpansionitems"
9033 The following items are recognized in expanded strings. White space may be used
9034 between sub-items that are keywords or substrings enclosed in braces inside an
9035 outer set of braces, to improve readability. &*Warning*&: Within braces,
9036 white space is significant.
9037
9038 .vlist
9039 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9040 .cindex "expansion" "variables"
9041 Substitute the contents of the named variable, for example:
9042 .code
9043 $local_part
9044 ${domain}
9045 .endd
9046 The second form can be used to separate the name from subsequent alphanumeric
9047 characters. This form (using braces) is available only for variables; it does
9048 &'not'& apply to message headers. The names of the variables are given in
9049 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9050 given, the expansion fails.
9051
9052 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9053 .cindex "expansion" "operators"
9054 The string is first itself expanded, and then the operation specified by
9055 <&'op'&> is applied to it. For example:
9056 .code
9057 ${lc:$local_part}
9058 .endd
9059 The string starts with the first character after the colon, which may be
9060 leading white space. A list of operators is given in section &<<SECTexpop>>&
9061 below. The operator notation is used for simple expansion items that have just
9062 one argument, because it reduces the number of braces and therefore makes the
9063 string easier to understand.
9064
9065 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9066 This item inserts &"basic"& header lines. It is described with the &%header%&
9067 expansion item below.
9068
9069
9070 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9071 .cindex "expansion" "calling an acl"
9072 .cindex "&%acl%&" "call from expansion"
9073 The name and zero to nine argument strings are first expanded separately.  The expanded
9074 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9075 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9076 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9077 and may use the variables; if another acl expansion is used the values
9078 are restored after it returns.  If the ACL sets
9079 a value using a "message =" modifier and returns accept or deny, the value becomes
9080 the result of the expansion.
9081 If no message is set and the ACL returns accept or deny
9082 the expansion result is an empty string.
9083 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9084
9085
9086 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9087        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9088 .cindex "expansion" "extracting cerificate fields"
9089 .cindex "&%certextract%&" "certificate fields"
9090 .cindex "certificate" "extracting fields"
9091 The <&'certificate'&> must be a variable of type certificate.
9092 The field name is expanded and used to retrieve the relevant field from
9093 the certificate.  Supported fields are:
9094 .display
9095 &`version        `&
9096 &`serial_number  `&
9097 &`subject        `& RFC4514 DN
9098 &`issuer         `& RFC4514 DN
9099 &`notbefore      `& time
9100 &`notafter       `& time
9101 &`sig_algorithm  `&
9102 &`signature      `&
9103 &`subj_altname   `& tagged list
9104 &`ocsp_uri       `& list
9105 &`crl_uri        `& list
9106 .endd
9107 If the field is found,
9108 <&'string2'&> is expanded, and replaces the whole item;
9109 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9110 variable &$value$& contains the value that has been extracted. Afterwards, it
9111 is restored to any previous value it might have had.
9112
9113 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9114 key is not found. If {<&'string2'&>} is also omitted, the value that was
9115 extracted is used.
9116
9117 Some field names take optional modifiers, appended and separated by commas.
9118
9119 The field selectors marked as "RFC4514" above
9120 output a Distinguished Name string which is
9121 not quite
9122 parseable by Exim as a comma-separated tagged list
9123 (the exceptions being elements containing commas).
9124 RDN elements of a single type may be selected by
9125 a modifier of the type label; if so the expansion
9126 result is a list (newline-separated by default).
9127 The separator may be changed by another modifier of
9128 a right angle-bracket followed immediately by the new separator.
9129 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9130
9131 The field selectors marked as "time" above
9132 take an optional modifier of "int"
9133 for which the result is the number of seconds since epoch.
9134 Otherwise the result is a human-readable string
9135 in the timezone selected by the main "timezone" option.
9136
9137 The field selectors marked as "list" above return a list,
9138 newline-separated by default,
9139 (embedded separator characters in elements are doubled).
9140 The separator may be changed by a modifier of
9141 a right angle-bracket followed immediately by the new separator.
9142
9143 The field selectors marked as "tagged" above
9144 prefix each list element with a type string and an equals sign.
9145 Elements of only one type may be selected by a modifier
9146 which is one of "dns", "uri" or "mail";
9147 if so the element tags are omitted.
9148
9149 If not otherwise noted field values are presented in human-readable form.
9150
9151 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9152        {*&<&'arg'&>&*}...}*&"
9153 .cindex &%dlfunc%&
9154 This expansion dynamically loads and then calls a locally-written C function.
9155 This functionality is available only if Exim is compiled with
9156 .code
9157 EXPAND_DLFUNC=yes
9158 .endd
9159 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9160 object so that it doesn't reload the same object file in the same Exim process
9161 (but of course Exim does start new processes frequently).
9162
9163 There may be from zero to eight arguments to the function. When compiling
9164 a local function that is to be called in this way, &_local_scan.h_& should be
9165 included. The Exim variables and functions that are defined by that API
9166 are also available for dynamically loaded functions. The function itself
9167 must have the following type:
9168 .code
9169 int dlfunction(uschar **yield, int argc, uschar *argv[])
9170 .endd
9171 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9172 function should return one of the following values:
9173
9174 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9175 into the expanded string that is being built.
9176
9177 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9178 from &'yield'&, if it is set.
9179
9180 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9181 taken from &'yield'& if it is set.
9182
9183 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9184
9185 When compiling a function that is to be used in this way with gcc,
9186 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9187 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9188
9189
9190 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9191 .cindex "expansion" "extracting value from environment"
9192 .cindex "environment" "values from"
9193 The key is first expanded separately, and leading and trailing white space
9194 removed.
9195 This is then searched for as a name in the environment.
9196 If a variable is found then its value is placed in &$value$&
9197 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9198
9199 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9200 appear, for example:
9201 .code
9202 ${env{USER}{$value} fail }
9203 .endd
9204 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9205 {<&'string1'&>} must be present for &"fail"& to be recognized.
9206
9207 If {<&'string2'&>} is omitted an empty string is substituted on
9208 search failure.
9209 If {<&'string1'&>} is omitted the search result is substituted on
9210 search success.
9211
9212 The environment is adjusted by the &%keep_environment%& and
9213 &%add_environment%& main section options.
9214
9215
9216 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9217        {*&<&'string3'&>&*}}*&"
9218 .cindex "expansion" "extracting substrings by key"
9219 .cindex "&%extract%&" "substrings by key"
9220 The key and <&'string1'&> are first expanded separately. Leading and trailing
9221 white space is removed from the key (but not from any of the strings). The key
9222 must not be empty and must not consist entirely of digits.
9223 The expanded <&'string1'&> must be of the form:
9224 .display
9225 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9226 .endd
9227 .vindex "&$value$&"
9228 where the equals signs and spaces (but not both) are optional. If any of the
9229 values contain white space, they must be enclosed in double quotes, and any
9230 values that are enclosed in double quotes are subject to escape processing as
9231 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9232 for the value that corresponds to the key. The search is case-insensitive. If
9233 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9234 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9235 variable &$value$& contains the value that has been extracted. Afterwards, it
9236 is restored to any previous value it might have had.
9237
9238 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9239 key is not found. If {<&'string2'&>} is also omitted, the value that was
9240 extracted is used. Thus, for example, these two expansions are identical, and
9241 yield &"2001"&:
9242 .code
9243 ${extract{gid}{uid=1984 gid=2001}}
9244 ${extract{gid}{uid=1984 gid=2001}{$value}}
9245 .endd
9246 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9247 appear, for example:
9248 .code
9249 ${extract{Z}{A=... B=...}{$value} fail }
9250 .endd
9251 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9252 {<&'string2'&>} must be present for &"fail"& to be recognized.
9253
9254
9255 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9256         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9257 .cindex "expansion" "extracting substrings by number"
9258 .cindex "&%extract%&" "substrings by number"
9259 The <&'number'&> argument must consist entirely of decimal digits,
9260 apart from leading and trailing white space, which is ignored.
9261 This is what distinguishes this form of &%extract%& from the previous kind. It
9262 behaves in the same way, except that, instead of extracting a named field, it
9263 extracts from <&'string1'&> the field whose number is given as the first
9264 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9265 <&'string3'&> as before.
9266
9267 The fields in the string are separated by any one of the characters in the
9268 separator string. These may include space or tab characters.
9269 The first field is numbered one. If the number is negative, the fields are
9270 counted from the end of the string, with the rightmost one numbered -1. If the
9271 number given is zero, the entire string is returned. If the modulus of the
9272 number is greater than the number of fields in the string, the result is the
9273 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9274 provided. For example:
9275 .code
9276 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9277 .endd
9278 yields &"42"&, and
9279 .code
9280 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9281 .endd
9282 yields &"99"&. Two successive separators mean that the field between them is
9283 empty (for example, the fifth field above).
9284
9285
9286 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9287 .cindex "list" "selecting by condition"
9288 .cindex "expansion" "selecting from list by condition"
9289 .vindex "&$item$&"
9290 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9291 default, but the separator can be changed in the usual way. For each item
9292 in this list, its value is place in &$item$&, and then the condition is
9293 evaluated. If the condition is true, &$item$& is added to the output as an
9294 item in a new list; if the condition is false, the item is discarded. The
9295 separator used for the output list is the same as the one used for the
9296 input, but a separator setting is not included in the output. For example:
9297 .code
9298 ${filter{a:b:c}{!eq{$item}{b}}
9299 .endd
9300 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9301 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9302
9303
9304 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9305 .cindex "hash function" "textual"
9306 .cindex "expansion" "textual hash"
9307 This is a textual hashing function, and was the first to be implemented in
9308 early versions of Exim. In current releases, there are other hashing functions
9309 (numeric, MD5, and SHA-1), which are described below.
9310
9311 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9312 <&'n'&>. If you are using fixed values for these numbers, that is, if
9313 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9314 use the simpler operator notation that avoids some of the braces:
9315 .code
9316 ${hash_<n>_<m>:<string>}
9317 .endd
9318 The second number is optional (in both notations). If <&'n'&> is greater than
9319 or equal to the length of the string, the expansion item returns the string.
9320 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9321 function to the string. The new string consists of characters taken from the
9322 first <&'m'&> characters of the string
9323 .code
9324 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9325 .endd
9326 If <&'m'&> is not present the value 26 is used, so that only lower case
9327 letters appear. For example:
9328 .display
9329 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9330 &`$hash{5}{monty}}           `&   yields  &`monty`&
9331 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9332 .endd
9333
9334 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9335         &*$h_*&<&'header&~name'&>&*:*&" &&&
9336        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9337         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9338        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9339         &*$rh_*&<&'header&~name'&>&*:*&"
9340 .cindex "expansion" "header insertion"
9341 .vindex "&$header_$&"
9342 .vindex "&$bheader_$&"
9343 .vindex "&$rheader_$&"
9344 .cindex "header lines" "in expansion strings"
9345 .cindex "header lines" "character sets"
9346 .cindex "header lines" "decoding"
9347 Substitute the contents of the named message header line, for example
9348 .code
9349 $header_reply-to:
9350 .endd
9351 The newline that terminates a header line is not included in the expansion, but
9352 internal newlines (caused by splitting the header line over several physical
9353 lines) may be present.
9354
9355 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9356 the data in the header line is interpreted.
9357
9358 .ilist
9359 .cindex "white space" "in header lines"
9360 &%rheader%& gives the original &"raw"& content of the header line, with no
9361 processing at all, and without the removal of leading and trailing white space.
9362
9363 .next
9364 .cindex "base64 encoding" "in header lines"
9365 &%bheader%& removes leading and trailing white space, and then decodes base64
9366 or quoted-printable MIME &"words"& within the header text, but does no
9367 character set translation. If decoding of what looks superficially like a MIME
9368 &"word"& fails, the raw string is returned. If decoding
9369 .cindex "binary zero" "in header line"
9370 produces a binary zero character, it is replaced by a question mark &-- this is
9371 what Exim does for binary zeros that are actually received in header lines.
9372
9373 .next
9374 &%header%& tries to translate the string as decoded by &%bheader%& to a
9375 standard character set. This is an attempt to produce the same string as would
9376 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9377 returned. Translation is attempted only on operating systems that support the
9378 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9379 a system Makefile or in &_Local/Makefile_&.
9380 .endlist ilist
9381
9382 In a filter file, the target character set for &%header%& can be specified by a
9383 command of the following form:
9384 .code
9385 headers charset "UTF-8"
9386 .endd
9387 This command affects all references to &$h_$& (or &$header_$&) expansions in
9388 subsequently obeyed filter commands. In the absence of this command, the target
9389 character set in a filter is taken from the setting of the &%headers_charset%&
9390 option in the runtime configuration. The value of this option defaults to the
9391 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9392 ISO-8859-1.
9393
9394 Header names follow the syntax of RFC 2822, which states that they may contain
9395 any printing characters except space and colon. Consequently, curly brackets
9396 &'do not'& terminate header names, and should not be used to enclose them as
9397 if they were variables. Attempting to do so causes a syntax error.
9398
9399 Only header lines that are common to all copies of a message are visible to
9400 this mechanism. These are the original header lines that are received with the
9401 message, and any that are added by an ACL statement or by a system
9402 filter. Header lines that are added to a particular copy of a message by a
9403 router or transport are not accessible.
9404
9405 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9406 before the DATA ACL, because the header structure is not set up until the
9407 message is received. Header lines that are added in a RCPT ACL (for example)
9408 are saved until the message's incoming header lines are available, at which
9409 point they are added. When a DATA ACL is running, however, header lines added
9410 by earlier ACLs are visible.
9411
9412 Upper case and lower case letters are synonymous in header names. If the
9413 following character is white space, the terminating colon may be omitted, but
9414 this is not recommended, because you may then forget it when it is needed. When
9415 white space terminates the header name, this white space is included in the
9416 expanded string.  If the message does not contain the given header, the
9417 expansion item is replaced by an empty string. (See the &%def%& condition in
9418 section &<<SECTexpcond>>& for a means of testing for the existence of a
9419 header.)
9420
9421 If there is more than one header with the same name, they are all concatenated
9422 to form the substitution string, up to a maximum length of 64K. Unless
9423 &%rheader%& is being used, leading and trailing white space is removed from
9424 each header before concatenation, and a completely empty header is ignored. A
9425 newline character is then inserted between non-empty headers, but there is no
9426 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9427 those headers that contain lists of addresses, a comma is also inserted at the
9428 junctions between headers. This does not happen for the &%rheader%& expansion.
9429
9430
9431 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9432 .cindex "expansion" "hmac hashing"
9433 .cindex &%hmac%&
9434 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9435 shared secret and some text into a message authentication code, as specified in
9436 RFC 2104. This differs from &`${md5:secret_text...}`& or
9437 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9438 cryptographic hash, allowing for authentication that is not possible with MD5
9439 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9440 present. For example:
9441 .code
9442 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9443 .endd
9444 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9445 produces:
9446 .code
9447 dd97e3ba5d1a61b5006108f8c8252953
9448 .endd
9449 As an example of how this might be used, you might put in the main part of
9450 an Exim configuration:
9451 .code
9452 SPAMSCAN_SECRET=cohgheeLei2thahw
9453 .endd
9454 In a router or a transport you could then have:
9455 .code
9456 headers_add = \
9457   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9458   ${hmac{md5}{SPAMSCAN_SECRET}\
9459   {${primary_hostname},${message_exim_id},$h_message-id:}}
9460 .endd
9461 Then given a message, you can check where it was scanned by looking at the
9462 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9463 this header line is authentic by recomputing the authentication code from the
9464 host name, message ID and the &'Message-id:'& header line. This can be done
9465 using Exim's &%-be%& option, or by other means, for example by using the
9466 &'hmac_md5_hex()'& function in Perl.
9467
9468
9469 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9470 .cindex "expansion" "conditional"
9471 .cindex "&%if%&, expansion item"
9472 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9473 item; otherwise <&'string2'&> is used. The available conditions are described
9474 in section &<<SECTexpcond>>& below. For example:
9475 .code
9476 ${if eq {$local_part}{postmaster} {yes}{no} }
9477 .endd
9478 The second string need not be present; if it is not and the condition is not
9479 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9480 be present instead of the second string (without any curly brackets). In this
9481 case, the expansion is forced to fail if the condition is not true (see section
9482 &<<SECTforexpfai>>&).
9483
9484 If both strings are omitted, the result is the string &`true`& if the condition
9485 is true, and the empty string if the condition is false. This makes it less
9486 cumbersome to write custom ACL and router conditions. For example, instead of
9487 .code
9488 condition = ${if >{$acl_m4}{3}{true}{false}}
9489 .endd
9490 you can use
9491 .code
9492 condition = ${if >{$acl_m4}{3}}
9493 .endd
9494
9495
9496
9497 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9498 .cindex expansion "imap folder"
9499 .cindex "&%imapfolder%& expansion item"
9500 This item converts a (possibly multilevel, or with non-ASCII characters)
9501 folder specification to a Maildir name for filesystem use.
9502 For information on internationalisation support see &<<SECTi18nMDA>>&.
9503
9504
9505
9506 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9507 .cindex "expansion" "string truncation"
9508 .cindex "&%length%& expansion item"
9509 The &%length%& item is used to extract the initial portion of a string. Both
9510 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9511 you are using a fixed value for the number, that is, if <&'string1'&> does not
9512 change when expanded, you can use the simpler operator notation that avoids
9513 some of the braces:
9514 .code
9515 ${length_<n>:<string>}
9516 .endd
9517 The result of this item is either the first <&'n'&> characters or the whole
9518 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9519 &%strlen%&, which gives the length of a string.
9520
9521
9522 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9523         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9524 .cindex "expansion" "extracting list elements by number"
9525 .cindex "&%listextract%&" "extract list elements by number"
9526 .cindex "list" "extracting elements by number"
9527 The <&'number'&> argument must consist entirely of decimal digits,
9528 apart from an optional leading minus,
9529 and leading and trailing white space (which is ignored).
9530
9531 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9532 default, but the separator can be changed in the usual way.
9533
9534 The first field of the list is numbered one.
9535 If the number is negative, the fields are
9536 counted from the end of the list, with the rightmost one numbered -1.
9537 The numbered element of the list is extracted and placed in &$value$&,
9538 then <&'string2'&> is expanded as the result.
9539
9540 If the modulus of the
9541 number is zero or greater than the number of fields in the string,
9542 the result is the expansion of <&'string3'&>.
9543
9544 For example:
9545 .code
9546 ${listextract{2}{x:42:99}}
9547 .endd
9548 yields &"42"&, and
9549 .code
9550 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9551 .endd
9552 yields &"result: 42"&.
9553
9554 If {<&'string3'&>} is omitted, an empty string is used for string3.
9555 If {<&'string2'&>} is also omitted, the value that was
9556 extracted is used.
9557 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9558
9559
9560 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9561         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9562 This is the first of one of two different types of lookup item, which are both
9563 described in the next item.
9564
9565 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9566         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9567 .cindex "expansion" "lookup in"
9568 .cindex "file" "lookups"
9569 .cindex "lookup" "in expanded string"
9570 The two forms of lookup item specify data lookups in files and databases, as
9571 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9572 lookups, and the second is used for query-style lookups. The <&'key'&>,
9573 <&'file'&>, and <&'query'&> strings are expanded before use.
9574
9575 If there is any white space in a lookup item which is part of a filter command,
9576 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9577 other place where white space is significant, the lookup item must be enclosed
9578 in double quotes. The use of data lookups in users' filter files may be locked
9579 out by the system administrator.
9580
9581 .vindex "&$value$&"
9582 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9583 During its expansion, the variable &$value$& contains the data returned by the
9584 lookup. Afterwards it reverts to the value it had previously (at the outer
9585 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9586 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9587 string on failure. If <&'string2'&> is provided, it can itself be a nested
9588 lookup, thus providing a mechanism for looking up a default value when the
9589 original lookup fails.
9590
9591 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9592 data for the outer lookup while the parameters of the second lookup are
9593 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9594 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9595 appear, and in this case, if the lookup fails, the entire expansion is forced
9596 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9597 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9598 successful lookup, and nothing in the case of failure.
9599
9600 For single-key lookups, the string &"partial"& is permitted to precede the
9601 search type in order to do partial matching, and * or *@ may follow a search
9602 type to request default lookups if the key does not match (see sections
9603 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9604
9605 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9606 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9607 and non-wild parts of the key during the expansion of the replacement text.
9608 They return to their previous values at the end of the lookup item.
9609
9610 This example looks up the postmaster alias in the conventional alias file:
9611 .code
9612 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9613 .endd
9614 This example uses NIS+ to look up the full name of the user corresponding to
9615 the local part of an address, forcing the expansion to fail if it is not found:
9616 .code
9617 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9618   {$value}fail}
9619 .endd
9620
9621
9622 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9623 .cindex "expansion" "list creation"
9624 .vindex "&$item$&"
9625 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9626 default, but the separator can be changed in the usual way. For each item
9627 in this list, its value is place in &$item$&, and then <&'string2'&> is
9628 expanded and added to the output as an item in a new list. The separator used
9629 for the output list is the same as the one used for the input, but a separator
9630 setting is not included in the output. For example:
9631 .code
9632 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9633 .endd
9634 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9635 value of &$item$& is restored to what it was before. See also the &*filter*&
9636 and &*reduce*& expansion items.
9637
9638 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9639 .cindex "expansion" "numeric hash"
9640 .cindex "hash function" "numeric"
9641 The three strings are expanded; the first two must yield numbers. Call them
9642 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9643 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9644 can use the simpler operator notation that avoids some of the braces:
9645 .code
9646 ${nhash_<n>_<m>:<string>}
9647 .endd
9648 The second number is optional (in both notations). If there is only one number,
9649 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9650 processed by a div/mod hash function that returns two numbers, separated by a
9651 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9652 example,
9653 .code
9654 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9655 .endd
9656 returns the string &"6/33"&.
9657
9658
9659
9660 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9661 .cindex "Perl" "use in expanded string"
9662 .cindex "expansion" "calling Perl from"
9663 This item is available only if Exim has been built to include an embedded Perl
9664 interpreter. The subroutine name and the arguments are first separately
9665 expanded, and then the Perl subroutine is called with those arguments. No
9666 additional arguments need be given; the maximum number permitted, including the
9667 name of the subroutine, is nine.
9668
9669 The return value of the subroutine is inserted into the expanded string, unless
9670 the return value is &%undef%&. In that case, the expansion fails in the same
9671 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9672 Whatever you return is evaluated in a scalar context. For example, if you
9673 return the name of a Perl vector, the return value is the size of the vector,
9674 not its contents.
9675
9676 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9677 with the error message that was passed to &%die%&. More details of the embedded
9678 Perl facility are given in chapter &<<CHAPperl>>&.
9679
9680 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9681 out the use of this expansion item in filter files.
9682
9683
9684 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9685 .cindex "&%prvs%& expansion item"
9686 The first argument is a complete email address and the second is secret
9687 keystring. The third argument, specifying a key number, is optional. If absent,
9688 it defaults to 0. The result of the expansion is a prvs-signed email address,
9689 to be typically used with the &%return_path%& option on an &(smtp)& transport
9690 as part of a bounce address tag validation (BATV) scheme. For more discussion
9691 and an example, see section &<<SECTverifyPRVS>>&.
9692
9693 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9694         {*&<&'string'&>&*}}*&"
9695 .cindex "&%prvscheck%& expansion item"
9696 This expansion item is the complement of the &%prvs%& item. It is used for
9697 checking prvs-signed addresses. If the expansion of the first argument does not
9698 yield a syntactically valid prvs-signed address, the whole item expands to the
9699 empty string. When the first argument does expand to a syntactically valid
9700 prvs-signed address, the second argument is expanded, with the prvs-decoded
9701 version of the address and the key number extracted from the address in the
9702 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9703
9704 These two variables can be used in the expansion of the second argument to
9705 retrieve the secret. The validity of the prvs-signed address is then checked
9706 against the secret. The result is stored in the variable &$prvscheck_result$&,
9707 which is empty for failure or &"1"& for success.
9708
9709 The third argument is optional; if it is missing, it defaults to an empty
9710 string. This argument is now expanded. If the result is an empty string, the
9711 result of the expansion is the decoded version of the address. This is the case
9712 whether or not the signature was valid. Otherwise, the result of the expansion
9713 is the expansion of the third argument.
9714
9715 All three variables can be used in the expansion of the third argument.
9716 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9717 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9718
9719 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9720 .cindex "expansion" "inserting an entire file"
9721 .cindex "file" "inserting into expansion"
9722 .cindex "&%readfile%& expansion item"
9723 The file name and end-of-line string are first expanded separately. The file is
9724 then read, and its contents replace the entire item. All newline characters in
9725 the file are replaced by the end-of-line string if it is present. Otherwise,
9726 newlines are left in the string.
9727 String expansion is not applied to the contents of the file. If you want this,
9728 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9729 the string expansion fails.
9730
9731 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9732 locks out the use of this expansion item in filter files.
9733
9734
9735
9736 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9737         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9738 .cindex "expansion" "inserting from a socket"
9739 .cindex "socket, use of in expansion"
9740 .cindex "&%readsocket%& expansion item"
9741 This item inserts data from a Unix domain or TCP socket into the expanded
9742 string. The minimal way of using it uses just two arguments, as in these
9743 examples:
9744 .code
9745 ${readsocket{/socket/name}{request string}}
9746 ${readsocket{inet:some.host:1234}{request string}}
9747 .endd
9748 For a Unix domain socket, the first substring must be the path to the socket.
9749 For an Internet socket, the first substring must contain &`inet:`& followed by
9750 a host name or IP address, followed by a colon and a port, which can be a
9751 number or the name of a TCP port in &_/etc/services_&. An IP address may
9752 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9753 example:
9754 .code
9755 ${readsocket{inet:[::1]:1234}{request string}}
9756 .endd
9757 Only a single host name may be given, but if looking it up yields more than
9758 one IP address, they are each tried in turn until a connection is made. For
9759 both kinds of socket, Exim makes a connection, writes the request string
9760 unless it is an empty string; and no terminating NUL is ever sent)
9761 and reads from the socket until an end-of-file
9762 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9763 extend what can be done. Firstly, you can vary the timeout. For example:
9764 .code
9765 ${readsocket{/socket/name}{request string}{3s}}
9766 .endd
9767 A fourth argument allows you to change any newlines that are in the data
9768 that is read, in the same way as for &%readfile%& (see above). This example
9769 turns them into spaces:
9770 .code
9771 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9772 .endd
9773 As with all expansions, the substrings are expanded before the processing
9774 happens. Errors in these sub-expansions cause the expansion to fail. In
9775 addition, the following errors can occur:
9776
9777 .ilist
9778 Failure to create a socket file descriptor;
9779 .next
9780 Failure to connect the socket;
9781 .next
9782 Failure to write the request string;
9783 .next
9784 Timeout on reading from the socket.
9785 .endlist
9786
9787 By default, any of these errors causes the expansion to fail. However, if
9788 you supply a fifth substring, it is expanded and used when any of the above
9789 errors occurs. For example:
9790 .code
9791 ${readsocket{/socket/name}{request string}{3s}{\n}\
9792   {socket failure}}
9793 .endd
9794 You can test for the existence of a Unix domain socket by wrapping this
9795 expansion in &`${if exists`&, but there is a race condition between that test
9796 and the actual opening of the socket, so it is safer to use the fifth argument
9797 if you want to be absolutely sure of avoiding an expansion error for a
9798 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9799
9800 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9801 locks out the use of this expansion item in filter files.
9802
9803
9804 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9805 .cindex "expansion" "reducing a list to a scalar"
9806 .cindex "list" "reducing to a scalar"
9807 .vindex "&$value$&"
9808 .vindex "&$item$&"
9809 This operation reduces a list to a single, scalar string. After expansion,
9810 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9811 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9812 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9813 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9814 them. The result of that expansion is assigned to &$value$& before the next
9815 iteration. When the end of the list is reached, the final value of &$value$& is
9816 added to the expansion output. The &*reduce*& expansion item can be used in a
9817 number of ways. For example, to add up a list of numbers:
9818 .code
9819 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9820 .endd
9821 The result of that expansion would be &`6`&. The maximum of a list of numbers
9822 can be found:
9823 .code
9824 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9825 .endd
9826 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9827 restored to what they were before. See also the &*filter*& and &*map*&
9828 expansion items.
9829
9830 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9831 This item inserts &"raw"& header lines. It is described with the &%header%&
9832 expansion item above.
9833
9834 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9835         {*&<&'string2'&>&*}}*&"
9836 .cindex "expansion" "running a command"
9837 .cindex "&%run%& expansion item"
9838 The command and its arguments are first expanded as one string. The string is
9839 split apart into individual arguments by spaces, and then the command is run
9840 in a separate process, but under the same uid and gid.  As in other command
9841 executions from Exim, a shell is not used by default. If the command requires
9842 a shell, you must explicitly code it.
9843
9844 Since the arguments are split by spaces, when there is a variable expansion
9845 which has an empty result, it will cause the situation that the argument will
9846 simply be omitted when the program is actually executed by Exim. If the
9847 script/program requires a specific number of arguments and the expanded
9848 variable could possibly result in this empty expansion, the variable must be
9849 quoted. This is more difficult if the expanded variable itself could result
9850 in a string containing quotes, because it would interfere with the quotes
9851 around the command arguments. A possible guard against this is to wrap the
9852 variable in the &%sg%& operator to change any quote marks to some other
9853 character.
9854
9855 The standard input for the command exists, but is empty. The standard output
9856 and standard error are set to the same file descriptor.
9857 .cindex "return code" "from &%run%& expansion"
9858 .vindex "&$value$&"
9859 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9860 and replaces the entire item; during this expansion, the standard output/error
9861 from the command is in the variable &$value$&. If the command fails,
9862 <&'string2'&>, if present, is expanded and used. Once again, during the
9863 expansion, the standard output/error from the command is in the variable
9864 &$value$&.
9865
9866 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9867 can be the word &"fail"& (not in braces) to force expansion failure if the
9868 command does not succeed. If both strings are omitted, the result is contents
9869 of the standard output/error on success, and nothing on failure.
9870
9871 .vindex "&$run_in_acl$&"
9872 The standard output/error of the command is put in the variable &$value$&.
9873 In this ACL example, the output of a command is logged for the admin to
9874 troubleshoot:
9875 .code
9876 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9877       log_message  = Output of id: $value
9878 .endd
9879 If the command requires shell idioms, such as the > redirect operator, the
9880 shell must be invoked directly, such as with:
9881 .code
9882 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9883 .endd
9884
9885 .vindex "&$runrc$&"
9886 The return code from the command is put in the variable &$runrc$&, and this
9887 remains set afterwards, so in a filter file you can do things like this:
9888 .code
9889 if "${run{x y z}{}}$runrc" is 1 then ...
9890   elif $runrc is 2 then ...
9891   ...
9892 endif
9893 .endd
9894 If execution of the command fails (for example, the command does not exist),
9895 the return code is 127 &-- the same code that shells use for non-existent
9896 commands.
9897
9898 &*Warning*&: In a router or transport, you cannot assume the order in which
9899 option values are expanded, except for those preconditions whose order of
9900 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9901 by the expansion of one option, and use it in another.
9902
9903 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9904 out the use of this expansion item in filter files.
9905
9906
9907 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9908 .cindex "expansion" "string substitution"
9909 .cindex "&%sg%& expansion item"
9910 This item works like Perl's substitution operator (s) with the global (/g)
9911 option; hence its name. However, unlike the Perl equivalent, Exim does not
9912 modify the subject string; instead it returns the modified string for insertion
9913 into the overall expansion. The item takes three arguments: the subject string,
9914 a regular expression, and a substitution string. For example:
9915 .code
9916 ${sg{abcdefabcdef}{abc}{xyz}}
9917 .endd
9918 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9919 if any $ or \ characters are required in the regular expression or in the
9920 substitution string, they have to be escaped. For example:
9921 .code
9922 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9923 .endd
9924 yields &"defabc"&, and
9925 .code
9926 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9927 .endd
9928 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9929 the regular expression from string expansion.
9930
9931
9932
9933 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9934 .cindex sorting "a list"
9935 .cindex list sorting
9936 .cindex expansion "list sorting"
9937 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9938 default, but the separator can be changed in the usual way.
9939 The <&'comparator'&> argument is interpreted as the operator
9940 of a two-argument expansion condition.
9941 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9942 The comparison should return true when applied to two values
9943 if the first value should sort before the second value.
9944 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9945 the element being placed in &$item$&,
9946 to give values for comparison.
9947
9948 The item result is a sorted list,
9949 with the original list separator,
9950 of the list elements (in full) of the original.
9951
9952 Examples:
9953 .code
9954 ${sort{3:2:1:4}{<}{$item}}
9955 .endd
9956 sorts a list of numbers, and
9957 .code
9958 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9959 .endd
9960 will sort an MX lookup into priority order.
9961
9962
9963 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9964 .cindex "&%substr%& expansion item"
9965 .cindex "substring extraction"
9966 .cindex "expansion" "substring extraction"
9967 The three strings are expanded; the first two must yield numbers. Call them
9968 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9969 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9970 can use the simpler operator notation that avoids some of the braces:
9971 .code
9972 ${substr_<n>_<m>:<string>}
9973 .endd
9974 The second number is optional (in both notations).
9975 If it is absent in the simpler format, the preceding underscore must also be
9976 omitted.
9977
9978 The &%substr%& item can be used to extract more general substrings than
9979 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9980 length required. For example
9981 .code
9982 ${substr{3}{2}{$local_part}}
9983 .endd
9984 If the starting offset is greater than the string length the result is the
9985 null string; if the length plus starting offset is greater than the string
9986 length, the result is the right-hand part of the string, starting from the
9987 given offset. The first character in the string has offset zero.
9988
9989 The &%substr%& expansion item can take negative offset values to count
9990 from the right-hand end of its operand. The last character is offset -1, the
9991 second-last is offset -2, and so on. Thus, for example,
9992 .code
9993 ${substr{-5}{2}{1234567}}
9994 .endd
9995 yields &"34"&. If the absolute value of a negative offset is greater than the
9996 length of the string, the substring starts at the beginning of the string, and
9997 the length is reduced by the amount of overshoot. Thus, for example,
9998 .code
9999 ${substr{-5}{2}{12}}
10000 .endd
10001 yields an empty string, but
10002 .code
10003 ${substr{-3}{2}{12}}
10004 .endd
10005 yields &"1"&.
10006
10007 When the second number is omitted from &%substr%&, the remainder of the string
10008 is taken if the offset is positive. If it is negative, all characters in the
10009 string preceding the offset point are taken. For example, an offset of -1 and
10010 no length, as in these semantically identical examples:
10011 .code
10012 ${substr_-1:abcde}
10013 ${substr{-1}{abcde}}
10014 .endd
10015 yields all but the last character of the string, that is, &"abcd"&.
10016
10017
10018
10019 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10020         {*&<&'replacements'&>&*}}*&"
10021 .cindex "expansion" "character translation"
10022 .cindex "&%tr%& expansion item"
10023 This item does single-character translation on its subject string. The second
10024 argument is a list of characters to be translated in the subject string. Each
10025 matching character is replaced by the corresponding character from the
10026 replacement list. For example
10027 .code
10028 ${tr{abcdea}{ac}{13}}
10029 .endd
10030 yields &`1b3de1`&. If there are duplicates in the second character string, the
10031 last occurrence is used. If the third string is shorter than the second, its
10032 last character is replicated. However, if it is empty, no translation takes
10033 place.
10034 .endlist
10035
10036
10037
10038 .section "Expansion operators" "SECTexpop"
10039 .cindex "expansion" "operators"
10040 For expansion items that perform transformations on a single argument string,
10041 the &"operator"& notation is used because it is simpler and uses fewer braces.
10042 The substring is first expanded before the operation is applied to it. The
10043 following operations can be performed:
10044
10045 .vlist
10046 .vitem &*${address:*&<&'string'&>&*}*&
10047 .cindex "expansion" "RFC 2822 address handling"
10048 .cindex "&%address%& expansion item"
10049 The string is interpreted as an RFC 2822 address, as it might appear in a
10050 header line, and the effective address is extracted from it. If the string does
10051 not parse successfully, the result is empty.
10052
10053
10054 .vitem &*${addresses:*&<&'string'&>&*}*&
10055 .cindex "expansion" "RFC 2822 address handling"
10056 .cindex "&%addresses%& expansion item"
10057 The string (after expansion) is interpreted as a list of addresses in RFC
10058 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10059 operative address (&'local-part@domain'&) is extracted from each item, and the
10060 result of the expansion is a colon-separated list, with appropriate
10061 doubling of colons should any happen to be present in the email addresses.
10062 Syntactically invalid RFC2822 address items are omitted from the output.
10063
10064 It is possible to specify a character other than colon for the output
10065 separator by starting the string with > followed by the new separator
10066 character. For example:
10067 .code
10068 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10069 .endd
10070 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10071 expansion item, which extracts the working address from a single RFC2822
10072 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10073 processing lists.
10074
10075 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10076 a strict interpretation of header line formatting.  Exim parses the bare,
10077 unquoted portion of an email address and if it finds a comma, treats it as an
10078 email address separator. For the example header line:
10079 .code
10080 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10081 .endd
10082 The first example below demonstrates that Q-encoded email addresses are parsed
10083 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10084 It does not see the comma because it's still encoded as "=2C".  The second
10085 example below is passed the contents of &`$header_from:`&, meaning it gets
10086 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10087 The third example shows that the presence of a comma is skipped when it is
10088 quoted.
10089 .code
10090 # exim -be '${addresses:From: \
10091 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10092 user@example.com
10093 # exim -be '${addresses:From: Last, First <user@example.com>}'
10094 Last:user@example.com
10095 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10096 user@example.com
10097 .endd
10098
10099 .new
10100 .vitem &*${base32:*&<&'digits'&>&*}*&
10101 .cindex "&%base32%& expansion item"
10102 .cindex "expansion" "conversion to base 32"
10103 The string must consist entirely of decimal digits. The number is converted to
10104 base 32 and output as a (empty, for zero) string of characters.
10105 Only lowercase letters are used.
10106
10107 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10108 .cindex "&%base32d%& expansion item"
10109 .cindex "expansion" "conversion to base 32"
10110 The string must consist entirely of base-32 digits.
10111 The number is converted to decimal and output as a string.
10112 .wen
10113
10114 .vitem &*${base62:*&<&'digits'&>&*}*&
10115 .cindex "&%base62%& expansion item"
10116 .cindex "expansion" "conversion to base 62"
10117 The string must consist entirely of decimal digits. The number is converted to
10118 base 62 and output as a string of six characters, including leading zeros. In
10119 the few operating environments where Exim uses base 36 instead of base 62 for
10120 its message identifiers (because those systems do not have case-sensitive file
10121 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10122 be absolutely clear: this is &'not'& base64 encoding.
10123
10124 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10125 .cindex "&%base62d%& expansion item"
10126 .cindex "expansion" "conversion to base 62"
10127 The string must consist entirely of base-62 digits, or, in operating
10128 environments where Exim uses base 36 instead of base 62 for its message
10129 identifiers, base-36 digits. The number is converted to decimal and output as a
10130 string.
10131
10132 .vitem &*${base64:*&<&'string'&>&*}*&
10133 .cindex "expansion" "base64 encoding"
10134 .cindex "base64 encoding" "in string expansion"
10135 .cindex "&%base64%& expansion item"
10136 .cindex certificate "base64 of DER"
10137 This operator converts a string into one that is base64 encoded.
10138
10139 If the string is a single variable of type certificate,
10140 returns the base64 encoding of the DER form of the certificate.
10141
10142
10143 .vitem &*${base64d:*&<&'string'&>&*}*&
10144 .cindex "expansion" "base64 decoding"
10145 .cindex "base64 decoding" "in string expansion"
10146 .cindex "&%base64d%& expansion item"
10147 This operator converts a base64-encoded string into the un-coded form.
10148
10149
10150 .vitem &*${domain:*&<&'string'&>&*}*&
10151 .cindex "domain" "extraction"
10152 .cindex "expansion" "domain extraction"
10153 The string is interpreted as an RFC 2822 address and the domain is extracted
10154 from it. If the string does not parse successfully, the result is empty.
10155
10156
10157 .vitem &*${escape:*&<&'string'&>&*}*&
10158 .cindex "expansion" "escaping non-printing characters"
10159 .cindex "&%escape%& expansion item"
10160 If the string contains any non-printing characters, they are converted to
10161 escape sequences starting with a backslash. Whether characters with the most
10162 significant bit set (so-called &"8-bit characters"&) count as printing or not
10163 is controlled by the &%print_topbitchars%& option.
10164
10165 .new
10166 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10167 .cindex "expansion" "escaping 8-bit characters"
10168 .cindex "&%escape8bit%& expansion item"
10169 If the string contains and characters with the most significant bit set,
10170 they are converted to escape sequences starting with a backslash.
10171 Backslashes and DEL characters are also converted.
10172 .wen
10173
10174
10175 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10176 .cindex "expansion" "expression evaluation"
10177 .cindex "expansion" "arithmetic expression"
10178 .cindex "&%eval%& expansion item"
10179 These items supports simple arithmetic and bitwise logical operations in
10180 expansion strings. The string (after expansion) must be a conventional
10181 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10182 logical operators, and parentheses. All operations are carried out using
10183 integer arithmetic. The operator priorities are as follows (the same as in the
10184 C programming language):
10185 .table2 70pt 300pt
10186 .irow &'highest:'& "not (~), negate (-)"
10187 .irow ""   "multiply (*), divide (/), remainder (%)"
10188 .irow ""   "plus (+), minus (-)"
10189 .irow ""   "shift-left (<<), shift-right (>>)"
10190 .irow ""   "and (&&)"
10191 .irow ""   "xor (^)"
10192 .irow &'lowest:'&  "or (|)"
10193 .endtable
10194 Binary operators with the same priority are evaluated from left to right. White
10195 space is permitted before or after operators.
10196
10197 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10198 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10199 decimal, even if they start with a leading zero; hexadecimal numbers are not
10200 permitted. This can be useful when processing numbers extracted from dates or
10201 times, which often do have leading zeros.
10202
10203 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10204 or 1024*1024*1024,
10205 respectively. Negative numbers are supported. The result of the computation is
10206 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10207
10208 .display
10209 &`${eval:1+1}            `&  yields 2
10210 &`${eval:1+2*3}          `&  yields 7
10211 &`${eval:(1+2)*3}        `&  yields 9
10212 &`${eval:2+42%5}         `&  yields 4
10213 &`${eval:0xc&amp;5}          `&  yields 4
10214 &`${eval:0xc|5}          `&  yields 13
10215 &`${eval:0xc^5}          `&  yields 9
10216 &`${eval:0xc>>1}         `&  yields 6
10217 &`${eval:0xc<<1}         `&  yields 24
10218 &`${eval:~255&amp;0x1234}    `&  yields 4608
10219 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10220 .endd
10221
10222 As a more realistic example, in an ACL you might have
10223 .code
10224 deny   message = Too many bad recipients
10225        condition =                    \
10226          ${if and {                   \
10227            {>{$rcpt_count}{10}}       \
10228            {                          \
10229            <                          \
10230              {$recipients_count}      \
10231              {${eval:$rcpt_count/2}}  \
10232            }                          \
10233          }{yes}{no}}
10234 .endd
10235 The condition is true if there have been more than 10 RCPT commands and
10236 fewer than half of them have resulted in a valid recipient.
10237
10238
10239 .vitem &*${expand:*&<&'string'&>&*}*&
10240 .cindex "expansion" "re-expansion of substring"
10241 The &%expand%& operator causes a string to be expanded for a second time. For
10242 example,
10243 .code
10244 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10245 .endd
10246 first looks up a string in a file while expanding the operand for &%expand%&,
10247 and then re-expands what it has found.
10248
10249
10250 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10251 .cindex "Unicode"
10252 .cindex "UTF-8" "conversion from"
10253 .cindex "expansion" "UTF-8 conversion"
10254 .cindex "&%from_utf8%& expansion item"
10255 The world is slowly moving towards Unicode, although there are no standards for
10256 email yet. However, other applications (including some databases) are starting
10257 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10258 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10259 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10260 the result is an undefined sequence of bytes.
10261
10262 Unicode code points with values less than 256 are compatible with ASCII and
10263 ISO-8859-1 (also known as Latin-1).
10264 For example, character 169 is the copyright symbol in both cases, though the
10265 way it is encoded is different. In UTF-8, more than one byte is needed for
10266 characters with code values greater than 127, whereas ISO-8859-1 is a
10267 single-byte encoding (but thereby limited to 256 characters). This makes
10268 translation from UTF-8 to ISO-8859-1 straightforward.
10269
10270
10271 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10272 .cindex "hash function" "textual"
10273 .cindex "expansion" "textual hash"
10274 The &%hash%& operator is a simpler interface to the hashing function that can
10275 be used when the two parameters are fixed numbers (as opposed to strings that
10276 change when expanded). The effect is the same as
10277 .code
10278 ${hash{<n>}{<m>}{<string>}}
10279 .endd
10280 See the description of the general &%hash%& item above for details. The
10281 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10282
10283
10284
10285 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10286 .cindex "base64 encoding" "conversion from hex"
10287 .cindex "expansion" "hex to base64"
10288 .cindex "&%hex2b64%& expansion item"
10289 This operator converts a hex string into one that is base64 encoded. This can
10290 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10291
10292
10293
10294 .vitem &*${hexquote:*&<&'string'&>&*}*&
10295 .cindex "quoting" "hex-encoded unprintable characters"
10296 .cindex "&%hexquote%& expansion item"
10297 This operator converts non-printable characters in a string into a hex
10298 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10299 as is, and other byte values are converted to &`\xNN`&, for example a
10300 byte value 127 is converted to &`\x7f`&.
10301
10302
10303 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10304 .cindex "&%ipv6denorm%& expansion item"
10305 .cindex "IP address" normalisation
10306 This expands an IPv6 address to a full eight-element colon-separated set
10307 of hex digits including leading zeroes.
10308 A trailing ipv4-style dotted-decimal set is converted to hex.
10309 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10310
10311 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10312 .cindex "&%ipv6norm%& expansion item"
10313 .cindex "IP address" normalisation
10314 .cindex "IP address" "canonical form"
10315 This converts an IPv6 address to canonical form.
10316 Leading zeroes of groups are omitted, and the longest
10317 set of zero-valued groups is replaced with a double colon.
10318 A trailing ipv4-style dotted-decimal set is converted to hex.
10319 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10320
10321
10322 .vitem &*${lc:*&<&'string'&>&*}*&
10323 .cindex "case forcing in strings"
10324 .cindex "string" "case forcing"
10325 .cindex "lower casing"
10326 .cindex "expansion" "case forcing"
10327 .cindex "&%lc%& expansion item"
10328 This forces the letters in the string into lower-case, for example:
10329 .code
10330 ${lc:$local_part}
10331 .endd
10332
10333 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10334 .cindex "expansion" "string truncation"
10335 .cindex "&%length%& expansion item"
10336 The &%length%& operator is a simpler interface to the &%length%& function that
10337 can be used when the parameter is a fixed number (as opposed to a string that
10338 changes when expanded). The effect is the same as
10339 .code
10340 ${length{<number>}{<string>}}
10341 .endd
10342 See the description of the general &%length%& item above for details. Note that
10343 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10344 when &%length%& is used as an operator.
10345
10346
10347 .vitem &*${listcount:*&<&'string'&>&*}*&
10348 .cindex "expansion" "list item count"
10349 .cindex "list" "item count"
10350 .cindex "list" "count of items"
10351 .cindex "&%listcount%& expansion item"
10352 The string is interpreted as a list and the number of items is returned.
10353
10354
10355 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10356 .cindex "expansion" "named list"
10357 .cindex "&%listnamed%& expansion item"
10358 The name is interpreted as a named list and the content of the list is returned,
10359 expanding any referenced lists, re-quoting as needed for colon-separation.
10360 If the optional type is given it must be one of "a", "d", "h" or "l"
10361 and selects address-, domain-, host- or localpart- lists to search among respectively.
10362 Otherwise all types are searched in an undefined order and the first
10363 matching list is returned.
10364
10365
10366 .vitem &*${local_part:*&<&'string'&>&*}*&
10367 .cindex "expansion" "local part extraction"
10368 .cindex "&%local_part%& expansion item"
10369 The string is interpreted as an RFC 2822 address and the local part is
10370 extracted from it. If the string does not parse successfully, the result is
10371 empty.
10372
10373
10374 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10375 .cindex "masked IP address"
10376 .cindex "IP address" "masking"
10377 .cindex "CIDR notation"
10378 .cindex "expansion" "IP address masking"
10379 .cindex "&%mask%& expansion item"
10380 If the form of the string to be operated on is not an IP address followed by a
10381 slash and an integer (that is, a network address in CIDR notation), the
10382 expansion fails. Otherwise, this operator converts the IP address to binary,
10383 masks off the least significant bits according to the bit count, and converts
10384 the result back to text, with mask appended. For example,
10385 .code
10386 ${mask:10.111.131.206/28}
10387 .endd
10388 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10389 be mostly used for looking up masked addresses in files, the result for an IPv6
10390 address uses dots to separate components instead of colons, because colon
10391 terminates a key string in lsearch files. So, for example,
10392 .code
10393 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10394 .endd
10395 returns the string
10396 .code
10397 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10398 .endd
10399 Letters in IPv6 addresses are always output in lower case.
10400
10401
10402 .vitem &*${md5:*&<&'string'&>&*}*&
10403 .cindex "MD5 hash"
10404 .cindex "expansion" "MD5 hash"
10405 .cindex certificate fingerprint
10406 .cindex "&%md5%& expansion item"
10407 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10408 as a 32-digit hexadecimal number, in which any letters are in lower case.
10409
10410 If the string is a single variable of type certificate,
10411 returns the MD5 hash fingerprint of the certificate.
10412
10413
10414 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10415 .cindex "expansion" "numeric hash"
10416 .cindex "hash function" "numeric"
10417 The &%nhash%& operator is a simpler interface to the numeric hashing function
10418 that can be used when the two parameters are fixed numbers (as opposed to
10419 strings that change when expanded). The effect is the same as
10420 .code
10421 ${nhash{<n>}{<m>}{<string>}}
10422 .endd
10423 See the description of the general &%nhash%& item above for details.
10424
10425
10426 .vitem &*${quote:*&<&'string'&>&*}*&
10427 .cindex "quoting" "in string expansions"
10428 .cindex "expansion" "quoting"
10429 .cindex "&%quote%& expansion item"
10430 The &%quote%& operator puts its argument into double quotes if it
10431 is an empty string or
10432 contains anything other than letters, digits, underscores, dots, and hyphens.
10433 Any occurrences of double quotes and backslashes are escaped with a backslash.
10434 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10435 respectively For example,
10436 .code
10437 ${quote:ab"*"cd}
10438 .endd
10439 becomes
10440 .code
10441 "ab\"*\"cd"
10442 .endd
10443 The place where this is useful is when the argument is a substitution from a
10444 variable or a message header.
10445
10446 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10447 .cindex "&%quote_local_part%& expansion item"
10448 This operator is like &%quote%&, except that it quotes the string only if
10449 required to do so by the rules of RFC 2822 for quoting local parts. For
10450 example, a plus sign would not cause quoting (but it would for &%quote%&).
10451 If you are creating a new email address from the contents of &$local_part$&
10452 (or any other unknown data), you should always use this operator.
10453
10454
10455 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10456 .cindex "quoting" "lookup-specific"
10457 This operator applies lookup-specific quoting rules to the string. Each
10458 query-style lookup type has its own quoting rules which are described with
10459 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10460 .code
10461 ${quote_ldap:two * two}
10462 .endd
10463 returns
10464 .code
10465 two%20%5C2A%20two
10466 .endd
10467 For single-key lookup types, no quoting is ever necessary and this operator
10468 yields an unchanged string.
10469
10470
10471 .vitem &*${randint:*&<&'n'&>&*}*&
10472 .cindex "random number"
10473 This operator returns a somewhat random number which is less than the
10474 supplied number and is at least 0.  The quality of this randomness depends
10475 on how Exim was built; the values are not suitable for keying material.
10476 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10477 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10478 for versions of GnuTLS with that function.
10479 Otherwise, the implementation may be arc4random(), random() seeded by
10480 srandomdev() or srandom(), or a custom implementation even weaker than
10481 random().
10482
10483
10484 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10485 .cindex "expansion" "IP address"
10486 This operator reverses an IP address; for IPv4 addresses, the result is in
10487 dotted-quad decimal form, while for IPv6 addresses the result is in
10488 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10489 for DNS.  For example,
10490 .code
10491 ${reverse_ip:192.0.2.4}
10492 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10493 .endd
10494 returns
10495 .code
10496 4.2.0.192
10497 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
10498 .endd
10499
10500
10501 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10502 .cindex "expansion" "RFC 2047"
10503 .cindex "RFC 2047" "expansion operator"
10504 .cindex "&%rfc2047%& expansion item"
10505 This operator encodes text according to the rules of RFC 2047. This is an
10506 encoding that is used in header lines to encode non-ASCII characters. It is
10507 assumed that the input string is in the encoding specified by the
10508 &%headers_charset%& option, which gets its default at build time. If the string
10509 contains only characters in the range 33&--126, and no instances of the
10510 characters
10511 .code
10512 ? = ( ) < > @ , ; : \ " . [ ] _
10513 .endd
10514 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10515 string, using as many &"encoded words"& as necessary to encode all the
10516 characters.
10517
10518
10519 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10520 .cindex "expansion" "RFC 2047"
10521 .cindex "RFC 2047" "decoding"
10522 .cindex "&%rfc2047d%& expansion item"
10523 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10524 bytes are replaced by question marks. Characters are converted into the
10525 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10526 not recognized unless &%check_rfc2047_length%& is set false.
10527
10528 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10529 access a header line, RFC 2047 decoding is done automatically. You do not need
10530 to use this operator as well.
10531
10532
10533
10534 .vitem &*${rxquote:*&<&'string'&>&*}*&
10535 .cindex "quoting" "in regular expressions"
10536 .cindex "regular expressions" "quoting"
10537 .cindex "&%rxquote%& expansion item"
10538 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10539 characters in its argument. This is useful when substituting the values of
10540 variables or headers inside regular expressions.
10541
10542
10543 .vitem &*${sha1:*&<&'string'&>&*}*&
10544 .cindex "SHA-1 hash"
10545 .cindex "expansion" "SHA-1 hashing"
10546 .cindex certificate fingerprint
10547 .cindex "&%sha1%& expansion item"
10548 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10549 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10550
10551 If the string is a single variable of type certificate,
10552 returns the SHA-1 hash fingerprint of the certificate.
10553
10554
10555 .vitem &*${sha256:*&<&'string'&>&*}*&
10556 .cindex "SHA-256 hash"
10557 .cindex certificate fingerprint
10558 .cindex "expansion" "SHA-256 hashing"
10559 .cindex "&%sha256%& expansion item"
10560 .new
10561 The &%sha256%& operator computes the SHA-256 hash value of the string
10562 and returns
10563 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10564 .wen
10565
10566 If the string is a single variable of type certificate,
10567 returns the SHA-256 hash fingerprint of the certificate.
10568
10569
10570 .new
10571 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10572        &*${sha3_<n>:*&<&'string'&>&*}*&
10573 .cindex "SHA3 hash"
10574 .cindex "expansion" "SHA3 hashing"
10575 .cindex "&%sha3%& expansion item"
10576 The &%sha3%& operator computes the SHA3-256 hash value of the string
10577 and returns
10578 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10579
10580 If a number is appended, separated by an underbar, it specifies
10581 the output length.  Values of 224, 256, 384 and 512 are accepted;
10582 with 256 being the default.
10583
10584 The &%sha3%& expansion item is only supported if Exim has been
10585 compiled with GnuTLS 3.5.0 or later.
10586 .wen
10587
10588
10589 .vitem &*${stat:*&<&'string'&>&*}*&
10590 .cindex "expansion" "statting a file"
10591 .cindex "file" "extracting characteristics"
10592 .cindex "&%stat%& expansion item"
10593 The string, after expansion, must be a file path. A call to the &[stat()]&
10594 function is made for this path. If &[stat()]& fails, an error occurs and the
10595 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10596 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10597 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10598 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10599 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10600 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10601 can extract individual fields using the &%extract%& expansion item.
10602
10603 The use of the &%stat%& expansion in users' filter files can be locked out by
10604 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10605 systems for files larger than 2GB.
10606
10607 .vitem &*${str2b64:*&<&'string'&>&*}*&
10608 .cindex "&%str2b64%& expansion item"
10609 Now deprecated, a synonym for the &%base64%& expansion operator.
10610
10611
10612
10613 .vitem &*${strlen:*&<&'string'&>&*}*&
10614 .cindex "expansion" "string length"
10615 .cindex "string" "length in expansion"
10616 .cindex "&%strlen%& expansion item"
10617 The item is replace by the length of the expanded string, expressed as a
10618 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10619
10620
10621 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10622 .cindex "&%substr%& expansion item"
10623 .cindex "substring extraction"
10624 .cindex "expansion" "substring expansion"
10625 The &%substr%& operator is a simpler interface to the &%substr%& function that
10626 can be used when the two parameters are fixed numbers (as opposed to strings
10627 that change when expanded). The effect is the same as
10628 .code
10629 ${substr{<start>}{<length>}{<string>}}
10630 .endd
10631 See the description of the general &%substr%& item above for details. The
10632 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10633
10634 .vitem &*${time_eval:*&<&'string'&>&*}*&
10635 .cindex "&%time_eval%& expansion item"
10636 .cindex "time interval" "decoding"
10637 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10638 seconds.
10639
10640 .vitem &*${time_interval:*&<&'string'&>&*}*&
10641 .cindex "&%time_interval%& expansion item"
10642 .cindex "time interval" "formatting"
10643 The argument (after sub-expansion) must be a sequence of decimal digits that
10644 represents an interval of time as a number of seconds. It is converted into a
10645 number of larger units and output in Exim's normal time format, for example,
10646 &`1w3d4h2m6s`&.
10647
10648 .vitem &*${uc:*&<&'string'&>&*}*&
10649 .cindex "case forcing in strings"
10650 .cindex "string" "case forcing"
10651 .cindex "upper casing"
10652 .cindex "expansion" "case forcing"
10653 .cindex "&%uc%& expansion item"
10654 This forces the letters in the string into upper-case.
10655
10656 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10657 .cindex "correction of invalid utf-8 sequences in strings"
10658 .cindex "utf-8" "utf-8 sequences"
10659 .cindex "incorrect utf-8"
10660 .cindex "expansion" "utf-8 forcing"
10661 .cindex "&%utf8clean%& expansion item"
10662 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10663
10664 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10665        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10666        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10667        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10668 .cindex expansion UTF-8
10669 .cindex UTF-8 expansion
10670 .cindex EAI
10671 .cindex internationalisation
10672 .cindex "&%utf8_domain_to_alabel%& expansion item"
10673 .cindex "&%utf8_domain_from_alabel%& expansion item"
10674 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10675 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10676 These convert EAI mail name components between UTF-8 and a-label forms.
10677 For information on internationalisation support see &<<SECTi18nMTA>>&.
10678 .endlist
10679
10680
10681
10682
10683
10684
10685 .section "Expansion conditions" "SECTexpcond"
10686 .scindex IIDexpcond "expansion" "conditions"
10687 The following conditions are available for testing by the &%${if%& construct
10688 while expanding strings:
10689
10690 .vlist
10691 .vitem &*!*&<&'condition'&>
10692 .cindex "expansion" "negating a condition"
10693 .cindex "negation" "in expansion condition"
10694 Preceding any condition with an exclamation mark negates the result of the
10695 condition.
10696
10697 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10698 .cindex "numeric comparison"
10699 .cindex "expansion" "numeric comparison"
10700 There are a number of symbolic operators for doing numeric comparisons. They
10701 are:
10702 .display
10703 &`=   `&   equal
10704 &`==  `&   equal
10705 &`>   `&   greater
10706 &`>=  `&   greater or equal
10707 &`<   `&   less
10708 &`<=  `&   less or equal
10709 .endd
10710 For example:
10711 .code
10712 ${if >{$message_size}{10M} ...
10713 .endd
10714 Note that the general negation operator provides for inequality testing. The
10715 two strings must take the form of optionally signed decimal integers,
10716 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10717 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10718 As a special case, the numerical value of an empty string is taken as
10719 zero.
10720
10721 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10722 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10723 10M, not if 10M is larger than &$message_size$&.
10724
10725
10726 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10727         {*&<&'arg2'&>&*}...}*&
10728 .cindex "expansion" "calling an acl"
10729 .cindex "&%acl%&" "expansion condition"
10730 The name and zero to nine argument strings are first expanded separately.  The expanded
10731 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10732 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10733 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10734 and may use the variables; if another acl expansion is used the values
10735 are restored after it returns.  If the ACL sets
10736 a value using a "message =" modifier the variable $value becomes
10737 the result of the expansion, otherwise it is empty.
10738 If the ACL returns accept the condition is true; if deny, false.
10739 If the ACL returns defer the result is a forced-fail.
10740
10741 .vitem &*bool&~{*&<&'string'&>&*}*&
10742 .cindex "expansion" "boolean parsing"
10743 .cindex "&%bool%& expansion condition"
10744 This condition turns a string holding a true or false representation into
10745 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10746 (case-insensitively); also integer numbers map to true if non-zero,
10747 false if zero.
10748 An empty string is treated as false.
10749 Leading and trailing whitespace is ignored;
10750 thus a string consisting only of whitespace is false.
10751 All other string values will result in expansion failure.
10752
10753 When combined with ACL variables, this expansion condition will let you
10754 make decisions in one place and act on those decisions in another place.
10755 For example:
10756 .code
10757 ${if bool{$acl_m_privileged_sender} ...
10758 .endd
10759
10760
10761 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10762 .cindex "expansion" "boolean parsing"
10763 .cindex "&%bool_lax%& expansion condition"
10764 Like &%bool%&, this condition turns a string into a boolean state.  But
10765 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10766 loose definition that the Router &%condition%& option uses.  The empty string
10767 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10768 true.  Leading and trailing whitespace is ignored.
10769
10770 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10771
10772 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10773 .cindex "expansion" "encrypted comparison"
10774 .cindex "encrypted strings, comparing"
10775 .cindex "&%crypteq%& expansion condition"
10776 This condition is included in the Exim binary if it is built to support any
10777 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10778 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10779 included in the binary.
10780
10781 The &%crypteq%& condition has two arguments. The first is encrypted and
10782 compared against the second, which is already encrypted. The second string may
10783 be in the LDAP form for storing encrypted strings, which starts with the
10784 encryption type in curly brackets, followed by the data. If the second string
10785 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10786 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10787 Typically this will be a field from a password file. An example of an encrypted
10788 string in LDAP form is:
10789 .code
10790 {md5}CY9rzUYh03PK3k6DJie09g==
10791 .endd
10792 If such a string appears directly in an expansion, the curly brackets have to
10793 be quoted, because they are part of the expansion syntax. For example:
10794 .code
10795 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10796 .endd
10797 The following encryption types (whose names are matched case-independently) are
10798 supported:
10799
10800 .ilist
10801 .cindex "MD5 hash"
10802 .cindex "base64 encoding" "in encrypted password"
10803 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10804 printable characters to compare with the remainder of the second string. If the
10805 length of the comparison string is 24, Exim assumes that it is base64 encoded
10806 (as in the above example). If the length is 32, Exim assumes that it is a
10807 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10808 comparison fails.
10809
10810 .next
10811 .cindex "SHA-1 hash"
10812 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10813 printable characters to compare with the remainder of the second string. If the
10814 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10815 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10816 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10817
10818 .next
10819 .cindex "&[crypt()]&"
10820 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10821 only the first eight characters of the password. However, in modern operating
10822 systems this is no longer true, and in many cases the entire password is used,
10823 whatever its length.
10824
10825 .next
10826 .cindex "&[crypt16()]&"
10827 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10828 use up to 16 characters of the password in some operating systems. Again, in
10829 modern operating systems, more characters may be used.
10830 .endlist
10831 Exim has its own version of &[crypt16()]&, which is just a double call to
10832 &[crypt()]&. For operating systems that have their own version, setting
10833 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10834 operating system version instead of its own. This option is set by default in
10835 the OS-dependent &_Makefile_& for those operating systems that are known to
10836 support &[crypt16()]&.
10837
10838 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10839 it was not using the same algorithm as some operating systems' versions. It
10840 turns out that as well as &[crypt16()]& there is a function called
10841 &[bigcrypt()]& in some operating systems. This may or may not use the same
10842 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10843
10844 However, since there is now a move away from the traditional &[crypt()]&
10845 functions towards using SHA1 and other algorithms, tidying up this area of
10846 Exim is seen as very low priority.
10847
10848 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10849 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10850 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10851 default is &`{crypt}`&. Whatever the default, you can always use either
10852 function by specifying it explicitly in curly brackets.
10853
10854 .vitem &*def:*&<&'variable&~name'&>
10855 .cindex "expansion" "checking for empty variable"
10856 .cindex "&%def%& expansion condition"
10857 The &%def%& condition must be followed by the name of one of the expansion
10858 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10859 variable does not contain the empty string. For example:
10860 .code
10861 ${if def:sender_ident {from $sender_ident}}
10862 .endd
10863 Note that the variable name is given without a leading &%$%& character. If the
10864 variable does not exist, the expansion fails.
10865
10866 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10867         &~&*def:h_*&<&'header&~name'&>&*:*&"
10868 .cindex "expansion" "checking header line existence"
10869 This condition is true if a message is being processed and the named header
10870 exists in the message. For example,
10871 .code
10872 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10873 .endd
10874 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10875 the header name must be terminated by a colon if white space does not follow.
10876
10877 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10878        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10879 .cindex "string" "comparison"
10880 .cindex "expansion" "string comparison"
10881 .cindex "&%eq%& expansion condition"
10882 .cindex "&%eqi%& expansion condition"
10883 The two substrings are first expanded. The condition is true if the two
10884 resulting strings are identical. For &%eq%& the comparison includes the case of
10885 letters, whereas for &%eqi%& the comparison is case-independent.
10886
10887 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10888 .cindex "expansion" "file existence test"
10889 .cindex "file" "existence test"
10890 .cindex "&%exists%&, expansion condition"
10891 The substring is first expanded and then interpreted as an absolute path. The
10892 condition is true if the named file (or directory) exists. The existence test
10893 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10894 users' filter files may be locked out by the system administrator.
10895
10896 .vitem &*first_delivery*&
10897 .cindex "delivery" "first"
10898 .cindex "first delivery"
10899 .cindex "expansion" "first delivery test"
10900 .cindex "&%first_delivery%& expansion condition"
10901 This condition, which has no data, is true during a message's first delivery
10902 attempt. It is false during any subsequent delivery attempts.
10903
10904
10905 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10906        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10907 .cindex "list" "iterative conditions"
10908 .cindex "expansion" "&*forall*& condition"
10909 .cindex "expansion" "&*forany*& condition"
10910 .vindex "&$item$&"
10911 These conditions iterate over a list. The first argument is expanded to form
10912 the list. By default, the list separator is a colon, but it can be changed by
10913 the normal method. The second argument is interpreted as a condition that is to
10914 be applied to each item in the list in turn. During the interpretation of the
10915 condition, the current list item is placed in a variable called &$item$&.
10916 .ilist
10917 For &*forany*&, interpretation stops if the condition is true for any item, and
10918 the result of the whole condition is true. If the condition is false for all
10919 items in the list, the overall condition is false.
10920 .next
10921 For &*forall*&, interpretation stops if the condition is false for any item,
10922 and the result of the whole condition is false. If the condition is true for
10923 all items in the list, the overall condition is true.
10924 .endlist
10925 Note that negation of &*forany*& means that the condition must be false for all
10926 items for the overall condition to succeed, and negation of &*forall*& means
10927 that the condition must be false for at least one item. In this example, the
10928 list separator is changed to a comma:
10929 .code
10930 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10931 .endd
10932 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10933 being processed, to enable these expansion items to be nested.
10934
10935 To scan a named list, expand it with the &*listnamed*& operator.
10936
10937
10938 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10939        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10940 .cindex "string" "comparison"
10941 .cindex "expansion" "string comparison"
10942 .cindex "&%ge%& expansion condition"
10943 .cindex "&%gei%& expansion condition"
10944 The two substrings are first expanded. The condition is true if the first
10945 string is lexically greater than or equal to the second string. For &%ge%& the
10946 comparison includes the case of letters, whereas for &%gei%& the comparison is
10947 case-independent.
10948
10949 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10950        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10951 .cindex "string" "comparison"
10952 .cindex "expansion" "string comparison"
10953 .cindex "&%gt%& expansion condition"
10954 .cindex "&%gti%& expansion condition"
10955 The two substrings are first expanded. The condition is true if the first
10956 string is lexically greater than the second string. For &%gt%& the comparison
10957 includes the case of letters, whereas for &%gti%& the comparison is
10958 case-independent.
10959
10960 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10961        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10962 .cindex "string" "comparison"
10963 .cindex "list" "iterative conditions"
10964 Both strings are expanded; the second string is treated as a list of simple
10965 strings; if the first string is a member of the second, then the condition
10966 is true.
10967
10968 These are simpler to use versions of the more powerful &*forany*& condition.
10969 Examples, and the &*forany*& equivalents:
10970 .code
10971 ${if inlist{needle}{foo:needle:bar}}
10972   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10973 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10974   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10975 .endd
10976
10977 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10978        &*isip4&~{*&<&'string'&>&*}*& &&&
10979        &*isip6&~{*&<&'string'&>&*}*&
10980 .cindex "IP address" "testing string format"
10981 .cindex "string" "testing for IP address"
10982 .cindex "&%isip%& expansion condition"
10983 .cindex "&%isip4%& expansion condition"
10984 .cindex "&%isip6%& expansion condition"
10985 The substring is first expanded, and then tested to see if it has the form of
10986 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10987 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10988
10989 For an IPv4 address, the test is for four dot-separated components, each of
10990 which consists of from one to three digits. For an IPv6 address, up to eight
10991 colon-separated components are permitted, each containing from one to four
10992 hexadecimal digits. There may be fewer than eight components if an empty
10993 component (adjacent colons) is present. Only one empty component is permitted.
10994
10995 &*Note*&: The checks are just on the form of the address; actual numerical
10996 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10997 check. The main use of these tests is to distinguish between IP addresses and
10998 host names, or between IPv4 and IPv6 addresses. For example, you could use
10999 .code
11000 ${if isip4{$sender_host_address}...
11001 .endd
11002 to test which IP version an incoming SMTP connection is using.
11003
11004 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11005 .cindex "LDAP" "use for authentication"
11006 .cindex "expansion" "LDAP authentication test"
11007 .cindex "&%ldapauth%& expansion condition"
11008 This condition supports user authentication using LDAP. See section
11009 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11010 queries. For this use, the query must contain a user name and password. The
11011 query itself is not used, and can be empty. The condition is true if the
11012 password is not empty, and the user name and password are accepted by the LDAP
11013 server. An empty password is rejected without calling LDAP because LDAP binds
11014 with an empty password are considered anonymous regardless of the username, and
11015 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11016 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11017 this can be used.
11018
11019
11020 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11021        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11022 .cindex "string" "comparison"
11023 .cindex "expansion" "string comparison"
11024 .cindex "&%le%& expansion condition"
11025 .cindex "&%lei%& expansion condition"
11026 The two substrings are first expanded. The condition is true if the first
11027 string is lexically less than or equal to the second string. For &%le%& the
11028 comparison includes the case of letters, whereas for &%lei%& the comparison is
11029 case-independent.
11030
11031 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11032        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11033 .cindex "string" "comparison"
11034 .cindex "expansion" "string comparison"
11035 .cindex "&%lt%& expansion condition"
11036 .cindex "&%lti%& expansion condition"
11037 The two substrings are first expanded. The condition is true if the first
11038 string is lexically less than the second string. For &%lt%& the comparison
11039 includes the case of letters, whereas for &%lti%& the comparison is
11040 case-independent.
11041
11042
11043 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11044 .cindex "expansion" "regular expression comparison"
11045 .cindex "regular expressions" "match in expanded string"
11046 .cindex "&%match%& expansion condition"
11047 The two substrings are first expanded. The second is then treated as a regular
11048 expression and applied to the first. Because of the pre-expansion, if the
11049 regular expression contains dollar, or backslash characters, they must be
11050 escaped. Care must also be taken if the regular expression contains braces
11051 (curly brackets). A closing brace must be escaped so that it is not taken as a
11052 premature termination of <&'string2'&>. The easiest approach is to use the
11053 &`\N`& feature to disable expansion of the regular expression.
11054 For example,
11055 .code
11056 ${if match {$local_part}{\N^\d{3}\N} ...
11057 .endd
11058 If the whole expansion string is in double quotes, further escaping of
11059 backslashes is also required.
11060
11061 The condition is true if the regular expression match succeeds.
11062 The regular expression is not required to begin with a circumflex
11063 metacharacter, but if there is no circumflex, the expression is not anchored,
11064 and it may match anywhere in the subject, not just at the start. If you want
11065 the pattern to match at the end of the subject, you must include the &`$`&
11066 metacharacter at an appropriate point.
11067
11068 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11069 At the start of an &%if%& expansion the values of the numeric variable
11070 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11071 succeeds causes them to be reset to the substrings of that condition and they
11072 will have these values during the expansion of the success string. At the end
11073 of the &%if%& expansion, the previous values are restored. After testing a
11074 combination of conditions using &%or%&, the subsequent values of the numeric
11075 variables are those of the condition that succeeded.
11076
11077 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11078 .cindex "&%match_address%& expansion condition"
11079 See &*match_local_part*&.
11080
11081 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11082 .cindex "&%match_domain%& expansion condition"
11083 See &*match_local_part*&.
11084
11085 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11086 .cindex "&%match_ip%& expansion condition"
11087 This condition matches an IP address to a list of IP address patterns. It must
11088 be followed by two argument strings. The first (after expansion) must be an IP
11089 address or an empty string. The second (not expanded) is a restricted host
11090 list that can match only an IP address, not a host name. For example:
11091 .code
11092 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11093 .endd
11094 The specific types of host list item that are permitted in the list are:
11095
11096 .ilist
11097 An IP address, optionally with a CIDR mask.
11098 .next
11099 A single asterisk, which matches any IP address.
11100 .next
11101 An empty item, which matches only if the IP address is empty. This could be
11102 useful for testing for a locally submitted message or one from specific hosts
11103 in a single test such as
11104 . ==== As this is a nested list, any displays it contains must be indented
11105 . ==== as otherwise they are too far to the left. This comment applies to
11106 . ==== the use of xmlto plus fop. There's no problem when formatting with
11107 . ==== sdop, with or without the extra indent.
11108 .code
11109   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11110 .endd
11111 where the first item in the list is the empty string.
11112 .next
11113 The item @[] matches any of the local host's interface addresses.
11114 .next
11115 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11116 even if &`net-`& is not specified. There is never any attempt to turn the IP
11117 address into a host name. The most common type of linear search for
11118 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11119 masks. For example:
11120 .code
11121   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11122 .endd
11123 It is of course possible to use other kinds of lookup, and in such a case, you
11124 do need to specify the &`net-`& prefix if you want to specify a specific
11125 address mask, for example:
11126 .code
11127   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11128 .endd
11129 However, unless you are combining a &%match_ip%& condition with others, it is
11130 just as easy to use the fact that a lookup is itself a condition, and write:
11131 .code
11132   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11133 .endd
11134 .endlist ilist
11135
11136 Note that <&'string2'&> is not itself subject to string expansion, unless
11137 Exim was built with the EXPAND_LISTMATCH_RHS option.
11138
11139 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11140
11141 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11142 .cindex "domain list" "in expansion condition"
11143 .cindex "address list" "in expansion condition"
11144 .cindex "local part" "list, in expansion condition"
11145 .cindex "&%match_local_part%& expansion condition"
11146 This condition, together with &%match_address%& and &%match_domain%&, make it
11147 possible to test domain, address, and local part lists within expansions. Each
11148 condition requires two arguments: an item and a list to match. A trivial
11149 example is:
11150 .code
11151 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11152 .endd
11153 In each case, the second argument may contain any of the allowable items for a
11154 list of the appropriate type. Also, because the second argument (after
11155 expansion) is a standard form of list, it is possible to refer to a named list.
11156 Thus, you can use conditions like this:
11157 .code
11158 ${if match_domain{$domain}{+local_domains}{...
11159 .endd
11160 .cindex "&`+caseful`&"
11161 For address lists, the matching starts off caselessly, but the &`+caseful`&
11162 item can be used, as in all address lists, to cause subsequent items to
11163 have their local parts matched casefully. Domains are always matched
11164 caselessly.
11165
11166 Note that <&'string2'&> is not itself subject to string expansion, unless
11167 Exim was built with the EXPAND_LISTMATCH_RHS option.
11168
11169 &*Note*&: Host lists are &'not'& supported in this way. This is because
11170 hosts have two identities: a name and an IP address, and it is not clear
11171 how to specify cleanly how such a test would work. However, IP addresses can be
11172 matched using &%match_ip%&.
11173
11174 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11175 .cindex "PAM authentication"
11176 .cindex "AUTH" "with PAM"
11177 .cindex "Solaris" "PAM support"
11178 .cindex "expansion" "PAM authentication test"
11179 .cindex "&%pam%& expansion condition"
11180 &'Pluggable Authentication Modules'&
11181 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11182 available in the latest releases of Solaris and in some GNU/Linux
11183 distributions. The Exim support, which is intended for use in conjunction with
11184 the SMTP AUTH command, is available only if Exim is compiled with
11185 .code
11186 SUPPORT_PAM=yes
11187 .endd
11188 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11189 in some releases of GNU/Linux &%-ldl%& is also needed.
11190
11191 The argument string is first expanded, and the result must be a
11192 colon-separated list of strings. Leading and trailing white space is ignored.
11193 The PAM module is initialized with the service name &"exim"& and the user name
11194 taken from the first item in the colon-separated data string (<&'string1'&>).
11195 The remaining items in the data string are passed over in response to requests
11196 from the authentication function. In the simple case there will only be one
11197 request, for a password, so the data consists of just two strings.
11198
11199 There can be problems if any of the strings are permitted to contain colon
11200 characters. In the usual way, these have to be doubled to avoid being taken as
11201 separators. If the data is being inserted from a variable, the &%sg%& expansion
11202 item can be used to double any existing colons. For example, the configuration
11203 of a LOGIN authenticator might contain this setting:
11204 .code
11205 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11206 .endd
11207 For a PLAIN authenticator you could use:
11208 .code
11209 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11210 .endd
11211 In some operating systems, PAM authentication can be done only from a process
11212 running as root. Since Exim is running as the Exim user when receiving
11213 messages, this means that PAM cannot be used directly in those systems.
11214 A patched version of the &'pam_unix'& module that comes with the
11215 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11216 The patched module allows one special uid/gid combination, in addition to root,
11217 to authenticate. If you build the patched module to allow the Exim user and
11218 group, PAM can then be used from an Exim authenticator.
11219
11220
11221 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11222 .cindex "&'pwcheck'& daemon"
11223 .cindex "Cyrus"
11224 .cindex "expansion" "&'pwcheck'& authentication test"
11225 .cindex "&%pwcheck%& expansion condition"
11226 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11227 This is one way of making it possible for passwords to be checked by a process
11228 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11229 deprecated. Its replacement is &'saslauthd'& (see below).
11230
11231 The pwcheck support is not included in Exim by default. You need to specify
11232 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11233 building Exim. For example:
11234 .code
11235 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11236 .endd
11237 You do not need to install the full Cyrus software suite in order to use
11238 the pwcheck daemon. You can compile and install just the daemon alone
11239 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11240 access to the &_/var/pwcheck_& directory.
11241
11242 The &%pwcheck%& condition takes one argument, which must be the user name and
11243 password, separated by a colon. For example, in a LOGIN authenticator
11244 configuration, you might have this:
11245 .code
11246 server_condition = ${if pwcheck{$auth1:$auth2}}
11247 .endd
11248 Again, for a PLAIN authenticator configuration, this would be:
11249 .code
11250 server_condition = ${if pwcheck{$auth2:$auth3}}
11251 .endd
11252 .vitem &*queue_running*&
11253 .cindex "queue runner" "detecting when delivering from"
11254 .cindex "expansion" "queue runner test"
11255 .cindex "&%queue_running%& expansion condition"
11256 This condition, which has no data, is true during delivery attempts that are
11257 initiated by queue runner processes, and false otherwise.
11258
11259
11260 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11261 .cindex "Radius"
11262 .cindex "expansion" "Radius authentication"
11263 .cindex "&%radius%& expansion condition"
11264 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11265 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11266 the Radius client configuration file in order to build Exim with Radius
11267 support.
11268
11269 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11270 library, using the original API. If you are using release 0.4.0 or later of
11271 this library, you need to set
11272 .code
11273 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11274 .endd
11275 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11276 &%libradius%& library that comes with FreeBSD. To do this, set
11277 .code
11278 RADIUS_LIB_TYPE=RADLIB
11279 .endd
11280 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11281 You may also have to supply a suitable setting in EXTRALIBS so that the
11282 Radius library can be found when Exim is linked.
11283
11284 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11285 Radius client library, which calls the Radius server. The condition is true if
11286 the authentication is successful. For example:
11287 .code
11288 server_condition = ${if radius{<arguments>}}
11289 .endd
11290
11291
11292 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11293         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11294 .cindex "&'saslauthd'& daemon"
11295 .cindex "Cyrus"
11296 .cindex "expansion" "&'saslauthd'& authentication test"
11297 .cindex "&%saslauthd%& expansion condition"
11298 This condition supports user authentication using the Cyrus &'saslauthd'&
11299 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11300 Using this daemon is one way of making it possible for passwords to be checked
11301 by a process that is not running as root.
11302
11303 The saslauthd support is not included in Exim by default. You need to specify
11304 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11305 building Exim. For example:
11306 .code
11307 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11308 .endd
11309 You do not need to install the full Cyrus software suite in order to use
11310 the saslauthd daemon. You can compile and install just the daemon alone
11311 from the Cyrus SASL library.
11312
11313 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11314 two are mandatory. For example:
11315 .code
11316 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11317 .endd
11318 The service and the realm are optional (which is why the arguments are enclosed
11319 in their own set of braces). For details of the meaning of the service and
11320 realm, and how to run the daemon, consult the Cyrus documentation.
11321 .endlist vlist
11322
11323
11324
11325 .section "Combining expansion conditions" "SECID84"
11326 .cindex "expansion" "combining conditions"
11327 Several conditions can be tested at once by combining them using the &%and%&
11328 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11329 conditions on their own, and precede their lists of sub-conditions. Each
11330 sub-condition must be enclosed in braces within the overall braces that contain
11331 the list. No repetition of &%if%& is used.
11332
11333
11334 .vlist
11335 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11336 .cindex "&""or""& expansion condition"
11337 .cindex "expansion" "&""or""& of conditions"
11338 The sub-conditions are evaluated from left to right. The condition is true if
11339 any one of the sub-conditions is true.
11340 For example,
11341 .code
11342 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11343 .endd
11344 When a true sub-condition is found, the following ones are parsed but not
11345 evaluated. If there are several &"match"& sub-conditions the values of the
11346 numeric variables afterwards are taken from the first one that succeeds.
11347
11348 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11349 .cindex "&""and""& expansion condition"
11350 .cindex "expansion" "&""and""& of conditions"
11351 The sub-conditions are evaluated from left to right. The condition is true if
11352 all of the sub-conditions are true. If there are several &"match"&
11353 sub-conditions, the values of the numeric variables afterwards are taken from
11354 the last one. When a false sub-condition is found, the following ones are
11355 parsed but not evaluated.
11356 .endlist
11357 .ecindex IIDexpcond
11358
11359
11360
11361
11362 .section "Expansion variables" "SECTexpvar"
11363 .cindex "expansion" "variables, list of"
11364 This section contains an alphabetical list of all the expansion variables. Some
11365 of them are available only when Exim is compiled with specific options such as
11366 support for TLS or the content scanning extension.
11367
11368 .vlist
11369 .vitem "&$0$&, &$1$&, etc"
11370 .cindex "numerical variables (&$1$& &$2$& etc)"
11371 When a &%match%& expansion condition succeeds, these variables contain the
11372 captured substrings identified by the regular expression during subsequent
11373 processing of the success string of the containing &%if%& expansion item.
11374 In the expansion condition case
11375 they do not retain their values afterwards; in fact, their previous
11376 values are restored at the end of processing an &%if%& item. The numerical
11377 variables may also be set externally by some other matching process which
11378 precedes the expansion of the string. For example, the commands available in
11379 Exim filter files include an &%if%& command with its own regular expression
11380 matching condition.
11381
11382 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11383 Within an acl condition, expansion condition or expansion item
11384 any arguments are copied to these variables,
11385 any unused variables being made empty.
11386
11387 .vitem "&$acl_c...$&"
11388 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11389 can be given any name that starts with &$acl_c$& and is at least six characters
11390 long, but the sixth character must be either a digit or an underscore. For
11391 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11392 variables persist throughout the lifetime of an SMTP connection. They can be
11393 used to pass information between ACLs and between different invocations of the
11394 same ACL. When a message is received, the values of these variables are saved
11395 with the message, and can be accessed by filters, routers, and transports
11396 during subsequent delivery.
11397
11398 .vitem "&$acl_m...$&"
11399 These variables are like the &$acl_c...$& variables, except that their values
11400 are reset after a message has been received. Thus, if several messages are
11401 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11402 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11403 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11404 message is received, the values of these variables are saved with the message,
11405 and can be accessed by filters, routers, and transports during subsequent
11406 delivery.
11407
11408 .vitem &$acl_narg$&
11409 Within an acl condition, expansion condition or expansion item
11410 this variable has the number of arguments.
11411
11412 .vitem &$acl_verify_message$&
11413 .vindex "&$acl_verify_message$&"
11414 After an address verification has failed, this variable contains the failure
11415 message. It retains its value for use in subsequent modifiers. The message can
11416 be preserved by coding like this:
11417 .code
11418 warn !verify = sender
11419      set acl_m0 = $acl_verify_message
11420 .endd
11421 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11422 &%log_message%& modifiers, to include information about the verification
11423 failure.
11424
11425 .vitem &$address_data$&
11426 .vindex "&$address_data$&"
11427 This variable is set by means of the &%address_data%& option in routers. The
11428 value then remains with the address while it is processed by subsequent routers
11429 and eventually a transport. If the transport is handling multiple addresses,
11430 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11431 for more details. &*Note*&: The contents of &$address_data$& are visible in
11432 user filter files.
11433
11434 If &$address_data$& is set when the routers are called from an ACL to verify
11435 a recipient address, the final value is still in the variable for subsequent
11436 conditions and modifiers of the ACL statement. If routing the address caused it
11437 to be redirected to just one address, the child address is also routed as part
11438 of the verification, and in this case the final value of &$address_data$& is
11439 from the child's routing.
11440
11441 If &$address_data$& is set when the routers are called from an ACL to verify a
11442 sender address, the final value is also preserved, but this time in
11443 &$sender_address_data$&, to distinguish it from data from a recipient
11444 address.
11445
11446 In both cases (recipient and sender verification), the value does not persist
11447 after the end of the current ACL statement. If you want to preserve
11448 these values for longer, you can save them in ACL variables.
11449
11450 .vitem &$address_file$&
11451 .vindex "&$address_file$&"
11452 When, as a result of aliasing, forwarding, or filtering, a message is directed
11453 to a specific file, this variable holds the name of the file when the transport
11454 is running. At other times, the variable is empty. For example, using the
11455 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11456 .code
11457 /home/r2d2/savemail
11458 .endd
11459 then when the &(address_file)& transport is running, &$address_file$&
11460 contains the text string &`/home/r2d2/savemail`&.
11461 .cindex "Sieve filter" "value of &$address_file$&"
11462 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11463 then up to the transport configuration to generate an appropriate absolute path
11464 to the relevant file.
11465
11466 .vitem &$address_pipe$&
11467 .vindex "&$address_pipe$&"
11468 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11469 this variable holds the pipe command when the transport is running.
11470
11471 .vitem "&$auth1$& &-- &$auth3$&"
11472 .vindex "&$auth1$&, &$auth2$&, etc"
11473 These variables are used in SMTP authenticators (see chapters
11474 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11475
11476 .vitem &$authenticated_id$&
11477 .cindex "authentication" "id"
11478 .vindex "&$authenticated_id$&"
11479 When a server successfully authenticates a client it may be configured to
11480 preserve some of the authentication information in the variable
11481 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11482 user/password authenticator configuration might preserve the user name for use
11483 in the routers. Note that this is not the same information that is saved in
11484 &$sender_host_authenticated$&.
11485 When a message is submitted locally (that is, not over a TCP connection)
11486 the value of &$authenticated_id$& is normally the login name of the calling
11487 process. However, a trusted user can override this by means of the &%-oMai%&
11488 command line option.
11489
11490 .vitem &$authenticated_fail_id$&
11491 .cindex "authentication" "fail" "id"
11492 .vindex "&$authenticated_fail_id$&"
11493 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11494 will contain the failed authentication id. If more than one authentication
11495 id is attempted, it will contain only the last one. The variable is
11496 available for processing in the ACL's, generally the quit or notquit ACL.
11497 A message to a local recipient could still be accepted without requiring
11498 authentication, which means this variable could also be visible in all of
11499 the ACL's as well.
11500
11501
11502 .vitem &$authenticated_sender$&
11503 .cindex "sender" "authenticated"
11504 .cindex "authentication" "sender"
11505 .cindex "AUTH" "on MAIL command"
11506 .vindex "&$authenticated_sender$&"
11507 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11508 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11509 described in section &<<SECTauthparamail>>&. Unless the data is the string
11510 &"<>"&, it is set as the authenticated sender of the message, and the value is
11511 available during delivery in the &$authenticated_sender$& variable. If the
11512 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11513
11514 .vindex "&$qualify_domain$&"
11515 When a message is submitted locally (that is, not over a TCP connection), the
11516 value of &$authenticated_sender$& is an address constructed from the login
11517 name of the calling process and &$qualify_domain$&, except that a trusted user
11518 can override this by means of the &%-oMas%& command line option.
11519
11520
11521 .vitem &$authentication_failed$&
11522 .cindex "authentication" "failure"
11523 .vindex "&$authentication_failed$&"
11524 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11525 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11526 possible to distinguish between &"did not try to authenticate"&
11527 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11528 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11529 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11530 negative response to an AUTH command, including (for example) an attempt to use
11531 an undefined mechanism.
11532
11533 .vitem &$av_failed$&
11534 .cindex "content scanning" "AV scanner failure"
11535 This variable is available when Exim is compiled with the content-scanning
11536 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11537 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11538 the ACL malware condition.
11539
11540 .vitem &$body_linecount$&
11541 .cindex "message body" "line count"
11542 .cindex "body of message" "line count"
11543 .vindex "&$body_linecount$&"
11544 When a message is being received or delivered, this variable contains the
11545 number of lines in the message's body. See also &$message_linecount$&.
11546
11547 .vitem &$body_zerocount$&
11548 .cindex "message body" "binary zero count"
11549 .cindex "body of message" "binary zero count"
11550 .cindex "binary zero" "in message body"
11551 .vindex "&$body_zerocount$&"
11552 When a message is being received or delivered, this variable contains the
11553 number of binary zero bytes (ASCII NULs) in the message's body.
11554
11555 .vitem &$bounce_recipient$&
11556 .vindex "&$bounce_recipient$&"
11557 This is set to the recipient address of a bounce message while Exim is creating
11558 it. It is useful if a customized bounce message text file is in use (see
11559 chapter &<<CHAPemsgcust>>&).
11560
11561 .vitem &$bounce_return_size_limit$&
11562 .vindex "&$bounce_return_size_limit$&"
11563 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11564 up to a multiple of 1000. It is useful when a customized error message text
11565 file is in use (see chapter &<<CHAPemsgcust>>&).
11566
11567 .vitem &$caller_gid$&
11568 .cindex "gid (group id)" "caller"
11569 .vindex "&$caller_gid$&"
11570 The real group id under which the process that called Exim was running. This is
11571 not the same as the group id of the originator of a message (see
11572 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11573 incarnation normally contains the Exim gid.
11574
11575 .vitem &$caller_uid$&
11576 .cindex "uid (user id)" "caller"
11577 .vindex "&$caller_uid$&"
11578 The real user id under which the process that called Exim was running. This is
11579 not the same as the user id of the originator of a message (see
11580 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11581 incarnation normally contains the Exim uid.
11582
11583 .vitem &$callout_address$&
11584 .vindex "&$callout_address$&"
11585 After a callout for verification, spamd or malware daemon service, the
11586 address that was connected to.
11587
11588 .vitem &$compile_number$&
11589 .vindex "&$compile_number$&"
11590 The building process for Exim keeps a count of the number
11591 of times it has been compiled. This serves to distinguish different
11592 compilations of the same version of the program.
11593
11594 .vitem &$config_dir$&
11595 .vindex "&$config_dir$&"
11596 The directory name of the main configuration file. That is, the content of
11597 &$config_file$& with the last component stripped. The value does not
11598 contain the trailing slash. If &$config_file$& does not contain a slash,
11599 &$config_dir$& is ".".
11600
11601 .vitem &$config_file$&
11602 .vindex "&$config_file$&"
11603 The name of the main configuration file Exim is using.
11604
11605 .vitem &$dkim_cur_signer$& &&&
11606        &$dkim_verify_status$& &&&
11607        &$dkim_verify_reason$& &&&
11608        &$dkim_domain$& &&&
11609        &$dkim_identity$& &&&
11610        &$dkim_selector$& &&&
11611        &$dkim_algo$& &&&
11612        &$dkim_canon_body$& &&&
11613        &$dkim_canon_headers$& &&&
11614        &$dkim_copiedheaders$& &&&
11615        &$dkim_bodylength$& &&&
11616        &$dkim_created$& &&&
11617        &$dkim_expires$& &&&
11618        &$dkim_headernames$& &&&
11619        &$dkim_key_testing$& &&&
11620        &$dkim_key_nosubdomains$& &&&
11621        &$dkim_key_srvtype$& &&&
11622        &$dkim_key_granularity$& &&&
11623        &$dkim_key_notes$& &&&
11624        &$dkim_key_length$&
11625 These variables are only available within the DKIM ACL.
11626 For details see chapter &<<CHAPdkim>>&.
11627
11628 .vitem &$dkim_signers$&
11629 .vindex &$dkim_signers$&
11630 When a message has been received this variable contains
11631 a colon-separated list of signer domains and identities for the message.
11632 For details see chapter &<<CHAPdkim>>&.
11633
11634 .vitem &$dnslist_domain$& &&&
11635        &$dnslist_matched$& &&&
11636        &$dnslist_text$& &&&
11637        &$dnslist_value$&
11638 .vindex "&$dnslist_domain$&"
11639 .vindex "&$dnslist_matched$&"
11640 .vindex "&$dnslist_text$&"
11641 .vindex "&$dnslist_value$&"
11642 .cindex "black list (DNS)"
11643 When a DNS (black) list lookup succeeds, these variables are set to contain
11644 the following data from the lookup: the list's domain name, the key that was
11645 looked up, the contents of any associated TXT record, and the value from the
11646 main A record. See section &<<SECID204>>& for more details.
11647
11648 .vitem &$domain$&
11649 .vindex "&$domain$&"
11650 When an address is being routed, or delivered on its own, this variable
11651 contains the domain. Uppercase letters in the domain are converted into lower
11652 case for &$domain$&.
11653
11654 Global address rewriting happens when a message is received, so the value of
11655 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11656 is set during user filtering, but not during system filtering, because a
11657 message may have many recipients and the system filter is called just once.
11658
11659 When more than one address is being delivered at once (for example, several
11660 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11661 have the same domain. Transports can be restricted to handling only one domain
11662 at a time if the value of &$domain$& is required at transport time &-- this is
11663 the default for local transports. For further details of the environment in
11664 which local transports are run, see chapter &<<CHAPenvironment>>&.
11665
11666 .oindex "&%delay_warning_condition%&"
11667 At the end of a delivery, if all deferred addresses have the same domain, it is
11668 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11669
11670 The &$domain$& variable is also used in some other circumstances:
11671
11672 .ilist
11673 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11674 the recipient address. The domain of the &'sender'& address is in
11675 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11676 normally set during the running of the MAIL ACL. However, if the sender address
11677 is verified with a callout during the MAIL ACL, the sender domain is placed in
11678 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11679 the &(smtp)& transport.
11680
11681 .next
11682 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11683 &$domain$& contains the domain portion of the address that is being rewritten;
11684 it can be used in the expansion of the replacement address, for example, to
11685 rewrite domains by file lookup.
11686
11687 .next
11688 With one important exception, whenever a domain list is being scanned,
11689 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11690 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11691 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11692 that, in a RCPT ACL, the sender domain list can be dependent on the
11693 recipient domain (which is what is in &$domain$& at this time).
11694
11695 .next
11696 .cindex "ETRN" "value of &$domain$&"
11697 .oindex "&%smtp_etrn_command%&"
11698 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11699 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11700 .endlist
11701
11702
11703 .vitem &$domain_data$&
11704 .vindex "&$domain_data$&"
11705 When the &%domains%& option on a router matches a domain by
11706 means of a lookup, the data read by the lookup is available during the running
11707 of the router as &$domain_data$&. In addition, if the driver routes the
11708 address to a transport, the value is available in that transport. If the
11709 transport is handling multiple addresses, the value from the first address is
11710 used.
11711
11712 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11713 domain by means of a lookup. The data read by the lookup is available during
11714 the rest of the ACL statement. In all other situations, this variable expands
11715 to nothing.
11716
11717 .vitem &$exim_gid$&
11718 .vindex "&$exim_gid$&"
11719 This variable contains the numerical value of the Exim group id.
11720
11721 .vitem &$exim_path$&
11722 .vindex "&$exim_path$&"
11723 This variable contains the path to the Exim binary.
11724
11725 .vitem &$exim_uid$&
11726 .vindex "&$exim_uid$&"
11727 This variable contains the numerical value of the Exim user id.
11728
11729 .vitem &$exim_version$&
11730 .vindex "&$exim_version$&"
11731 This variable contains the version string of the Exim build.
11732 The first character is a major version number, currently 4.
11733 Then after a dot, the next group of digits is a minor version number.
11734 There may be other characters following the minor version.
11735
11736 .vitem &$header_$&<&'name'&>
11737 This is not strictly an expansion variable. It is expansion syntax for
11738 inserting the message header line with the given name. Note that the name must
11739 be terminated by colon or white space, because it may contain a wide variety of
11740 characters. Note also that braces must &'not'& be used.
11741
11742 .vitem &$headers_added$&
11743 .vindex "&$headers_added$&"
11744 Within an ACL this variable contains the headers added so far by
11745 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11746 The headers are a newline-separated list.
11747
11748 .vitem &$home$&
11749 .vindex "&$home$&"
11750 When the &%check_local_user%& option is set for a router, the user's home
11751 directory is placed in &$home$& when the check succeeds. In particular, this
11752 means it is set during the running of users' filter files. A router may also
11753 explicitly set a home directory for use by a transport; this can be overridden
11754 by a setting on the transport itself.
11755
11756 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11757 of the environment variable HOME, which is subject to the
11758 &%keep_environment%& and &%add_environment%& main config options.
11759
11760 .vitem &$host$&
11761 .vindex "&$host$&"
11762 If a router assigns an address to a transport (any transport), and passes a
11763 list of hosts with the address, the value of &$host$& when the transport starts
11764 to run is the name of the first host on the list. Note that this applies both
11765 to local and remote transports.
11766
11767 .cindex "transport" "filter"
11768 .cindex "filter" "transport filter"
11769 For the &(smtp)& transport, if there is more than one host, the value of
11770 &$host$& changes as the transport works its way through the list. In
11771 particular, when the &(smtp)& transport is expanding its options for encryption
11772 using TLS, or for specifying a transport filter (see chapter
11773 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11774 is connected.
11775
11776 When used in the client part of an authenticator configuration (see chapter
11777 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11778 client is connected.
11779
11780
11781 .vitem &$host_address$&
11782 .vindex "&$host_address$&"
11783 This variable is set to the remote host's IP address whenever &$host$& is set
11784 for a remote connection. It is also set to the IP address that is being checked
11785 when the &%ignore_target_hosts%& option is being processed.
11786
11787 .vitem &$host_data$&
11788 .vindex "&$host_data$&"
11789 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11790 result of the lookup is made available in the &$host_data$& variable. This
11791 allows you, for example, to do things like this:
11792 .code
11793 deny  hosts = net-lsearch;/some/file
11794 message = $host_data
11795 .endd
11796 .vitem &$host_lookup_deferred$&
11797 .cindex "host name" "lookup, failure of"
11798 .vindex "&$host_lookup_deferred$&"
11799 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11800 message comes from a remote host and there is an attempt to look up the host's
11801 name from its IP address, and the attempt is not successful, one of these
11802 variables is set to &"1"&.
11803
11804 .ilist
11805 If the lookup receives a definite negative response (for example, a DNS lookup
11806 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11807
11808 .next
11809 If there is any kind of problem during the lookup, such that Exim cannot
11810 tell whether or not the host name is defined (for example, a timeout for a DNS
11811 lookup), &$host_lookup_deferred$& is set to &"1"&.
11812 .endlist ilist
11813
11814 Looking up a host's name from its IP address consists of more than just a
11815 single reverse lookup. Exim checks that a forward lookup of at least one of the
11816 names it receives from a reverse lookup yields the original IP address. If this
11817 is not the case, Exim does not accept the looked up name(s), and
11818 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11819 IP address (for example, the existence of a PTR record in the DNS) is not
11820 sufficient on its own for the success of a host name lookup. If the reverse
11821 lookup succeeds, but there is a lookup problem such as a timeout when checking
11822 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11823 &"1"&. See also &$sender_host_name$&.
11824
11825 .vitem &$host_lookup_failed$&
11826 .vindex "&$host_lookup_failed$&"
11827 See &$host_lookup_deferred$&.
11828
11829 .vitem &$host_port$&
11830 .vindex "&$host_port$&"
11831 This variable is set to the remote host's TCP port whenever &$host$& is set
11832 for an outbound connection.
11833
11834 .vitem &$initial_cwd$&
11835 .vindex "&$initial_cwd$&
11836 This variable contains the full path name of the initial working
11837 directory of the current Exim process. This may differ from the current
11838 working directory, as Exim changes this to "/" during early startup, and
11839 to &$spool_directory$& later.
11840
11841 .vitem &$inode$&
11842 .vindex "&$inode$&"
11843 The only time this variable is set is while expanding the &%directory_file%&
11844 option in the &(appendfile)& transport. The variable contains the inode number
11845 of the temporary file which is about to be renamed. It can be used to construct
11846 a unique name for the file.
11847
11848 .vitem &$interface_address$&
11849 .vindex "&$interface_address$&"
11850 This is an obsolete name for &$received_ip_address$&.
11851
11852 .vitem &$interface_port$&
11853 .vindex "&$interface_port$&"
11854 This is an obsolete name for &$received_port$&.
11855
11856 .vitem &$item$&
11857 .vindex "&$item$&"
11858 This variable is used during the expansion of &*forall*& and &*forany*&
11859 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11860 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11861 empty.
11862
11863 .vitem &$ldap_dn$&
11864 .vindex "&$ldap_dn$&"
11865 This variable, which is available only when Exim is compiled with LDAP support,
11866 contains the DN from the last entry in the most recently successful LDAP
11867 lookup.
11868
11869 .vitem &$load_average$&
11870 .vindex "&$load_average$&"
11871 This variable contains the system load average, multiplied by 1000 so that it
11872 is an integer. For example, if the load average is 0.21, the value of the
11873 variable is 210. The value is recomputed every time the variable is referenced.
11874
11875 .vitem &$local_part$&
11876 .vindex "&$local_part$&"
11877 When an address is being routed, or delivered on its own, this
11878 variable contains the local part. When a number of addresses are being
11879 delivered together (for example, multiple RCPT commands in an SMTP
11880 session), &$local_part$& is not set.
11881
11882 Global address rewriting happens when a message is received, so the value of
11883 &$local_part$& during routing and delivery is the value after rewriting.
11884 &$local_part$& is set during user filtering, but not during system filtering,
11885 because a message may have many recipients and the system filter is called just
11886 once.
11887
11888 .vindex "&$local_part_prefix$&"
11889 .vindex "&$local_part_suffix$&"
11890 If a local part prefix or suffix has been recognized, it is not included in the
11891 value of &$local_part$& during routing and subsequent delivery. The values of
11892 any prefix or suffix are in &$local_part_prefix$& and
11893 &$local_part_suffix$&, respectively.
11894
11895 When a message is being delivered to a file, pipe, or autoreply transport as a
11896 result of aliasing or forwarding, &$local_part$& is set to the local part of
11897 the parent address, not to the file name or command (see &$address_file$& and
11898 &$address_pipe$&).
11899
11900 When an ACL is running for a RCPT command, &$local_part$& contains the
11901 local part of the recipient address.
11902
11903 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11904 &$local_part$& contains the local part of the address that is being rewritten;
11905 it can be used in the expansion of the replacement address, for example.
11906
11907 In all cases, all quoting is removed from the local part. For example, for both
11908 the addresses
11909 .code
11910 "abc:xyz"@test.example
11911 abc\:xyz@test.example
11912 .endd
11913 the value of &$local_part$& is
11914 .code
11915 abc:xyz
11916 .endd
11917 If you use &$local_part$& to create another address, you should always wrap it
11918 inside a quoting operator. For example, in a &(redirect)& router you could
11919 have:
11920 .code
11921 data = ${quote_local_part:$local_part}@new.domain.example
11922 .endd
11923 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11924 to process local parts in a case-dependent manner in a router, you can set the
11925 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11926
11927 .vitem &$local_part_data$&
11928 .vindex "&$local_part_data$&"
11929 When the &%local_parts%& option on a router matches a local part by means of a
11930 lookup, the data read by the lookup is available during the running of the
11931 router as &$local_part_data$&. In addition, if the driver routes the address
11932 to a transport, the value is available in that transport. If the transport is
11933 handling multiple addresses, the value from the first address is used.
11934
11935 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11936 matches a local part by means of a lookup. The data read by the lookup is
11937 available during the rest of the ACL statement. In all other situations, this
11938 variable expands to nothing.
11939
11940 .vitem &$local_part_prefix$&
11941 .vindex "&$local_part_prefix$&"
11942 When an address is being routed or delivered, and a
11943 specific prefix for the local part was recognized, it is available in this
11944 variable, having been removed from &$local_part$&.
11945
11946 .vitem &$local_part_suffix$&
11947 .vindex "&$local_part_suffix$&"
11948 When an address is being routed or delivered, and a
11949 specific suffix for the local part was recognized, it is available in this
11950 variable, having been removed from &$local_part$&.
11951
11952 .vitem &$local_scan_data$&
11953 .vindex "&$local_scan_data$&"
11954 This variable contains the text returned by the &[local_scan()]& function when
11955 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11956
11957 .vitem &$local_user_gid$&
11958 .vindex "&$local_user_gid$&"
11959 See &$local_user_uid$&.
11960
11961 .vitem &$local_user_uid$&
11962 .vindex "&$local_user_uid$&"
11963 This variable and &$local_user_gid$& are set to the uid and gid after the
11964 &%check_local_user%& router precondition succeeds. This means that their values
11965 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11966 and &%condition%&), for the &%address_data%& expansion, and for any
11967 router-specific expansions. At all other times, the values in these variables
11968 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11969
11970 .vitem &$localhost_number$&
11971 .vindex "&$localhost_number$&"
11972 This contains the expanded value of the
11973 &%localhost_number%& option. The expansion happens after the main options have
11974 been read.
11975
11976 .vitem &$log_inodes$&
11977 .vindex "&$log_inodes$&"
11978 The number of free inodes in the disk partition where Exim's
11979 log files are being written. The value is recalculated whenever the variable is
11980 referenced. If the relevant file system does not have the concept of inodes,
11981 the value of is -1. See also the &%check_log_inodes%& option.
11982
11983 .vitem &$log_space$&
11984 .vindex "&$log_space$&"
11985 The amount of free space (as a number of kilobytes) in the disk
11986 partition where Exim's log files are being written. The value is recalculated
11987 whenever the variable is referenced. If the operating system does not have the
11988 ability to find the amount of free space (only true for experimental systems),
11989 the space value is -1. See also the &%check_log_space%& option.
11990
11991
11992 .vitem &$lookup_dnssec_authenticated$&
11993 .vindex "&$lookup_dnssec_authenticated$&"
11994 This variable is set after a DNS lookup done by
11995 a dnsdb lookup expansion, dnslookup router or smtp transport.
11996 .cindex "DNS" "DNSSEC"
11997 It will be empty if &(DNSSEC)& was not requested,
11998 &"no"& if the result was not labelled as authenticated data
11999 and &"yes"& if it was.
12000 Results that are labelled as authoritative answer that match
12001 the &%dns_trust_aa%& configuration variable count also
12002 as authenticated data.
12003
12004 .vitem &$mailstore_basename$&
12005 .vindex "&$mailstore_basename$&"
12006 This variable is set only when doing deliveries in &"mailstore"& format in the
12007 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12008 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12009 contains the basename of the files that are being written, that is, the name
12010 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12011 variable is empty.
12012
12013 .vitem &$malware_name$&
12014 .vindex "&$malware_name$&"
12015 This variable is available when Exim is compiled with the
12016 content-scanning extension. It is set to the name of the virus that was found
12017 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12018
12019 .vitem &$max_received_linelength$&
12020 .vindex "&$max_received_linelength$&"
12021 .cindex "maximum" "line length"
12022 .cindex "line length" "maximum"
12023 This variable contains the number of bytes in the longest line that was
12024 received as part of the message, not counting the line termination
12025 character(s).
12026
12027 .vitem &$message_age$&
12028 .cindex "message" "age of"
12029 .vindex "&$message_age$&"
12030 This variable is set at the start of a delivery attempt to contain the number
12031 of seconds since the message was received. It does not change during a single
12032 delivery attempt.
12033
12034 .vitem &$message_body$&
12035 .cindex "body of message" "expansion variable"
12036 .cindex "message body" "in expansion"
12037 .cindex "binary zero" "in message body"
12038 .vindex "&$message_body$&"
12039 .oindex "&%message_body_visible%&"
12040 This variable contains the initial portion of a message's body while it is
12041 being delivered, and is intended mainly for use in filter files. The maximum
12042 number of characters of the body that are put into the variable is set by the
12043 &%message_body_visible%& configuration option; the default is 500.
12044
12045 .oindex "&%message_body_newlines%&"
12046 By default, newlines are converted into spaces in &$message_body$&, to make it
12047 easier to search for phrases that might be split over a line break. However,
12048 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12049 zeros are always converted into spaces.
12050
12051 .vitem &$message_body_end$&
12052 .cindex "body of message" "expansion variable"
12053 .cindex "message body" "in expansion"
12054 .vindex "&$message_body_end$&"
12055 This variable contains the final portion of a message's
12056 body while it is being delivered. The format and maximum size are as for
12057 &$message_body$&.
12058
12059 .vitem &$message_body_size$&
12060 .cindex "body of message" "size"
12061 .cindex "message body" "size"
12062 .vindex "&$message_body_size$&"
12063 When a message is being delivered, this variable contains the size of the body
12064 in bytes. The count starts from the character after the blank line that
12065 separates the body from the header. Newlines are included in the count. See
12066 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12067
12068 .vitem &$message_exim_id$&
12069 .vindex "&$message_exim_id$&"
12070 When a message is being received or delivered, this variable contains the
12071 unique message id that is generated and used by Exim to identify the message.
12072 An id is not created for a message until after its header has been successfully
12073 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12074 line; it is the local id that Exim assigns to the message, for example:
12075 &`1BXTIK-0001yO-VA`&.
12076
12077 .vitem &$message_headers$&
12078 .vindex &$message_headers$&
12079 This variable contains a concatenation of all the header lines when a message
12080 is being processed, except for lines added by routers or transports. The header
12081 lines are separated by newline characters. Their contents are decoded in the
12082 same way as a header line that is inserted by &%bheader%&.
12083
12084 .vitem &$message_headers_raw$&
12085 .vindex &$message_headers_raw$&
12086 This variable is like &$message_headers$& except that no processing of the
12087 contents of header lines is done.
12088
12089 .vitem &$message_id$&
12090 This is an old name for &$message_exim_id$&. It is now deprecated.
12091
12092 .vitem &$message_linecount$&
12093 .vindex "&$message_linecount$&"
12094 This variable contains the total number of lines in the header and body of the
12095 message. Compare &$body_linecount$&, which is the count for the body only.
12096 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12097 number of lines received. Before delivery happens (that is, before filters,
12098 routers, and transports run) the count is increased to include the
12099 &'Received:'& header line that Exim standardly adds, and also any other header
12100 lines that are added by ACLs. The blank line that separates the message header
12101 from the body is not counted.
12102
12103 As with the special case of &$message_size$&, during the expansion of the
12104 appendfile transport's maildir_tag option in maildir format, the value of
12105 &$message_linecount$& is the precise size of the number of newlines in the
12106 file that has been written (minus one for the blank line between the
12107 header and the body).
12108
12109 Here is an example of the use of this variable in a DATA ACL:
12110 .code
12111 deny message   = Too many lines in message header
12112      condition = \
12113       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12114 .endd
12115 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12116 message has not yet been received.
12117
12118 .vitem &$message_size$&
12119 .cindex "size" "of message"
12120 .cindex "message" "size"
12121 .vindex "&$message_size$&"
12122 When a message is being processed, this variable contains its size in bytes. In
12123 most cases, the size includes those headers that were received with the
12124 message, but not those (such as &'Envelope-to:'&) that are added to individual
12125 deliveries as they are written. However, there is one special case: during the
12126 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12127 doing a delivery in maildir format, the value of &$message_size$& is the
12128 precise size of the file that has been written. See also
12129 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12130
12131 .cindex "RCPT" "value of &$message_size$&"
12132 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12133 contains the size supplied on the MAIL command, or -1 if no size was given. The
12134 value may not, of course, be truthful.
12135
12136 .vitem &$mime_$&&'xxx'&
12137 A number of variables whose names start with &$mime$& are
12138 available when Exim is compiled with the content-scanning extension. For
12139 details, see section &<<SECTscanmimepart>>&.
12140
12141 .vitem "&$n0$& &-- &$n9$&"
12142 These variables are counters that can be incremented by means
12143 of the &%add%& command in filter files.
12144
12145 .vitem &$original_domain$&
12146 .vindex "&$domain$&"
12147 .vindex "&$original_domain$&"
12148 When a top-level address is being processed for delivery, this contains the
12149 same value as &$domain$&. However, if a &"child"& address (for example,
12150 generated by an alias, forward, or filter file) is being processed, this
12151 variable contains the domain of the original address (lower cased). This
12152 differs from &$parent_domain$& only when there is more than one level of
12153 aliasing or forwarding. When more than one address is being delivered in a
12154 single transport run, &$original_domain$& is not set.
12155
12156 If a new address is created by means of a &%deliver%& command in a system
12157 filter, it is set up with an artificial &"parent"& address. This has the local
12158 part &'system-filter'& and the default qualify domain.
12159
12160 .vitem &$original_local_part$&
12161 .vindex "&$local_part$&"
12162 .vindex "&$original_local_part$&"
12163 When a top-level address is being processed for delivery, this contains the
12164 same value as &$local_part$&, unless a prefix or suffix was removed from the
12165 local part, because &$original_local_part$& always contains the full local
12166 part. When a &"child"& address (for example, generated by an alias, forward, or
12167 filter file) is being processed, this variable contains the full local part of
12168 the original address.
12169
12170 If the router that did the redirection processed the local part
12171 case-insensitively, the value in &$original_local_part$& is in lower case.
12172 This variable differs from &$parent_local_part$& only when there is more than
12173 one level of aliasing or forwarding. When more than one address is being
12174 delivered in a single transport run, &$original_local_part$& is not set.
12175
12176 If a new address is created by means of a &%deliver%& command in a system
12177 filter, it is set up with an artificial &"parent"& address. This has the local
12178 part &'system-filter'& and the default qualify domain.
12179
12180 .vitem &$originator_gid$&
12181 .cindex "gid (group id)" "of originating user"
12182 .cindex "sender" "gid"
12183 .vindex "&$caller_gid$&"
12184 .vindex "&$originator_gid$&"
12185 This variable contains the value of &$caller_gid$& that was set when the
12186 message was received. For messages received via the command line, this is the
12187 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12188 normally the gid of the Exim user.
12189
12190 .vitem &$originator_uid$&
12191 .cindex "uid (user id)" "of originating user"
12192 .cindex "sender" "uid"
12193 .vindex "&$caller_uid$&"
12194 .vindex "&$originaltor_uid$&"
12195 The value of &$caller_uid$& that was set when the message was received. For
12196 messages received via the command line, this is the uid of the sending user.
12197 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12198 user.
12199
12200 .vitem &$parent_domain$&
12201 .vindex "&$parent_domain$&"
12202 This variable is similar to &$original_domain$& (see
12203 above), except that it refers to the immediately preceding parent address.
12204
12205 .vitem &$parent_local_part$&
12206 .vindex "&$parent_local_part$&"
12207 This variable is similar to &$original_local_part$&
12208 (see above), except that it refers to the immediately preceding parent address.
12209
12210 .vitem &$pid$&
12211 .cindex "pid (process id)" "of current process"
12212 .vindex "&$pid$&"
12213 This variable contains the current process id.
12214
12215 .vitem &$pipe_addresses$&
12216 .cindex "filter" "transport filter"
12217 .cindex "transport" "filter"
12218 .vindex "&$pipe_addresses$&"
12219 This is not an expansion variable, but is mentioned here because the string
12220 &`$pipe_addresses`& is handled specially in the command specification for the
12221 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12222 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12223 It cannot be used in general expansion strings, and provokes an &"unknown
12224 variable"& error if encountered.
12225
12226 .vitem &$primary_hostname$&
12227 .vindex "&$primary_hostname$&"
12228 This variable contains the value set by &%primary_hostname%& in the
12229 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12230 a single-component name, Exim calls &[gethostbyname()]& (or
12231 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12232 qualified host name. See also &$smtp_active_hostname$&.
12233
12234
12235 .new
12236 .vitem &$proxy_external_address$& &&&
12237        &$proxy_external_port$& &&&
12238        &$proxy_local_address$& &&&
12239        &$proxy_local_port$& &&&
12240        &$proxy_session$&
12241 These variables are only available when built with Proxy Protocol
12242 or Socks5 support
12243 For details see chapter &<<SECTproxyInbound>>&.
12244 .wen
12245
12246 .vitem &$prdr_requested$&
12247 .cindex "PRDR" "variable for"
12248 This variable is set to &"yes"& if PRDR was requested by the client for the
12249 current message, otherwise &"no"&.
12250
12251 .vitem &$prvscheck_address$&
12252 This variable is used in conjunction with the &%prvscheck%& expansion item,
12253 which is described in sections &<<SECTexpansionitems>>& and
12254 &<<SECTverifyPRVS>>&.
12255
12256 .vitem &$prvscheck_keynum$&
12257 This variable is used in conjunction with the &%prvscheck%& expansion item,
12258 which is described in sections &<<SECTexpansionitems>>& and
12259 &<<SECTverifyPRVS>>&.
12260
12261 .vitem &$prvscheck_result$&
12262 This variable is used in conjunction with the &%prvscheck%& expansion item,
12263 which is described in sections &<<SECTexpansionitems>>& and
12264 &<<SECTverifyPRVS>>&.
12265
12266 .vitem &$qualify_domain$&
12267 .vindex "&$qualify_domain$&"
12268 The value set for the &%qualify_domain%& option in the configuration file.
12269
12270 .vitem &$qualify_recipient$&
12271 .vindex "&$qualify_recipient$&"
12272 The value set for the &%qualify_recipient%& option in the configuration file,
12273 or if not set, the value of &$qualify_domain$&.
12274
12275 .new
12276 .vitem &$queue_name$&
12277 .vindex &$queue_name$&
12278 .cindex "named queues"
12279 .cindex queues named
12280 The name of the spool queue in use; empty for the default queue.
12281 .wen
12282
12283 .vitem &$rcpt_count$&
12284 .vindex "&$rcpt_count$&"
12285 When a message is being received by SMTP, this variable contains the number of
12286 RCPT commands received for the current message. If this variable is used in a
12287 RCPT ACL, its value includes the current command.
12288
12289 .vitem &$rcpt_defer_count$&
12290 .vindex "&$rcpt_defer_count$&"
12291 .cindex "4&'xx'& responses" "count of"
12292 When a message is being received by SMTP, this variable contains the number of
12293 RCPT commands in the current message that have previously been rejected with a
12294 temporary (4&'xx'&) response.
12295
12296 .vitem &$rcpt_fail_count$&
12297 .vindex "&$rcpt_fail_count$&"
12298 When a message is being received by SMTP, this variable contains the number of
12299 RCPT commands in the current message that have previously been rejected with a
12300 permanent (5&'xx'&) response.
12301
12302 .vitem &$received_count$&
12303 .vindex "&$received_count$&"
12304 This variable contains the number of &'Received:'& header lines in the message,
12305 including the one added by Exim (so its value is always greater than zero). It
12306 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12307 delivering.
12308
12309 .vitem &$received_for$&
12310 .vindex "&$received_for$&"
12311 If there is only a single recipient address in an incoming message, this
12312 variable contains that address when the &'Received:'& header line is being
12313 built. The value is copied after recipient rewriting has happened, but before
12314 the &[local_scan()]& function is run.
12315
12316 .vitem &$received_ip_address$&
12317 .vindex "&$received_ip_address$&"
12318 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12319 variable is set to the address of the local IP interface, and &$received_port$&
12320 is set to the local port number. (The remote IP address and port are in
12321 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12322 the port value is -1 unless it has been set using the &%-oMi%& command line
12323 option.
12324
12325 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12326 could be used, for example, to make the file name for a TLS certificate depend
12327 on which interface and/or port is being used for the incoming connection. The
12328 values of &$received_ip_address$& and &$received_port$& are saved with any
12329 messages that are received, thus making these variables available at delivery
12330 time.
12331 For outbound connections see &$sending_ip_address$&.
12332
12333 .vitem &$received_port$&
12334 .vindex "&$received_port$&"
12335 See &$received_ip_address$&.
12336
12337 .vitem &$received_protocol$&
12338 .vindex "&$received_protocol$&"
12339 When a message is being processed, this variable contains the name of the
12340 protocol by which it was received. Most of the names used by Exim are defined
12341 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12342 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12343 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12344 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12345 connection and the client was successfully authenticated.
12346
12347 Exim uses the protocol name &"smtps"& for the case when encryption is
12348 automatically set up on connection without the use of STARTTLS (see
12349 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12350 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12351 where the client initially uses EHLO, sets up an encrypted connection using
12352 STARTTLS, and then uses HELO afterwards.
12353
12354 The &%-oMr%& option provides a way of specifying a custom protocol name for
12355 messages that are injected locally by trusted callers. This is commonly used to
12356 identify messages that are being re-injected after some kind of scanning.
12357
12358 .vitem &$received_time$&
12359 .vindex "&$received_time$&"
12360 This variable contains the date and time when the current message was received,
12361 as a number of seconds since the start of the Unix epoch.
12362
12363 .vitem &$recipient_data$&
12364 .vindex "&$recipient_data$&"
12365 This variable is set after an indexing lookup success in an ACL &%recipients%&
12366 condition. It contains the data from the lookup, and the value remains set
12367 until the next &%recipients%& test. Thus, you can do things like this:
12368 .display
12369 &`require recipients  = cdb*@;/some/file`&
12370 &`deny    `&&'some further test involving'& &`$recipient_data`&
12371 .endd
12372 &*Warning*&: This variable is set only when a lookup is used as an indexing
12373 method in the address list, using the semicolon syntax as in the example above.
12374 The variable is not set for a lookup that is used as part of the string
12375 expansion that all such lists undergo before being interpreted.
12376
12377 .vitem &$recipient_verify_failure$&
12378 .vindex "&$recipient_verify_failure$&"
12379 In an ACL, when a recipient verification fails, this variable contains
12380 information about the failure. It is set to one of the following words:
12381
12382 .ilist
12383 &"qualify"&: The address was unqualified (no domain), and the message
12384 was neither local nor came from an exempted host.
12385
12386 .next
12387 &"route"&: Routing failed.
12388
12389 .next
12390 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12391 or before the MAIL command (that is, on initial connection, HELO, or
12392 MAIL).
12393
12394 .next
12395 &"recipient"&: The RCPT command in a callout was rejected.
12396 .next
12397
12398 &"postmaster"&: The postmaster check in a callout was rejected.
12399 .endlist
12400
12401 The main use of this variable is expected to be to distinguish between
12402 rejections of MAIL and rejections of RCPT.
12403
12404 .vitem &$recipients$&
12405 .vindex "&$recipients$&"
12406 This variable contains a list of envelope recipients for a message. A comma and
12407 a space separate the addresses in the replacement text. However, the variable
12408 is not generally available, to prevent exposure of Bcc recipients in
12409 unprivileged users' filter files. You can use &$recipients$& only in these
12410 cases:
12411
12412 .olist
12413 In a system filter file.
12414 .next
12415 In the ACLs associated with the DATA command and with non-SMTP messages, that
12416 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12417 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12418 &%acl_not_smtp_mime%&.
12419 .next
12420 From within a &[local_scan()]& function.
12421 .endlist
12422
12423
12424 .vitem &$recipients_count$&
12425 .vindex "&$recipients_count$&"
12426 When a message is being processed, this variable contains the number of
12427 envelope recipients that came with the message. Duplicates are not excluded
12428 from the count. While a message is being received over SMTP, the number
12429 increases for each accepted recipient. It can be referenced in an ACL.
12430
12431
12432 .vitem &$regex_match_string$&
12433 .vindex "&$regex_match_string$&"
12434 This variable is set to contain the matching regular expression after a
12435 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12436
12437 .vitem "&$regex1$&, &$regex2$&, etc"
12438 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12439 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12440 these variables contain the
12441 captured substrings identified by the regular expression.
12442
12443
12444 .vitem &$reply_address$&
12445 .vindex "&$reply_address$&"
12446 When a message is being processed, this variable contains the contents of the
12447 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12448 contents of the &'From:'& header line. Apart from the removal of leading
12449 white space, the value is not processed in any way. In particular, no RFC 2047
12450 decoding or character code translation takes place.
12451
12452 .vitem &$return_path$&
12453 .vindex "&$return_path$&"
12454 When a message is being delivered, this variable contains the return path &--
12455 the sender field that will be sent as part of the envelope. It is not enclosed
12456 in <> characters. At the start of routing an address, &$return_path$& has the
12457 same value as &$sender_address$&, but if, for example, an incoming message to a
12458 mailing list has been expanded by a router which specifies a different address
12459 for bounce messages, &$return_path$& subsequently contains the new bounce
12460 address, whereas &$sender_address$& always contains the original sender address
12461 that was received with the message. In other words, &$sender_address$& contains
12462 the incoming envelope sender, and &$return_path$& contains the outgoing
12463 envelope sender.
12464
12465 .vitem &$return_size_limit$&
12466 .vindex "&$return_size_limit$&"
12467 This is an obsolete name for &$bounce_return_size_limit$&.
12468
12469 .vitem &$router_name$&
12470 .cindex "router" "name"
12471 .cindex "name" "of router"
12472 .vindex "&$router_name$&"
12473 During the running of a router this variable contains its name.
12474
12475 .vitem &$runrc$&
12476 .cindex "return code" "from &%run%& expansion"
12477 .vindex "&$runrc$&"
12478 This variable contains the return code from a command that is run by the
12479 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12480 assume the order in which option values are expanded, except for those
12481 preconditions whose order of testing is documented. Therefore, you cannot
12482 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12483 another.
12484
12485 .vitem &$self_hostname$&
12486 .oindex "&%self%&" "value of host name"
12487 .vindex "&$self_hostname$&"
12488 When an address is routed to a supposedly remote host that turns out to be the
12489 local host, what happens is controlled by the &%self%& generic router option.
12490 One of its values causes the address to be passed to another router. When this
12491 happens, &$self_hostname$& is set to the name of the local host that the
12492 original router encountered. In other circumstances its contents are null.
12493
12494 .vitem &$sender_address$&
12495 .vindex "&$sender_address$&"
12496 When a message is being processed, this variable contains the sender's address
12497 that was received in the message's envelope. The case of letters in the address
12498 is retained, in both the local part and the domain. For bounce messages, the
12499 value of this variable is the empty string. See also &$return_path$&.
12500
12501 .vitem &$sender_address_data$&
12502 .vindex "&$address_data$&"
12503 .vindex "&$sender_address_data$&"
12504 If &$address_data$& is set when the routers are called from an ACL to verify a
12505 sender address, the final value is preserved in &$sender_address_data$&, to
12506 distinguish it from data from a recipient address. The value does not persist
12507 after the end of the current ACL statement. If you want to preserve it for
12508 longer, you can save it in an ACL variable.
12509
12510 .vitem &$sender_address_domain$&
12511 .vindex "&$sender_address_domain$&"
12512 The domain portion of &$sender_address$&.
12513
12514 .vitem &$sender_address_local_part$&
12515 .vindex "&$sender_address_local_part$&"
12516 The local part portion of &$sender_address$&.
12517
12518 .vitem &$sender_data$&
12519 .vindex "&$sender_data$&"
12520 This variable is set after a lookup success in an ACL &%senders%& condition or
12521 in a router &%senders%& option. It contains the data from the lookup, and the
12522 value remains set until the next &%senders%& test. Thus, you can do things like
12523 this:
12524 .display
12525 &`require senders      = cdb*@;/some/file`&
12526 &`deny    `&&'some further test involving'& &`$sender_data`&
12527 .endd
12528 &*Warning*&: This variable is set only when a lookup is used as an indexing
12529 method in the address list, using the semicolon syntax as in the example above.
12530 The variable is not set for a lookup that is used as part of the string
12531 expansion that all such lists undergo before being interpreted.
12532
12533 .vitem &$sender_fullhost$&
12534 .vindex "&$sender_fullhost$&"
12535 When a message is received from a remote host, this variable contains the host
12536 name and IP address in a single string. It ends with the IP address in square
12537 brackets, followed by a colon and a port number if the logging of ports is
12538 enabled. The format of the rest of the string depends on whether the host
12539 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12540 looking up its IP address. (Looking up the IP address can be forced by the
12541 &%host_lookup%& option, independent of verification.) A plain host name at the
12542 start of the string is a verified host name; if this is not present,
12543 verification either failed or was not requested. A host name in parentheses is
12544 the argument of a HELO or EHLO command. This is omitted if it is identical to
12545 the verified host name or to the host's IP address in square brackets.
12546
12547 .vitem &$sender_helo_dnssec$&
12548 .vindex "&$sender_helo_dnssec$&"
12549 This boolean variable is true if a successful HELO verification was
12550 .cindex "DNS" "DNSSEC"
12551 done using DNS information the resolver library stated was authenticated data.
12552
12553 .vitem &$sender_helo_name$&
12554 .vindex "&$sender_helo_name$&"
12555 When a message is received from a remote host that has issued a HELO or EHLO
12556 command, the argument of that command is placed in this variable. It is also
12557 set if HELO or EHLO is used when a message is received using SMTP locally via
12558 the &%-bs%& or &%-bS%& options.
12559
12560 .vitem &$sender_host_address$&
12561 .vindex "&$sender_host_address$&"
12562 When a message is received from a remote host using SMTP,
12563 this variable contains that
12564 host's IP address. For locally non-SMTP submitted messages, it is empty.
12565
12566 .vitem &$sender_host_authenticated$&
12567 .vindex "&$sender_host_authenticated$&"
12568 This variable contains the name (not the public name) of the authenticator
12569 driver that successfully authenticated the client from which the message was
12570 received. It is empty if there was no successful authentication. See also
12571 &$authenticated_id$&.
12572
12573 .vitem &$sender_host_dnssec$&
12574 .vindex "&$sender_host_dnssec$&"
12575 If an attempt to populate &$sender_host_name$& has been made
12576 (by reference, &%hosts_lookup%& or
12577 otherwise) then this boolean will have been set true if, and only if, the
12578 resolver library states that both
12579 the reverse and forward DNS were authenticated data.  At all
12580 other times, this variable is false.
12581
12582 .cindex "DNS" "DNSSEC"
12583 It is likely that you will need to coerce DNSSEC support on in the resolver
12584 library, by setting:
12585 .code
12586 dns_dnssec_ok = 1
12587 .endd
12588
12589 Exim does not perform DNSSEC validation itself, instead leaving that to a
12590 validating resolver (e.g. unbound, or bind with suitable configuration).
12591
12592 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12593 mechanism in the list, then this variable will be false.
12594
12595
12596 .vitem &$sender_host_name$&
12597 .vindex "&$sender_host_name$&"
12598 When a message is received from a remote host, this variable contains the
12599 host's name as obtained by looking up its IP address. For messages received by
12600 other means, this variable is empty.
12601
12602 .vindex "&$host_lookup_failed$&"
12603 If the host name has not previously been looked up, a reference to
12604 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12605 A looked up name is accepted only if it leads back to the original IP address
12606 via a forward lookup. If either the reverse or the forward lookup fails to find
12607 any data, or if the forward lookup does not yield the original IP address,
12608 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12609
12610 .vindex "&$host_lookup_deferred$&"
12611 However, if either of the lookups cannot be completed (for example, there is a
12612 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12613 &$host_lookup_failed$& remains set to &"0"&.
12614
12615 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12616 host name again if there is a subsequent reference to &$sender_host_name$&
12617 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12618 is set to &"1"&.
12619
12620 Exim does not automatically look up every calling host's name. If you want
12621 maximum efficiency, you should arrange your configuration so that it avoids
12622 these lookups altogether. The lookup happens only if one or more of the
12623 following are true:
12624
12625 .ilist
12626 A string containing &$sender_host_name$& is expanded.
12627 .next
12628 The calling host matches the list in &%host_lookup%&. In the default
12629 configuration, this option is set to *, so it must be changed if lookups are
12630 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12631 .next
12632 Exim needs the host name in order to test an item in a host list. The items
12633 that require this are described in sections &<<SECThoslispatnam>>& and
12634 &<<SECThoslispatnamsk>>&.
12635 .next
12636 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12637 In this case, the host name is required to compare with the name quoted in any
12638 EHLO or HELO commands that the client issues.
12639 .next
12640 The remote host issues a EHLO or HELO command that quotes one of the
12641 domains in &%helo_lookup_domains%&. The default value of this option is
12642 . ==== As this is a nested list, any displays it contains must be indented
12643 . ==== as otherwise they are too far to the left.
12644 .code
12645   helo_lookup_domains = @ : @[]
12646 .endd
12647 which causes a lookup if a remote host (incorrectly) gives the server's name or
12648 IP address in an EHLO or HELO command.
12649 .endlist
12650
12651
12652 .vitem &$sender_host_port$&
12653 .vindex "&$sender_host_port$&"
12654 When a message is received from a remote host, this variable contains the port
12655 number that was used on the remote host.
12656
12657 .vitem &$sender_ident$&
12658 .vindex "&$sender_ident$&"
12659 When a message is received from a remote host, this variable contains the
12660 identification received in response to an RFC 1413 request. When a message has
12661 been received locally, this variable contains the login name of the user that
12662 called Exim.
12663
12664 .vitem &$sender_rate_$&&'xxx'&
12665 A number of variables whose names begin &$sender_rate_$& are set as part of the
12666 &%ratelimit%& ACL condition. Details are given in section
12667 &<<SECTratelimiting>>&.
12668
12669 .vitem &$sender_rcvhost$&
12670 .cindex "DNS" "reverse lookup"
12671 .cindex "reverse DNS lookup"
12672 .vindex "&$sender_rcvhost$&"
12673 This is provided specifically for use in &'Received:'& headers. It starts with
12674 either the verified host name (as obtained from a reverse DNS lookup) or, if
12675 there is no verified host name, the IP address in square brackets. After that
12676 there may be text in parentheses. When the first item is a verified host name,
12677 the first thing in the parentheses is the IP address in square brackets,
12678 followed by a colon and a port number if port logging is enabled. When the
12679 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12680 the parentheses.
12681
12682 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12683 was used and its argument was not identical to the real host name or IP
12684 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12685 all three items are present in the parentheses, a newline and tab are inserted
12686 into the string, to improve the formatting of the &'Received:'& header.
12687
12688 .vitem &$sender_verify_failure$&
12689 .vindex "&$sender_verify_failure$&"
12690 In an ACL, when a sender verification fails, this variable contains information
12691 about the failure. The details are the same as for
12692 &$recipient_verify_failure$&.
12693
12694 .vitem &$sending_ip_address$&
12695 .vindex "&$sending_ip_address$&"
12696 This variable is set whenever an outgoing SMTP connection to another host has
12697 been set up. It contains the IP address of the local interface that is being
12698 used. This is useful if a host that has more than one IP address wants to take
12699 on different personalities depending on which one is being used. For incoming
12700 connections, see &$received_ip_address$&.
12701
12702 .vitem &$sending_port$&
12703 .vindex "&$sending_port$&"
12704 This variable is set whenever an outgoing SMTP connection to another host has
12705 been set up. It contains the local port that is being used. For incoming
12706 connections, see &$received_port$&.
12707
12708 .vitem &$smtp_active_hostname$&
12709 .vindex "&$smtp_active_hostname$&"
12710 During an incoming SMTP session, this variable contains the value of the active
12711 host name, as specified by the &%smtp_active_hostname%& option. The value of
12712 &$smtp_active_hostname$& is saved with any message that is received, so its
12713 value can be consulted during routing and delivery.
12714
12715 .vitem &$smtp_command$&
12716 .vindex "&$smtp_command$&"
12717 During the processing of an incoming SMTP command, this variable contains the
12718 entire command. This makes it possible to distinguish between HELO and EHLO in
12719 the HELO ACL, and also to distinguish between commands such as these:
12720 .code
12721 MAIL FROM:<>
12722 MAIL FROM: <>
12723 .endd
12724 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12725 command, the address in &$smtp_command$& is the original address before any
12726 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12727 the address after SMTP-time rewriting.
12728
12729 .vitem &$smtp_command_argument$&
12730 .cindex "SMTP" "command, argument for"
12731 .vindex "&$smtp_command_argument$&"
12732 While an ACL is running to check an SMTP command, this variable contains the
12733 argument, that is, the text that follows the command name, with leading white
12734 space removed. Following the introduction of &$smtp_command$&, this variable is
12735 somewhat redundant, but is retained for backwards compatibility.
12736
12737 .vitem &$smtp_count_at_connection_start$&
12738 .vindex "&$smtp_count_at_connection_start$&"
12739 This variable is set greater than zero only in processes spawned by the Exim
12740 daemon for handling incoming SMTP connections. The name is deliberately long,
12741 in order to emphasize what the contents are. When the daemon accepts a new
12742 connection, it increments this variable. A copy of the variable is passed to
12743 the child process that handles the connection, but its value is fixed, and
12744 never changes. It is only an approximation of how many incoming connections
12745 there actually are, because many other connections may come and go while a
12746 single connection is being processed. When a child process terminates, the
12747 daemon decrements its copy of the variable.
12748
12749 .vitem "&$sn0$& &-- &$sn9$&"
12750 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12751 that were current at the end of the system filter file. This allows a system
12752 filter file to set values that can be tested in users' filter files. For
12753 example, a system filter could set a value indicating how likely it is that a
12754 message is junk mail.
12755
12756 .vitem &$spam_$&&'xxx'&
12757 A number of variables whose names start with &$spam$& are available when Exim
12758 is compiled with the content-scanning extension. For details, see section
12759 &<<SECTscanspamass>>&.
12760
12761
12762 .vitem &$spool_directory$&
12763 .vindex "&$spool_directory$&"
12764 The name of Exim's spool directory.
12765
12766 .vitem &$spool_inodes$&
12767 .vindex "&$spool_inodes$&"
12768 The number of free inodes in the disk partition where Exim's spool files are
12769 being written. The value is recalculated whenever the variable is referenced.
12770 If the relevant file system does not have the concept of inodes, the value of
12771 is -1. See also the &%check_spool_inodes%& option.
12772
12773 .vitem &$spool_space$&
12774 .vindex "&$spool_space$&"
12775 The amount of free space (as a number of kilobytes) in the disk partition where
12776 Exim's spool files are being written. The value is recalculated whenever the
12777 variable is referenced. If the operating system does not have the ability to
12778 find the amount of free space (only true for experimental systems), the space
12779 value is -1. For example, to check in an ACL that there is at least 50
12780 megabytes free on the spool, you could write:
12781 .code
12782 condition = ${if > {$spool_space}{50000}}
12783 .endd
12784 See also the &%check_spool_space%& option.
12785
12786
12787 .vitem &$thisaddress$&
12788 .vindex "&$thisaddress$&"
12789 This variable is set only during the processing of the &%foranyaddress%&
12790 command in a filter file. Its use is explained in the description of that
12791 command, which can be found in the separate document entitled &'Exim's
12792 interfaces to mail filtering'&.
12793
12794 .vitem &$tls_in_bits$&
12795 .vindex "&$tls_in_bits$&"
12796 Contains an approximation of the TLS cipher's bit-strength
12797 on the inbound connection; the meaning of
12798 this depends upon the TLS implementation used.
12799 If TLS has not been negotiated, the value will be 0.
12800 The value of this is automatically fed into the Cyrus SASL authenticator
12801 when acting as a server, to specify the "external SSF" (a SASL term).
12802
12803 The deprecated &$tls_bits$& variable refers to the inbound side
12804 except when used in the context of an outbound SMTP delivery, when it refers to
12805 the outbound.
12806
12807 .vitem &$tls_out_bits$&
12808 .vindex "&$tls_out_bits$&"
12809 Contains an approximation of the TLS cipher's bit-strength
12810 on an outbound SMTP connection; the meaning of
12811 this depends upon the TLS implementation used.
12812 If TLS has not been negotiated, the value will be 0.
12813
12814 .vitem &$tls_in_ourcert$&
12815 .vindex "&$tls_in_ourcert$&"
12816 .cindex certificate veriables
12817 This variable refers to the certificate presented to the peer of an
12818 inbound connection when the message was received.
12819 It is only useful as the argument of a
12820 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12821 or a &%def%& condition.
12822
12823 .vitem &$tls_in_peercert$&
12824 .vindex "&$tls_in_peercert$&"
12825 This variable refers to the certificate presented by the peer of an
12826 inbound connection when the message was received.
12827 It is only useful as the argument of a
12828 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12829 or a &%def%& condition.
12830 If certificate verification fails it may refer to a failing chain element
12831 which is not the leaf.
12832
12833 .vitem &$tls_out_ourcert$&
12834 .vindex "&$tls_out_ourcert$&"
12835 This variable refers to the certificate presented to the peer of an
12836 outbound connection.  It is only useful as the argument of a
12837 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12838 or a &%def%& condition.
12839
12840 .vitem &$tls_out_peercert$&
12841 .vindex "&$tls_out_peercert$&"
12842 This variable refers to the certificate presented by the peer of an
12843 outbound connection.  It is only useful as the argument of a
12844 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12845 or a &%def%& condition.
12846 If certificate verification fails it may refer to a failing chain element
12847 which is not the leaf.
12848
12849 .vitem &$tls_in_certificate_verified$&
12850 .vindex "&$tls_in_certificate_verified$&"
12851 This variable is set to &"1"& if a TLS certificate was verified when the
12852 message was received, and &"0"& otherwise.
12853
12854 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12855 except when used in the context of an outbound SMTP delivery, when it refers to
12856 the outbound.
12857
12858 .vitem &$tls_out_certificate_verified$&
12859 .vindex "&$tls_out_certificate_verified$&"
12860 This variable is set to &"1"& if a TLS certificate was verified when an
12861 outbound SMTP connection was made,
12862 and &"0"& otherwise.
12863
12864 .vitem &$tls_in_cipher$&
12865 .vindex "&$tls_in_cipher$&"
12866 .vindex "&$tls_cipher$&"
12867 When a message is received from a remote host over an encrypted SMTP
12868 connection, this variable is set to the cipher suite that was negotiated, for
12869 example DES-CBC3-SHA. In other circumstances, in particular, for message
12870 received over unencrypted connections, the variable is empty. Testing
12871 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12872 non-encrypted connections during ACL processing.
12873
12874 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12875 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12876 becomes the same as &$tls_out_cipher$&.
12877
12878 .vitem &$tls_out_cipher$&
12879 .vindex "&$tls_out_cipher$&"
12880 This variable is
12881 cleared before any outgoing SMTP connection is made,
12882 and then set to the outgoing cipher suite if one is negotiated. See chapter
12883 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12884 details of the &(smtp)& transport.
12885
12886 .vitem &$tls_in_ocsp$&
12887 .vindex "&$tls_in_ocsp$&"
12888 When a message is received from a remote client connection
12889 the result of any OCSP request from the client is encoded in this variable:
12890 .code
12891 0 OCSP proof was not requested (default value)
12892 1 No response to request
12893 2 Response not verified
12894 3 Verification failed
12895 4 Verification succeeded
12896 .endd
12897
12898 .vitem &$tls_out_ocsp$&
12899 .vindex "&$tls_out_ocsp$&"
12900 When a message is sent to a remote host connection
12901 the result of any OCSP request made is encoded in this variable.
12902 See &$tls_in_ocsp$& for values.
12903
12904 .vitem &$tls_in_peerdn$&
12905 .vindex "&$tls_in_peerdn$&"
12906 .vindex "&$tls_peerdn$&"
12907 .cindex certificate "extracting fields"
12908 When a message is received from a remote host over an encrypted SMTP
12909 connection, and Exim is configured to request a certificate from the client,
12910 the value of the Distinguished Name of the certificate is made available in the
12911 &$tls_in_peerdn$& during subsequent processing.
12912 If certificate verification fails it may refer to a failing chain element
12913 which is not the leaf.
12914
12915 The deprecated &$tls_peerdn$& variable refers to the inbound side
12916 except when used in the context of an outbound SMTP delivery, when it refers to
12917 the outbound.
12918
12919 .vitem &$tls_out_peerdn$&
12920 .vindex "&$tls_out_peerdn$&"
12921 When a message is being delivered to a remote host over an encrypted SMTP
12922 connection, and Exim is configured to request a certificate from the server,
12923 the value of the Distinguished Name of the certificate is made available in the
12924 &$tls_out_peerdn$& during subsequent processing.
12925 If certificate verification fails it may refer to a failing chain element
12926 which is not the leaf.
12927
12928 .vitem &$tls_in_sni$&
12929 .vindex "&$tls_in_sni$&"
12930 .vindex "&$tls_sni$&"
12931 .cindex "TLS" "Server Name Indication"
12932 When a TLS session is being established, if the client sends the Server
12933 Name Indication extension, the value will be placed in this variable.
12934 If the variable appears in &%tls_certificate%& then this option and
12935 some others, described in &<<SECTtlssni>>&,
12936 will be re-expanded early in the TLS session, to permit
12937 a different certificate to be presented (and optionally a different key to be
12938 used) to the client, based upon the value of the SNI extension.
12939
12940 The deprecated &$tls_sni$& variable refers to the inbound side
12941 except when used in the context of an outbound SMTP delivery, when it refers to
12942 the outbound.
12943
12944 .vitem &$tls_out_sni$&
12945 .vindex "&$tls_out_sni$&"
12946 .cindex "TLS" "Server Name Indication"
12947 During outbound
12948 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12949 the transport.
12950
12951 .vitem &$tod_bsdinbox$&
12952 .vindex "&$tod_bsdinbox$&"
12953 The time of day and the date, in the format required for BSD-style mailbox
12954 files, for example: Thu Oct 17 17:14:09 1995.
12955
12956 .vitem &$tod_epoch$&
12957 .vindex "&$tod_epoch$&"
12958 The time and date as a number of seconds since the start of the Unix epoch.
12959
12960 .vitem &$tod_epoch_l$&
12961 .vindex "&$tod_epoch_l$&"
12962 The time and date as a number of microseconds since the start of the Unix epoch.
12963
12964 .vitem &$tod_full$&
12965 .vindex "&$tod_full$&"
12966 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12967 +0100. The timezone is always given as a numerical offset from UTC, with
12968 positive values used for timezones that are ahead (east) of UTC, and negative
12969 values for those that are behind (west).
12970
12971 .vitem &$tod_log$&
12972 .vindex "&$tod_log$&"
12973 The time and date in the format used for writing Exim's log files, for example:
12974 1995-10-12 15:32:29, but without a timezone.
12975
12976 .vitem &$tod_logfile$&
12977 .vindex "&$tod_logfile$&"
12978 This variable contains the date in the format yyyymmdd. This is the format that
12979 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12980 flag.
12981
12982 .vitem &$tod_zone$&
12983 .vindex "&$tod_zone$&"
12984 This variable contains the numerical value of the local timezone, for example:
12985 -0500.
12986
12987 .vitem &$tod_zulu$&
12988 .vindex "&$tod_zulu$&"
12989 This variable contains the UTC date and time in &"Zulu"& format, as specified
12990 by ISO 8601, for example: 20030221154023Z.
12991
12992 .vitem &$transport_name$&
12993 .cindex "transport" "name"
12994 .cindex "name" "of transport"
12995 .vindex "&$transport_name$&"
12996 During the running of a transport, this variable contains its name.
12997
12998 .vitem &$value$&
12999 .vindex "&$value$&"
13000 This variable contains the result of an expansion lookup, extraction operation,
13001 or external command, as described above. It is also used during a
13002 &*reduce*& expansion.
13003
13004 .vitem &$verify_mode$&
13005 .vindex "&$verify_mode$&"
13006 While a router or transport is being run in verify mode
13007 or for cutthrough delivery,
13008 contains "S" for sender-verification or "R" for recipient-verification.
13009 Otherwise, empty.
13010
13011 .vitem &$version_number$&
13012 .vindex "&$version_number$&"
13013 The version number of Exim.
13014
13015 .vitem &$warn_message_delay$&
13016 .vindex "&$warn_message_delay$&"
13017 This variable is set only during the creation of a message warning about a
13018 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13019
13020 .vitem &$warn_message_recipients$&
13021 .vindex "&$warn_message_recipients$&"
13022 This variable is set only during the creation of a message warning about a
13023 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13024 .endlist
13025 .ecindex IIDstrexp
13026
13027
13028
13029 . ////////////////////////////////////////////////////////////////////////////
13030 . ////////////////////////////////////////////////////////////////////////////
13031
13032 .chapter "Embedded Perl" "CHAPperl"
13033 .scindex IIDperl "Perl" "calling from Exim"
13034 Exim can be built to include an embedded Perl interpreter. When this is done,
13035 Perl subroutines can be called as part of the string expansion process. To make
13036 use of the Perl support, you need version 5.004 or later of Perl installed on
13037 your system. To include the embedded interpreter in the Exim binary, include
13038 the line
13039 .code
13040 EXIM_PERL = perl.o
13041 .endd
13042 in your &_Local/Makefile_& and then build Exim in the normal way.
13043
13044
13045 .section "Setting up so Perl can be used" "SECID85"
13046 .oindex "&%perl_startup%&"
13047 Access to Perl subroutines is via a global configuration option called
13048 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13049 no &%perl_startup%& option in the Exim configuration file then no Perl
13050 interpreter is started and there is almost no overhead for Exim (since none of
13051 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13052 option then the associated value is taken to be Perl code which is executed in
13053 a newly created Perl interpreter.
13054
13055 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13056 need backslashes before any characters to escape special meanings. The option
13057 should usually be something like
13058 .code
13059 perl_startup = do '/etc/exim.pl'
13060 .endd
13061 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13062 use from Exim. Exim can be configured either to start up a Perl interpreter as
13063 soon as it is entered, or to wait until the first time it is needed. Starting
13064 the interpreter at the beginning ensures that it is done while Exim still has
13065 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13066 fact used in a particular run. Also, note that this does not mean that Exim is
13067 necessarily running as root when Perl is called at a later time. By default,
13068 the interpreter is started only when it is needed, but this can be changed in
13069 two ways:
13070
13071 .ilist
13072 .oindex "&%perl_at_start%&"
13073 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13074 a startup when Exim is entered.
13075 .next
13076 The command line option &%-ps%& also requests a startup when Exim is entered,
13077 overriding the setting of &%perl_at_start%&.
13078 .endlist
13079
13080 There is also a command line option &%-pd%& (for delay) which suppresses the
13081 initial startup, even if &%perl_at_start%& is set.
13082
13083 .new
13084 .ilist
13085 .oindex "&%perl_taintmode%&"
13086 .cindex "Perl" "taintmode"
13087 To provide more security executing Perl code via the embedded Perl
13088 interpeter, the &%perl_taintmode%& option can be set. This enables the
13089 taint mode of the Perl interpreter. You are encouraged to set this
13090 option to a true value. To avoid breaking existing installations, it
13091 defaults to false.
13092 .wen
13093
13094
13095 .section "Calling Perl subroutines" "SECID86"
13096 When the configuration file includes a &%perl_startup%& option you can make use
13097 of the string expansion item to call the Perl subroutines that are defined
13098 by the &%perl_startup%& code. The operator is used in any of the following
13099 forms:
13100 .code
13101 ${perl{foo}}
13102 ${perl{foo}{argument}}
13103 ${perl{foo}{argument1}{argument2} ... }
13104 .endd
13105 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13106 arguments may be passed. Passing more than this results in an expansion failure
13107 with an error message of the form
13108 .code
13109 Too many arguments passed to Perl subroutine "foo" (max is 8)
13110 .endd
13111 The return value of the Perl subroutine is evaluated in a scalar context before
13112 it is passed back to Exim to be inserted into the expanded string. If the
13113 return value is &'undef'&, the expansion is forced to fail in the same way as
13114 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13115 by obeying Perl's &%die%& function, the expansion fails with the error message
13116 that was passed to &%die%&.
13117
13118
13119 .section "Calling Exim functions from Perl" "SECID87"
13120 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13121 is available to call back into Exim's string expansion function. For example,
13122 the Perl code
13123 .code
13124 my $lp = Exim::expand_string('$local_part');
13125 .endd
13126 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13127 Note those are single quotes and not double quotes to protect against
13128 &$local_part$& being interpolated as a Perl variable.
13129
13130 If the string expansion is forced to fail by a &"fail"& item, the result of
13131 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13132 expansion string, the Perl call from the original expansion string fails with
13133 an appropriate error message, in the same way as if &%die%& were used.
13134
13135 .cindex "debugging" "from embedded Perl"
13136 .cindex "log" "writing from embedded Perl"
13137 Two other Exim functions are available for use from within Perl code.
13138 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13139 debugging is enabled. If you want a newline at the end, you must supply it.
13140 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13141 timestamp. In this case, you should not supply a terminating newline.
13142
13143
13144 .section "Use of standard output and error by Perl" "SECID88"
13145 .cindex "Perl" "standard output and error"
13146 You should not write to the standard error or output streams from within your
13147 Perl code, as it is not defined how these are set up. In versions of Exim
13148 before 4.50, it is possible for the standard output or error to refer to the
13149 SMTP connection during message reception via the daemon. Writing to this stream
13150 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13151 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13152 avoided, but the output is lost.
13153
13154 .cindex "Perl" "use of &%warn%&"
13155 The Perl &%warn%& statement writes to the standard error stream by default.
13156 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13157 you have no control. When Exim starts up the Perl interpreter, it arranges for
13158 output from the &%warn%& statement to be written to the Exim main log. You can
13159 change this by including appropriate Perl magic somewhere in your Perl code.
13160 For example, to discard &%warn%& output completely, you need this:
13161 .code
13162 $SIG{__WARN__} = sub { };
13163 .endd
13164 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13165 example, the code for the subroutine is empty, so it does nothing, but you can
13166 include any Perl code that you like. The text of the &%warn%& message is passed
13167 as the first subroutine argument.
13168 .ecindex IIDperl
13169
13170
13171 . ////////////////////////////////////////////////////////////////////////////
13172 . ////////////////////////////////////////////////////////////////////////////
13173
13174 .chapter "Starting the daemon and the use of network interfaces" &&&
13175          "CHAPinterfaces" &&&
13176          "Starting the daemon"
13177 .cindex "daemon" "starting"
13178 .cindex "interface" "listening"
13179 .cindex "network interface"
13180 .cindex "interface" "network"
13181 .cindex "IP address" "for listening"
13182 .cindex "daemon" "listening IP addresses"
13183 .cindex "TCP/IP" "setting listening interfaces"
13184 .cindex "TCP/IP" "setting listening ports"
13185 A host that is connected to a TCP/IP network may have one or more physical
13186 hardware network interfaces. Each of these interfaces may be configured as one
13187 or more &"logical"& interfaces, which are the entities that a program actually
13188 works with. Each of these logical interfaces is associated with an IP address.
13189 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13190 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13191 knowledge about the host's interfaces for use in three different circumstances:
13192
13193 .olist
13194 When a listening daemon is started, Exim needs to know which interfaces
13195 and ports to listen on.
13196 .next
13197 When Exim is routing an address, it needs to know which IP addresses
13198 are associated with local interfaces. This is required for the correct
13199 processing of MX lists by removing the local host and others with the
13200 same or higher priority values. Also, Exim needs to detect cases
13201 when an address is routed to an IP address that in fact belongs to the
13202 local host. Unless the &%self%& router option or the &%allow_localhost%&
13203 option of the smtp transport is set (as appropriate), this is treated
13204 as an error situation.
13205 .next
13206 When Exim connects to a remote host, it may need to know which interface to use
13207 for the outgoing connection.
13208 .endlist
13209
13210
13211 Exim's default behaviour is likely to be appropriate in the vast majority
13212 of cases. If your host has only one interface, and you want all its IP
13213 addresses to be treated in the same way, and you are using only the
13214 standard SMTP port, you should not need to take any special action. The
13215 rest of this chapter does not apply to you.
13216
13217 In a more complicated situation you may want to listen only on certain
13218 interfaces, or on different ports, and for this reason there are a number of
13219 options that can be used to influence Exim's behaviour. The rest of this
13220 chapter describes how they operate.
13221
13222 When a message is received over TCP/IP, the interface and port that were
13223 actually used are set in &$received_ip_address$& and &$received_port$&.
13224
13225
13226
13227 .section "Starting a listening daemon" "SECID89"
13228 When a listening daemon is started (by means of the &%-bd%& command line
13229 option), the interfaces and ports on which it listens are controlled by the
13230 following options:
13231
13232 .ilist
13233 &%daemon_smtp_ports%& contains a list of default ports
13234 or service names.
13235 (For backward compatibility, this option can also be specified in the singular.)
13236 .next
13237 &%local_interfaces%& contains list of interface IP addresses on which to
13238 listen. Each item may optionally also specify a port.
13239 .endlist
13240
13241 The default list separator in both cases is a colon, but this can be changed as
13242 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13243 it is usually best to change the separator to avoid having to double all the
13244 colons. For example:
13245 .code
13246 local_interfaces = <; 127.0.0.1 ; \
13247                       192.168.23.65 ; \
13248                       ::1 ; \
13249                       3ffe:ffff:836f::fe86:a061
13250 .endd
13251 There are two different formats for specifying a port along with an IP address
13252 in &%local_interfaces%&:
13253
13254 .olist
13255 The port is added onto the address with a dot separator. For example, to listen
13256 on port 1234 on two different IP addresses:
13257 .code
13258 local_interfaces = <; 192.168.23.65.1234 ; \
13259                       3ffe:ffff:836f::fe86:a061.1234
13260 .endd
13261 .next
13262 The IP address is enclosed in square brackets, and the port is added
13263 with a colon separator, for example:
13264 .code
13265 local_interfaces = <; [192.168.23.65]:1234 ; \
13266                       [3ffe:ffff:836f::fe86:a061]:1234
13267 .endd
13268 .endlist
13269
13270 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13271 default setting contains just one port:
13272 .code
13273 daemon_smtp_ports = smtp
13274 .endd
13275 If more than one port is listed, each interface that does not have its own port
13276 specified listens on all of them. Ports that are listed in
13277 &%daemon_smtp_ports%& can be identified either by name (defined in
13278 &_/etc/services_&) or by number. However, when ports are given with individual
13279 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13280
13281
13282
13283 .section "Special IP listening addresses" "SECID90"
13284 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13285 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13286 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13287 instead of setting up separate listening sockets for each interface. The
13288 default value of &%local_interfaces%& is
13289 .code
13290 local_interfaces = 0.0.0.0
13291 .endd
13292 when Exim is built without IPv6 support; otherwise it is:
13293 .code
13294 local_interfaces = <; ::0 ; 0.0.0.0
13295 .endd
13296 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13297
13298
13299
13300 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13301 The &%-oX%& command line option can be used to override the values of
13302 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13303 instance. Another way of doing this would be to use macros and the &%-D%&
13304 option. However, &%-oX%& can be used by any admin user, whereas modification of
13305 the runtime configuration by &%-D%& is allowed only when the caller is root or
13306 exim.
13307
13308 The value of &%-oX%& is a list of items. The default colon separator can be
13309 changed in the usual way if required. If there are any items that do not
13310 contain dots or colons (that is, are not IP addresses), the value of
13311 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13312 items that do contain dots or colons, the value of &%local_interfaces%& is
13313 replaced by those items. Thus, for example,
13314 .code
13315 -oX 1225
13316 .endd
13317 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13318 whereas
13319 .code
13320 -oX 192.168.34.5.1125
13321 .endd
13322 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13323 (However, since &%local_interfaces%& now contains no items without ports, the
13324 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13325
13326
13327
13328 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13329 .cindex "ssmtp protocol"
13330 .cindex "smtps protocol"
13331 .cindex "SMTP" "ssmtp protocol"
13332 .cindex "SMTP" "smtps protocol"
13333 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13334 before the STARTTLS command was standardized for SMTP. Some legacy clients
13335 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13336 list of port numbers or service names,
13337 connections to those ports must use SSMTP. The most
13338 common use of this option is expected to be
13339 .code
13340 tls_on_connect_ports = 465
13341 .endd
13342 because 465 is the usual port number used by the legacy clients. There is also
13343 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13344 this way when a daemon is started.
13345
13346 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13347 daemon to listen on those ports. You must still specify them in
13348 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13349 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13350 connections via the daemon.)
13351
13352
13353
13354
13355 .section "IPv6 address scopes" "SECID92"
13356 .cindex "IPv6" "address scopes"
13357 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13358 can, in principle, have the same link-local IPv6 address on different
13359 interfaces. Thus, additional information is needed, over and above the IP
13360 address, to distinguish individual interfaces. A convention of using a
13361 percent sign followed by something (often the interface name) has been
13362 adopted in some cases, leading to addresses like this:
13363 .code
13364 fe80::202:b3ff:fe03:45c1%eth0
13365 .endd
13366 To accommodate this usage, a percent sign followed by an arbitrary string is
13367 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13368 to convert a textual IPv6 address for actual use. This function recognizes the
13369 percent convention in operating systems that support it, and it processes the
13370 address appropriately. Unfortunately, some older libraries have problems with
13371 &[getaddrinfo()]&. If
13372 .code
13373 IPV6_USE_INET_PTON=yes
13374 .endd
13375 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13376 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13377 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13378 function.) Of course, this means that the additional functionality of
13379 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13380
13381 .section "Disabling IPv6" "SECID93"
13382 .cindex "IPv6" "disabling"
13383 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13384 run on a host whose kernel does not support IPv6. The binary will fall back to
13385 using IPv4, but it may waste resources looking up AAAA records, and trying to
13386 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13387 .oindex "&%disable_ipv6%&"
13388 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13389 activities take place. AAAA records are never looked up, and any IPv6 addresses
13390 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13391 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13392 to handle IPv6 literal addresses.
13393
13394 On the other hand, when IPv6 is in use, there may be times when you want to
13395 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13396 option to globally suppress the lookup of AAAA records for specified domains,
13397 and you can use the &%ignore_target_hosts%& generic router option to ignore
13398 IPv6 addresses in an individual router.
13399
13400
13401
13402 .section "Examples of starting a listening daemon" "SECID94"
13403 The default case in an IPv6 environment is
13404 .code
13405 daemon_smtp_ports = smtp
13406 local_interfaces = <; ::0 ; 0.0.0.0
13407 .endd
13408 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13409 Either one or two sockets may be used, depending on the characteristics of
13410 the TCP/IP stack. (This is complicated and messy; for more information,
13411 read the comments in the &_daemon.c_& source file.)
13412
13413 To specify listening on ports 25 and 26 on all interfaces:
13414 .code
13415 daemon_smtp_ports = 25 : 26
13416 .endd
13417 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13418 .code
13419 local_interfaces = <; ::0.25     ; ::0.26 \
13420                       0.0.0.0.25 ; 0.0.0.0.26
13421 .endd
13422 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13423 IPv4 loopback address only:
13424 .code
13425 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13426 .endd
13427 To specify listening on the default port on specific interfaces only:
13428 .code
13429 local_interfaces = 10.0.0.67 : 192.168.34.67
13430 .endd
13431 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13432
13433
13434
13435 .section "Recognizing the local host" "SECTreclocipadd"
13436 The &%local_interfaces%& option is also used when Exim needs to determine
13437 whether or not an IP address refers to the local host. That is, the IP
13438 addresses of all the interfaces on which a daemon is listening are always
13439 treated as local.
13440
13441 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13442 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13443 available interfaces from the operating system, and extracts the relevant
13444 (that is, IPv4 or IPv6) addresses to use for checking.
13445
13446 Some systems set up large numbers of virtual interfaces in order to provide
13447 many virtual web servers. In this situation, you may want to listen for
13448 email on only a few of the available interfaces, but nevertheless treat all
13449 interfaces as local when routing. You can do this by setting
13450 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13451 &"all"& wildcard values. These addresses are recognized as local, but are not
13452 used for listening. Consider this example:
13453 .code
13454 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13455                       192.168.53.235 ; \
13456                       3ffe:2101:12:1:a00:20ff:fe86:a061
13457
13458 extra_local_interfaces = <; ::0 ; 0.0.0.0
13459 .endd
13460 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13461 address, but all available interface addresses are treated as local when
13462 Exim is routing.
13463
13464 In some environments the local host name may be in an MX list, but with an IP
13465 address that is not assigned to any local interface. In other cases it may be
13466 desirable to treat other host names as if they referred to the local host. Both
13467 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13468 This contains host names rather than IP addresses. When a host is referenced
13469 during routing, either via an MX record or directly, it is treated as the local
13470 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13471 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13472
13473
13474
13475 .section "Delivering to a remote host" "SECID95"
13476 Delivery to a remote host is handled by the smtp transport. By default, it
13477 allows the system's TCP/IP functions to choose which interface to use (if
13478 there is more than one) when connecting to a remote host. However, the
13479 &%interface%& option can be set to specify which interface is used. See the
13480 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13481 details.
13482
13483
13484
13485
13486 . ////////////////////////////////////////////////////////////////////////////
13487 . ////////////////////////////////////////////////////////////////////////////
13488
13489 .chapter "Main configuration" "CHAPmainconfig"
13490 .scindex IIDconfima "configuration file" "main section"
13491 .scindex IIDmaiconf "main configuration"
13492 The first part of the run time configuration file contains three types of item:
13493
13494 .ilist
13495 Macro definitions: These lines start with an upper case letter. See section
13496 &<<SECTmacrodefs>>& for details of macro processing.
13497 .next
13498 Named list definitions: These lines start with one of the words &"domainlist"&,
13499 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13500 section &<<SECTnamedlists>>&.
13501 .next
13502 Main configuration settings: Each setting occupies one line of the file
13503 (with possible continuations). If any setting is preceded by the word
13504 &"hide"&, the &%-bP%& command line option displays its value to admin users
13505 only. See section &<<SECTcos>>& for a description of the syntax of these option
13506 settings.
13507 .endlist
13508
13509 This chapter specifies all the main configuration options, along with their
13510 types and default values. For ease of finding a particular option, they appear
13511 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13512 are now so many options, they are first listed briefly in functional groups, as
13513 an aid to finding the name of the option you are looking for. Some options are
13514 listed in more than one group.
13515
13516 .section "Miscellaneous" "SECID96"
13517 .table2
13518 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13519 .row &%disable_ipv6%&                "do no IPv6 processing"
13520 .row &%keep_malformed%&              "for broken files &-- should not happen"
13521 .row &%localhost_number%&            "for unique message ids in clusters"
13522 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13523 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13524 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13525 .row &%print_topbitchars%&           "top-bit characters are printing"
13526 .row &%timezone%&                    "force time zone"
13527 .endtable
13528
13529
13530 .section "Exim parameters" "SECID97"
13531 .table2
13532 .row &%exim_group%&                  "override compiled-in value"
13533 .row &%exim_path%&                   "override compiled-in value"
13534 .row &%exim_user%&                   "override compiled-in value"
13535 .row &%primary_hostname%&            "default from &[uname()]&"
13536 .row &%split_spool_directory%&       "use multiple directories"
13537 .row &%spool_directory%&             "override compiled-in value"
13538 .endtable
13539
13540
13541
13542 .section "Privilege controls" "SECID98"
13543 .table2
13544 .row &%admin_groups%&                "groups that are Exim admin users"
13545 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13546 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13547 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13548 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13549 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13550 .row &%never_users%&                 "do not run deliveries as these"
13551 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13552 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13553 .row &%trusted_groups%&              "groups that are trusted"
13554 .row &%trusted_users%&               "users that are trusted"
13555 .endtable
13556
13557
13558
13559 .section "Logging" "SECID99"
13560 .table2
13561 .row &%event_action%&                "custom logging"
13562 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13563 .row &%log_file_path%&               "override compiled-in value"
13564 .row &%log_selector%&                "set/unset optional logging"
13565 .row &%log_timezone%&                "add timezone to log lines"
13566 .row &%message_logs%&                "create per-message logs"
13567 .row &%preserve_message_logs%&       "after message completion"
13568 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13569 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13570 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13571 .row &%syslog_facility%&             "set syslog &""facility""& field"
13572 .row &%syslog_processname%&          "set syslog &""ident""& field"
13573 .row &%syslog_timestamp%&            "timestamp syslog lines"
13574 .row &%write_rejectlog%&             "control use of message log"
13575 .endtable
13576
13577
13578
13579 .section "Frozen messages" "SECID100"
13580 .table2
13581 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13582 .row &%freeze_tell%&                 "send message when freezing"
13583 .row &%move_frozen_messages%&        "to another directory"
13584 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13585 .endtable
13586
13587
13588
13589 .section "Data lookups" "SECID101"
13590 .table2
13591 .row &%ibase_servers%&               "InterBase servers"
13592 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13593 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13594 .row &%ldap_cert_file%&              "client cert file for LDAP"
13595 .row &%ldap_cert_key%&               "client key file for LDAP"
13596 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13597 .row &%ldap_default_servers%&        "used if no server in query"
13598 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13599 .row &%ldap_start_tls%&              "require TLS within LDAP"
13600 .row &%ldap_version%&                "set protocol version"
13601 .row &%lookup_open_max%&             "lookup files held open"
13602 .row &%mysql_servers%&               "default MySQL servers"
13603 .row &%oracle_servers%&              "Oracle servers"
13604 .row &%pgsql_servers%&               "default PostgreSQL servers"
13605 .row &%sqlite_lock_timeout%&         "as it says"
13606 .endtable
13607
13608
13609
13610 .section "Message ids" "SECID102"
13611 .table2
13612 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13613 .row &%message_id_header_text%&      "ditto"
13614 .endtable
13615
13616
13617
13618 .section "Embedded Perl Startup" "SECID103"
13619 .table2
13620 .row &%perl_at_start%&               "always start the interpreter"
13621 .row &%perl_startup%&                "code to obey when starting Perl"
13622 .row &%perl_taintmode%&              "enable taint mode in Perl"
13623 .endtable
13624
13625
13626
13627 .section "Daemon" "SECID104"
13628 .table2
13629 .row &%daemon_smtp_ports%&           "default ports"
13630 .row &%daemon_startup_retries%&      "number of times to retry"
13631 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13632 .row &%extra_local_interfaces%&      "not necessarily listened on"
13633 .row &%local_interfaces%&            "on which to listen, with optional ports"
13634 .row &%pid_file_path%&               "override compiled-in value"
13635 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13636 .endtable
13637
13638
13639
13640 .section "Resource control" "SECID105"
13641 .table2
13642 .row &%check_log_inodes%&            "before accepting a message"
13643 .row &%check_log_space%&             "before accepting a message"
13644 .row &%check_spool_inodes%&          "before accepting a message"
13645 .row &%check_spool_space%&           "before accepting a message"
13646 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13647 .row &%queue_only_load%&             "queue incoming if load high"
13648 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13649 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13650 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13651 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13652 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13653 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13654 .row &%smtp_accept_max_per_connection%& "messages per connection"
13655 .row &%smtp_accept_max_per_host%&    "connections from one host"
13656 .row &%smtp_accept_queue%&           "queue mail if more connections"
13657 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13658                                            connection"
13659 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13660 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13661 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13662 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13663 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13664 .endtable
13665
13666
13667
13668 .section "Policy controls" "SECID106"
13669 .table2
13670 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13671 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13672 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13673 .row &%acl_smtp_auth%&               "ACL for AUTH"
13674 .row &%acl_smtp_connect%&            "ACL for connection"
13675 .row &%acl_smtp_data%&               "ACL for DATA"
13676 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13677 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13678 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13679 .row &%acl_smtp_expn%&               "ACL for EXPN"
13680 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13681 .row &%acl_smtp_mail%&               "ACL for MAIL"
13682 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13683 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13684 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13685 .row &%acl_smtp_predata%&            "ACL for start of data"
13686 .row &%acl_smtp_quit%&               "ACL for QUIT"
13687 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13688 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13689 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13690 .row &%av_scanner%&                  "specify virus scanner"
13691 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13692                                       words""&"
13693 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13694 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13695 .row &%header_maxsize%&              "total size of message header"
13696 .row &%header_line_maxsize%&         "individual header line limit"
13697 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13698 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13699 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13700 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13701 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13702 .row &%host_lookup%&                 "host name looked up for these hosts"
13703 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13704 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13705 .row &%host_reject_connection%&      "reject connection from these hosts"
13706 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13707 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13708 .row &%message_size_limit%&          "for all messages"
13709 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13710 .row &%spamd_address%&               "set interface to SpamAssassin"
13711 .row &%strict_acl_vars%&             "object to unset ACL variables"
13712 .endtable
13713
13714
13715
13716 .section "Callout cache" "SECID107"
13717 .table2
13718 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13719                                          item"
13720 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13721                                          item"
13722 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13723 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13724 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13725 .endtable
13726
13727
13728
13729 .section "TLS" "SECID108"
13730 .table2
13731 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13732 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13733 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13734 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13735 .row &%tls_certificate%&             "location of server certificate"
13736 .row &%tls_crl%&                     "certificate revocation list"
13737 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13738 .row &%tls_dhparam%&                 "DH parameters for server"
13739 .row &%tls_eccurve%&                 "EC curve selection for server"
13740 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13741 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13742 .row &%tls_privatekey%&              "location of server private key"
13743 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13744 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13745 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13746 .row &%tls_verify_certificates%&     "expected client certificates"
13747 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13748 .endtable
13749
13750
13751
13752 .section "Local user handling" "SECID109"
13753 .table2
13754 .row &%finduser_retries%&            "useful in NIS environments"
13755 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13756 .row &%gecos_pattern%&               "ditto"
13757 .row &%max_username_length%&         "for systems that truncate"
13758 .row &%unknown_login%&               "used when no login name found"
13759 .row &%unknown_username%&            "ditto"
13760 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13761 .row &%uucp_from_sender%&            "ditto"
13762 .endtable
13763
13764
13765
13766 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13767 .table2
13768 .row &%header_maxsize%&              "total size of message header"
13769 .row &%header_line_maxsize%&         "individual header line limit"
13770 .row &%message_size_limit%&          "applies to all messages"
13771 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13772 .row &%received_header_text%&        "expanded to make &'Received:'&"
13773 .row &%received_headers_max%&        "for mail loop detection"
13774 .row &%recipients_max%&              "limit per message"
13775 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13776 .endtable
13777
13778
13779
13780
13781 .section "Non-SMTP incoming messages" "SECID111"
13782 .table2
13783 .row &%receive_timeout%&             "for non-SMTP messages"
13784 .endtable
13785
13786
13787
13788
13789
13790 .section "Incoming SMTP messages" "SECID112"
13791 See also the &'Policy controls'& section above.
13792
13793 .table2
13794 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13795 .row &%host_lookup%&                 "host name looked up for these hosts"
13796 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13797 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13798 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13799 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13800 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13801 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13802 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13803 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13804 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13805 .row &%smtp_accept_max_per_connection%& "messages per connection"
13806 .row &%smtp_accept_max_per_host%&    "connections from one host"
13807 .row &%smtp_accept_queue%&           "queue mail if more connections"
13808 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13809                                            connection"
13810 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13811 .row &%smtp_active_hostname%&        "host name to use in messages"
13812 .row &%smtp_banner%&                 "text for welcome banner"
13813 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13814 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13815 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13816 .row &%smtp_etrn_command%&           "what to run for ETRN"
13817 .row &%smtp_etrn_serialize%&         "only one at once"
13818 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13819 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13820 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13821 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13822 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13823 .row &%smtp_receive_timeout%&        "per command or data line"
13824 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13825 .row &%smtp_return_error_details%&   "give detail on rejections"
13826 .endtable
13827
13828
13829
13830 .section "SMTP extensions" "SECID113"
13831 .table2
13832 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13833 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13834 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13835 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13836 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13837 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13838 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13839 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13840 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13841 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13842 .endtable
13843
13844
13845
13846 .section "Processing messages" "SECID114"
13847 .table2
13848 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13849 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13850 .row &%allow_utf8_domains%&          "in addresses"
13851 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13852                                       words""&"
13853 .row &%delivery_date_remove%&        "from incoming messages"
13854 .row &%envelope_to_remove%&          "from incoming messages"
13855 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13856 .row &%headers_charset%&             "default for translations"
13857 .row &%qualify_domain%&              "default for senders"
13858 .row &%qualify_recipient%&           "default for recipients"
13859 .row &%return_path_remove%&          "from incoming messages"
13860 .row &%strip_excess_angle_brackets%& "in addresses"
13861 .row &%strip_trailing_dot%&          "at end of addresses"
13862 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13863 .endtable
13864
13865
13866
13867 .section "System filter" "SECID115"
13868 .table2
13869 .row &%system_filter%&               "locate system filter"
13870 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13871                                             directory"
13872 .row &%system_filter_file_transport%& "transport for delivery to a file"
13873 .row &%system_filter_group%&         "group for filter running"
13874 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13875 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13876 .row &%system_filter_user%&          "user for filter running"
13877 .endtable
13878
13879
13880
13881 .section "Routing and delivery" "SECID116"
13882 .table2
13883 .row &%disable_ipv6%&                "do no IPv6 processing"
13884 .row &%dns_again_means_nonexist%&    "for broken domains"
13885 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13886 .row &%dns_dnssec_ok%&               "parameter for resolver"
13887 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13888 .row &%dns_retrans%&                 "parameter for resolver"
13889 .row &%dns_retry%&                   "parameter for resolver"
13890 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13891 .row &%dns_use_edns0%&               "parameter for resolver"
13892 .row &%hold_domains%&                "hold delivery for these domains"
13893 .row &%local_interfaces%&            "for routing checks"
13894 .row &%queue_domains%&               "no immediate delivery for these"
13895 .row &%queue_only%&                  "no immediate delivery at all"
13896 .row &%queue_only_file%&             "no immediate delivery if file exists"
13897 .row &%queue_only_load%&             "no immediate delivery if load is high"
13898 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13899 .row &%queue_only_override%&         "allow command line to override"
13900 .row &%queue_run_in_order%&          "order of arrival"
13901 .row &%queue_run_max%&               "of simultaneous queue runners"
13902 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13903 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13904 .row &%remote_sort_domains%&         "order of remote deliveries"
13905 .row &%retry_data_expire%&           "timeout for retry data"
13906 .row &%retry_interval_max%&          "safety net for retry rules"
13907 .endtable
13908
13909
13910
13911 .section "Bounce and warning messages" "SECID117"
13912 .table2
13913 .row &%bounce_message_file%&         "content of bounce"
13914 .row &%bounce_message_text%&         "content of bounce"
13915 .row &%bounce_return_body%&          "include body if returning message"
13916 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13917 .row &%bounce_return_message%&       "include original message in bounce"
13918 .row &%bounce_return_size_limit%&    "limit on returned message"
13919 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13920 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13921 .row &%errors_copy%&                 "copy bounce messages"
13922 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13923 .row &%delay_warning%&               "time schedule"
13924 .row &%delay_warning_condition%&     "condition for warning messages"
13925 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13926 .row &%smtp_return_error_details%&   "give detail on rejections"
13927 .row &%warn_message_file%&           "content of warning message"
13928 .endtable
13929
13930
13931
13932 .section "Alphabetical list of main options" "SECTalomo"
13933 Those options that undergo string expansion before use are marked with
13934 &dagger;.
13935
13936 .option accept_8bitmime main boolean true
13937 .cindex "8BITMIME"
13938 .cindex "8-bit characters"
13939 .cindex "log" "selectors"
13940 .cindex "log" "8BITMIME"
13941 This option causes Exim to send 8BITMIME in its response to an SMTP
13942 EHLO command, and to accept the BODY= parameter on MAIL commands.
13943 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13944 takes no steps to do anything special with messages received by this route.
13945
13946 Historically Exim kept this option off by default, but the maintainers
13947 feel that in today's Internet, this causes more problems than it solves.
13948 It now defaults to true.
13949 A more detailed analysis of the issues is provided by Dan Bernstein:
13950 .display
13951 &url(http://cr.yp.to/smtp/8bitmime.html)
13952 .endd
13953
13954 To log received 8BITMIME status use
13955 .code
13956 log_selector = +8bitmime
13957 .endd
13958
13959 .option acl_not_smtp main string&!! unset
13960 .cindex "&ACL;" "for non-SMTP messages"
13961 .cindex "non-SMTP messages" "ACLs for"
13962 This option defines the ACL that is run when a non-SMTP message has been
13963 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13964 further details.
13965
13966 .option acl_not_smtp_mime main string&!! unset
13967 This option defines the ACL that is run for individual MIME parts of non-SMTP
13968 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13969 SMTP messages.
13970
13971 .option acl_not_smtp_start main string&!! unset
13972 .cindex "&ACL;" "at start of non-SMTP message"
13973 .cindex "non-SMTP messages" "ACLs for"
13974 This option defines the ACL that is run before Exim starts reading a
13975 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13976
13977 .option acl_smtp_auth main string&!! unset
13978 .cindex "&ACL;" "setting up for SMTP commands"
13979 .cindex "AUTH" "ACL for"
13980 This option defines the ACL that is run when an SMTP AUTH command is
13981 received. See chapter &<<CHAPACL>>& for further details.
13982
13983 .option acl_smtp_connect main string&!! unset
13984 .cindex "&ACL;" "on SMTP connection"
13985 This option defines the ACL that is run when an SMTP connection is received.
13986 See chapter &<<CHAPACL>>& for further details.
13987
13988 .option acl_smtp_data main string&!! unset
13989 .cindex "DATA" "ACL for"
13990 This option defines the ACL that is run after an SMTP DATA command has been
13991 processed and the message itself has been received, but before the final
13992 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13993
13994 .option acl_smtp_data_prdr main string&!! accept
13995 .cindex "PRDR" "ACL for"
13996 .cindex "DATA" "PRDR ACL for"
13997 .cindex "&ACL;" "PRDR-related"
13998 .cindex "&ACL;" "per-user data processing"
13999 This option defines the ACL that,
14000 if the PRDR feature has been negotiated,
14001 is run for each recipient after an SMTP DATA command has been
14002 processed and the message itself has been received, but before the
14003 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14004
14005 .option acl_smtp_dkim main string&!! unset
14006 .cindex DKIM "ACL for"
14007 This option defines the ACL that is run for each DKIM signature
14008 of a received message.
14009 See chapter &<<CHAPdkim>>& for further details.
14010
14011 .option acl_smtp_etrn main string&!! unset
14012 .cindex "ETRN" "ACL for"
14013 This option defines the ACL that is run when an SMTP ETRN command is
14014 received. See chapter &<<CHAPACL>>& for further details.
14015
14016 .option acl_smtp_expn main string&!! unset
14017 .cindex "EXPN" "ACL for"
14018 This option defines the ACL that is run when an SMTP EXPN command is
14019 received. See chapter &<<CHAPACL>>& for further details.
14020
14021 .option acl_smtp_helo main string&!! unset
14022 .cindex "EHLO" "ACL for"
14023 .cindex "HELO" "ACL for"
14024 This option defines the ACL that is run when an SMTP EHLO or HELO
14025 command is received. See chapter &<<CHAPACL>>& for further details.
14026
14027
14028 .option acl_smtp_mail main string&!! unset
14029 .cindex "MAIL" "ACL for"
14030 This option defines the ACL that is run when an SMTP MAIL command is
14031 received. See chapter &<<CHAPACL>>& for further details.
14032
14033 .option acl_smtp_mailauth main string&!! unset
14034 .cindex "AUTH" "on MAIL command"
14035 This option defines the ACL that is run when there is an AUTH parameter on
14036 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14037 &<<CHAPSMTPAUTH>>& for details of authentication.
14038
14039 .option acl_smtp_mime main string&!! unset
14040 .cindex "MIME content scanning" "ACL for"
14041 This option is available when Exim is built with the content-scanning
14042 extension. It defines the ACL that is run for each MIME part in a message. See
14043 section &<<SECTscanmimepart>>& for details.
14044
14045 .option acl_smtp_notquit main string&!! unset
14046 .cindex "not-QUIT, ACL for"
14047 This option defines the ACL that is run when an SMTP session
14048 ends without a QUIT command being received.
14049 See chapter &<<CHAPACL>>& for further details.
14050
14051 .option acl_smtp_predata main string&!! unset
14052 This option defines the ACL that is run when an SMTP DATA command is
14053 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14054 further details.
14055
14056 .option acl_smtp_quit main string&!! unset
14057 .cindex "QUIT, ACL for"
14058 This option defines the ACL that is run when an SMTP QUIT command is
14059 received. See chapter &<<CHAPACL>>& for further details.
14060
14061 .option acl_smtp_rcpt main string&!! unset
14062 .cindex "RCPT" "ACL for"
14063 This option defines the ACL that is run when an SMTP RCPT command is
14064 received. See chapter &<<CHAPACL>>& for further details.
14065
14066 .option acl_smtp_starttls main string&!! unset
14067 .cindex "STARTTLS, ACL for"
14068 This option defines the ACL that is run when an SMTP STARTTLS command is
14069 received. See chapter &<<CHAPACL>>& for further details.
14070
14071 .option acl_smtp_vrfy main string&!! unset
14072 .cindex "VRFY" "ACL for"
14073 This option defines the ACL that is run when an SMTP VRFY command is
14074 received. See chapter &<<CHAPACL>>& for further details.
14075
14076 .option add_environment main "string list" empty
14077 .cindex "environment" "set values"
14078 This option allows to set individual environment variables that the
14079 currently linked libraries and programs in child processes use.
14080 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14081
14082 .option admin_groups main "string list&!!" unset
14083 .cindex "admin user"
14084 This option is expanded just once, at the start of Exim's processing. If the
14085 current group or any of the supplementary groups of an Exim caller is in this
14086 colon-separated list, the caller has admin privileges. If all your system
14087 programmers are in a specific group, for example, you can give them all Exim
14088 admin privileges by putting that group in &%admin_groups%&. However, this does
14089 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14090 To permit this, you have to add individuals to the Exim group.
14091
14092 .option allow_domain_literals main boolean false
14093 .cindex "domain literal"
14094 If this option is set, the RFC 2822 domain literal format is permitted in
14095 email addresses. The option is not set by default, because the domain literal
14096 format is not normally required these days, and few people know about it. It
14097 has, however, been exploited by mail abusers.
14098
14099 Unfortunately, it seems that some DNS black list maintainers are using this
14100 format to report black listing to postmasters. If you want to accept messages
14101 addressed to your hosts by IP address, you need to set
14102 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14103 domains (defined in the named domain list &%local_domains%& in the default
14104 configuration). This &"magic string"& matches the domain literal form of all
14105 the local host's IP addresses.
14106
14107
14108 .option allow_mx_to_ip main boolean false
14109 .cindex "MX record" "pointing to IP address"
14110 It appears that more and more DNS zone administrators are breaking the rules
14111 and putting domain names that look like IP addresses on the right hand side of
14112 MX records. Exim follows the rules and rejects this, giving an error message
14113 that explains the misconfiguration. However, some other MTAs support this
14114 practice, so to avoid &"Why can't Exim do this?"& complaints,
14115 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14116 recommended, except when you have no other choice.
14117
14118 .option allow_utf8_domains main boolean false
14119 .cindex "domain" "UTF-8 characters in"
14120 .cindex "UTF-8" "in domain name"
14121 Lots of discussion is going on about internationalized domain names. One
14122 camp is strongly in favour of just using UTF-8 characters, and it seems
14123 that at least two other MTAs permit this. This option allows Exim users to
14124 experiment if they wish.
14125
14126 If it is set true, Exim's domain parsing function allows valid
14127 UTF-8 multicharacters to appear in domain name components, in addition to
14128 letters, digits, and hyphens. However, just setting this option is not
14129 enough; if you want to look up these domain names in the DNS, you must also
14130 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14131 suitable setting is:
14132 .code
14133 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14134   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14135 .endd
14136 Alternatively, you can just disable this feature by setting
14137 .code
14138 dns_check_names_pattern =
14139 .endd
14140 That is, set the option to an empty string so that no check is done.
14141
14142
14143 .option auth_advertise_hosts main "host list&!!" *
14144 .cindex "authentication" "advertising"
14145 .cindex "AUTH" "advertising"
14146 If any server authentication mechanisms are configured, Exim advertises them in
14147 response to an EHLO command only if the calling host matches this list.
14148 Otherwise, Exim does not advertise AUTH.
14149 Exim does not accept AUTH commands from clients to which it has not
14150 advertised the availability of AUTH. The advertising of individual
14151 authentication mechanisms can be controlled by the use of the
14152 &%server_advertise_condition%& generic authenticator option on the individual
14153 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14154
14155 Certain mail clients (for example, Netscape) require the user to provide a name
14156 and password for authentication if AUTH is advertised, even though it may
14157 not be needed (the host may accept messages from hosts on its local LAN without
14158 authentication, for example). The &%auth_advertise_hosts%& option can be used
14159 to make these clients more friendly by excluding them from the set of hosts to
14160 which Exim advertises AUTH.
14161
14162 .cindex "AUTH" "advertising when encrypted"
14163 If you want to advertise the availability of AUTH only when the connection
14164 is encrypted using TLS, you can make use of the fact that the value of this
14165 option is expanded, with a setting like this:
14166 .code
14167 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14168 .endd
14169 .vindex "&$tls_in_cipher$&"
14170 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14171 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14172 expansion is *, which matches all hosts.
14173
14174
14175 .option auto_thaw main time 0s
14176 .cindex "thawing messages"
14177 .cindex "unfreezing messages"
14178 If this option is set to a time greater than zero, a queue runner will try a
14179 new delivery attempt on any frozen message, other than a bounce message, if
14180 this much time has passed since it was frozen. This may result in the message
14181 being re-frozen if nothing has changed since the last attempt. It is a way of
14182 saying &"keep on trying, even though there are big problems"&.
14183
14184 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14185 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14186 thought to be very useful any more, and its use should probably be avoided.
14187
14188
14189 .option av_scanner main string "see below"
14190 This option is available if Exim is built with the content-scanning extension.
14191 It specifies which anti-virus scanner to use. The default value is:
14192 .code
14193 sophie:/var/run/sophie
14194 .endd
14195 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14196 before use. See section &<<SECTscanvirus>>& for further details.
14197
14198
14199 .option bi_command main string unset
14200 .oindex "&%-bi%&"
14201 This option supplies the name of a command that is run when Exim is called with
14202 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14203 just the command name, it is not a complete command line. If an argument is
14204 required, it must come from the &%-oA%& command line option.
14205
14206
14207 .option bounce_message_file main string unset
14208 .cindex "bounce message" "customizing"
14209 .cindex "customizing" "bounce message"
14210 This option defines a template file containing paragraphs of text to be used
14211 for constructing bounce messages.  Details of the file's contents are given in
14212 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14213
14214
14215 .option bounce_message_text main string unset
14216 When this option is set, its contents are included in the default bounce
14217 message immediately after &"This message was created automatically by mail
14218 delivery software."& It is not used if &%bounce_message_file%& is set.
14219
14220 .option bounce_return_body main boolean true
14221 .cindex "bounce message" "including body"
14222 This option controls whether the body of an incoming message is included in a
14223 bounce message when &%bounce_return_message%& is true. The default setting
14224 causes the entire message, both header and body, to be returned (subject to the
14225 value of &%bounce_return_size_limit%&). If this option is false, only the
14226 message header is included. In the case of a non-SMTP message containing an
14227 error that is detected during reception, only those header lines preceding the
14228 point at which the error was detected are returned.
14229 .cindex "bounce message" "including original"
14230
14231 .option bounce_return_linesize_limit main integer 998
14232 .cindex "size" "of bounce lines, limit"
14233 .cindex "bounce message" "line length limit"
14234 .cindex "limit" "bounce message line length"
14235 This option sets a limit in bytes on the line length of messages
14236 that are returned to senders due to delivery problems,
14237 when &%bounce_return_message%& is true.
14238 The default value corresponds to RFC limits.
14239 If the message being returned has lines longer than this value it is
14240 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14241
14242 The option also applies to bounces returned when an error is detected
14243 during reception of a message.
14244 In this case lines from the original are truncated.
14245
14246 The option does not apply to messages generated by an &(autoreply)& transport.
14247
14248
14249 .option bounce_return_message main boolean true
14250 If this option is set false, none of the original message is included in
14251 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14252 &%bounce_return_body%&.
14253
14254
14255 .option bounce_return_size_limit main integer 100K
14256 .cindex "size" "of bounce, limit"
14257 .cindex "bounce message" "size limit"
14258 .cindex "limit" "bounce message size"
14259 This option sets a limit in bytes on the size of messages that are returned to
14260 senders as part of bounce messages when &%bounce_return_message%& is true. The
14261 limit should be less than the value of the global &%message_size_limit%& and of
14262 any &%message_size_limit%& settings on transports, to allow for the bounce text
14263 that Exim generates. If this option is set to zero there is no limit.
14264
14265 When the body of any message that is to be included in a bounce message is
14266 greater than the limit, it is truncated, and a comment pointing this out is
14267 added at the top. The actual cutoff may be greater than the value given, owing
14268 to the use of buffering for transferring the message in chunks (typically 8K in
14269 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14270 messages.
14271
14272 .option bounce_sender_authentication main string unset
14273 .cindex "bounce message" "sender authentication"
14274 .cindex "authentication" "bounce message"
14275 .cindex "AUTH" "on bounce message"
14276 This option provides an authenticated sender address that is sent with any
14277 bounce messages generated by Exim that are sent over an authenticated SMTP
14278 connection. A typical setting might be:
14279 .code
14280 bounce_sender_authentication = mailer-daemon@my.domain.example
14281 .endd
14282 which would cause bounce messages to be sent using the SMTP command:
14283 .code
14284 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14285 .endd
14286 The value of &%bounce_sender_authentication%& must always be a complete email
14287 address.
14288
14289 .option callout_domain_negative_expire main time 3h
14290 .cindex "caching" "callout timeouts"
14291 .cindex "callout" "caching timeouts"
14292 This option specifies the expiry time for negative callout cache data for a
14293 domain. See section &<<SECTcallver>>& for details of callout verification, and
14294 section &<<SECTcallvercache>>& for details of the caching.
14295
14296
14297 .option callout_domain_positive_expire main time 7d
14298 This option specifies the expiry time for positive callout cache data for a
14299 domain. See section &<<SECTcallver>>& for details of callout verification, and
14300 section &<<SECTcallvercache>>& for details of the caching.
14301
14302
14303 .option callout_negative_expire main time 2h
14304 This option specifies the expiry time for negative callout cache data for an
14305 address. See section &<<SECTcallver>>& for details of callout verification, and
14306 section &<<SECTcallvercache>>& for details of the caching.
14307
14308
14309 .option callout_positive_expire main time 24h
14310 This option specifies the expiry time for positive callout cache data for an
14311 address. See section &<<SECTcallver>>& for details of callout verification, and
14312 section &<<SECTcallvercache>>& for details of the caching.
14313
14314
14315 .option callout_random_local_part main string&!! "see below"
14316 This option defines the &"random"& local part that can be used as part of
14317 callout verification. The default value is
14318 .code
14319 $primary_hostname-$tod_epoch-testing
14320 .endd
14321 See section &<<CALLaddparcall>>& for details of how this value is used.
14322
14323
14324 .option check_log_inodes main integer 0
14325 See &%check_spool_space%& below.
14326
14327
14328 .option check_log_space main integer 0
14329 See &%check_spool_space%& below.
14330
14331 .oindex "&%check_rfc2047_length%&"
14332 .cindex "RFC 2047" "disabling length check"
14333 .option check_rfc2047_length main boolean true
14334 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14335 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14336 word; strings to be encoded that exceed this length are supposed to use
14337 multiple encoded words. By default, Exim does not recognize encoded words that
14338 exceed the maximum length. However, it seems that some software, in violation
14339 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14340 set false, Exim recognizes encoded words of any length.
14341
14342
14343 .option check_spool_inodes main integer 0
14344 See &%check_spool_space%& below.
14345
14346
14347 .option check_spool_space main integer 0
14348 .cindex "checking disk space"
14349 .cindex "disk space, checking"
14350 .cindex "spool directory" "checking space"
14351 The four &%check_...%& options allow for checking of disk resources before a
14352 message is accepted.
14353
14354 .vindex "&$log_inodes$&"
14355 .vindex "&$log_space$&"
14356 .vindex "&$spool_inodes$&"
14357 .vindex "&$spool_space$&"
14358 When any of these options are set, they apply to all incoming messages. If you
14359 want to apply different checks to different kinds of message, you can do so by
14360 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14361 &$spool_space$& in an ACL with appropriate additional conditions.
14362
14363
14364 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14365 either value is greater than zero, for example:
14366 .code
14367 check_spool_space = 10M
14368 check_spool_inodes = 100
14369 .endd
14370 The spool partition is the one that contains the directory defined by
14371 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14372 transit.
14373
14374 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14375 files are written if either is greater than zero. These should be set only if
14376 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14377
14378 If there is less space or fewer inodes than requested, Exim refuses to accept
14379 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14380 error response to the MAIL command. If ESMTP is in use and there was a
14381 SIZE parameter on the MAIL command, its value is added to the
14382 &%check_spool_space%& value, and the check is performed even if
14383 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14384
14385 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14386 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14387
14388 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14389 failure a message is written to stderr and Exim exits with a non-zero code, as
14390 it obviously cannot send an error message of any kind.
14391
14392 .new
14393 .option chunking_advertise_hosts main "host list&!!" *
14394 .cindex CHUNKING advertisement
14395 .cindex "RFC 3030" "CHUNKING"
14396 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14397 these hosts.
14398 Hosts may use the BDAT command as an alternate to DATA.
14399 .wen
14400
14401 .option daemon_smtp_ports main string &`smtp`&
14402 .cindex "port" "for daemon"
14403 .cindex "TCP/IP" "setting listening ports"
14404 This option specifies one or more default SMTP ports on which the Exim daemon
14405 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14406 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14407
14408 .option daemon_startup_retries main integer 9
14409 .cindex "daemon startup, retrying"
14410 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14411 the daemon at startup when it cannot immediately bind a listening socket
14412 (typically because the socket is already in use): &%daemon_startup_retries%&
14413 defines the number of retries after the first failure, and
14414 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14415
14416 .option daemon_startup_sleep main time 30s
14417 See &%daemon_startup_retries%&.
14418
14419 .option delay_warning main "time list" 24h
14420 .cindex "warning of delay"
14421 .cindex "delay warning, specifying"
14422 When a message is delayed, Exim sends a warning message to the sender at
14423 intervals specified by this option. The data is a colon-separated list of times
14424 after which to send warning messages. If the value of the option is an empty
14425 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14426 message has been on the queue for longer than the last time, the last interval
14427 between the times is used to compute subsequent warning times. For example,
14428 with
14429 .code
14430 delay_warning = 4h:8h:24h
14431 .endd
14432 the first message is sent after 4 hours, the second after 8 hours, and
14433 the third one after 24 hours. After that, messages are sent every 16 hours,
14434 because that is the interval between the last two times on the list. If you set
14435 just one time, it specifies the repeat interval. For example, with:
14436 .code
14437 delay_warning = 6h
14438 .endd
14439 messages are repeated every six hours. To stop warnings after a given time, set
14440 a very large time at the end of the list. For example:
14441 .code
14442 delay_warning = 2h:12h:99d
14443 .endd
14444 Note that the option is only evaluated at the time a delivery attempt fails,
14445 which depends on retry and queue-runner configuration.
14446 Typically retries will be configured more frequently than warning messages.
14447
14448 .option delay_warning_condition main string&!! "see below"
14449 .vindex "&$domain$&"
14450 The string is expanded at the time a warning message might be sent. If all the
14451 deferred addresses have the same domain, it is set in &$domain$& during the
14452 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14453 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14454 &"false"& (the comparison being done caselessly) then the warning message is
14455 not sent. The default is:
14456 .code
14457 delay_warning_condition = ${if or {\
14458   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14459   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14460   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14461   } {no}{yes}}
14462 .endd
14463 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14464 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14465 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14466 &"auto-replied"& in an &'Auto-Submitted:'& header.
14467
14468 .option deliver_drop_privilege main boolean false
14469 .cindex "unprivileged delivery"
14470 .cindex "delivery" "unprivileged"
14471 If this option is set true, Exim drops its root privilege at the start of a
14472 delivery process, and runs as the Exim user throughout. This severely restricts
14473 the kinds of local delivery that are possible, but is viable in certain types
14474 of configuration. There is a discussion about the use of root privilege in
14475 chapter &<<CHAPsecurity>>&.
14476
14477 .option deliver_queue_load_max main fixed-point unset
14478 .cindex "load average"
14479 .cindex "queue runner" "abandoning"
14480 When this option is set, a queue run is abandoned if the system load average
14481 becomes greater than the value of the option. The option has no effect on
14482 ancient operating systems on which Exim cannot determine the load average.
14483 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14484
14485
14486 .option delivery_date_remove main boolean true
14487 .cindex "&'Delivery-date:'& header line"
14488 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14489 message when it is delivered, in exactly the same way as &'Return-path:'& is
14490 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14491 should not be present in incoming messages, and this option causes them to be
14492 removed at the time the message is received, to avoid any problems that might
14493 occur when a delivered message is subsequently sent on to some other recipient.
14494
14495 .option disable_fsync main boolean false
14496 .cindex "&[fsync()]&, disabling"
14497 This option is available only if Exim was built with the compile-time option
14498 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14499 a runtime configuration generates an &"unknown option"& error. You should not
14500 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14501 really, really, really understand what you are doing. &'No pre-compiled
14502 distributions of Exim should ever make this option available.'&
14503
14504 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14505 updated files' data to be written to disc before continuing. Unexpected events
14506 such as crashes and power outages may cause data to be lost or scrambled.
14507 Here be Dragons. &*Beware.*&
14508
14509
14510 .option disable_ipv6 main boolean false
14511 .cindex "IPv6" "disabling"
14512 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14513 activities take place. AAAA records are never looked up, and any IPv6 addresses
14514 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14515 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14516 to handle IPv6 literal addresses.
14517
14518
14519 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14520 .cindex DKIM "controlling calls to the ACL"
14521 This option gives a list of DKIM domains for which the DKIM ACL is run.
14522 It is expanded after the message is received; by default it runs
14523 the ACL once for each signature in the message.
14524 See chapter &<<CHAPdkim>>&.
14525
14526
14527 .option dns_again_means_nonexist main "domain list&!!" unset
14528 .cindex "DNS" "&""try again""& response; overriding"
14529 DNS lookups give a &"try again"& response for the DNS errors
14530 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14531 keep trying to deliver a message, or to give repeated temporary errors to
14532 incoming mail. Sometimes the effect is caused by a badly set up name server and
14533 may persist for a long time. If a domain which exhibits this problem matches
14534 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14535 This option should be used with care. You can make it apply to reverse lookups
14536 by a setting such as this:
14537 .code
14538 dns_again_means_nonexist = *.in-addr.arpa
14539 .endd
14540 This option applies to all DNS lookups that Exim does. It also applies when the
14541 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14542 since these are most likely to be caused by DNS lookup problems. The
14543 &(dnslookup)& router has some options of its own for controlling what happens
14544 when lookups for MX or SRV records give temporary errors. These more specific
14545 options are applied after this global option.
14546
14547 .option dns_check_names_pattern main string "see below"
14548 .cindex "DNS" "pre-check of name syntax"
14549 When this option is set to a non-empty string, it causes Exim to check domain
14550 names for characters that are not allowed in host names before handing them to
14551 the DNS resolver, because some resolvers give temporary errors for names that
14552 contain unusual characters. If a domain name contains any unwanted characters,
14553 a &"not found"& result is forced, and the resolver is not called. The check is
14554 done by matching the domain name against a regular expression, which is the
14555 value of this option. The default pattern is
14556 .code
14557 dns_check_names_pattern = \
14558   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14559 .endd
14560 which permits only letters, digits, slashes, and hyphens in components, but
14561 they must start and end with a letter or digit. Slashes are not, in fact,
14562 permitted in host names, but they are found in certain NS records (which can be
14563 accessed in Exim by using a &%dnsdb%& lookup). If you set
14564 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14565 empty string.
14566
14567 .option dns_csa_search_limit main integer 5
14568 This option controls the depth of parental searching for CSA SRV records in the
14569 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14570
14571 .option dns_csa_use_reverse main boolean true
14572 This option controls whether or not an IP address, given as a CSA domain, is
14573 reversed and looked up in the reverse DNS, as described in more detail in
14574 section &<<SECTverifyCSA>>&.
14575
14576
14577 .option dns_dnssec_ok main integer -1
14578 .cindex "DNS" "resolver options"
14579 .cindex "DNS" "DNSSEC"
14580 If this option is set to a non-negative number then Exim will initialise the
14581 DNS resolver library to either use or not use DNSSEC, overriding the system
14582 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14583
14584 If the resolver library does not support DNSSEC then this option has no effect.
14585
14586
14587 .option dns_ipv4_lookup main "domain list&!!" unset
14588 .cindex "IPv6" "DNS lookup for AAAA records"
14589 .cindex "DNS" "IPv6 lookup for AAAA records"
14590 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14591 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14592 (A records) when trying to find IP addresses for hosts, unless the host's
14593 domain matches this list.
14594
14595 This is a fudge to help with name servers that give big delays or otherwise do
14596 not work for the AAAA record type. In due course, when the world's name
14597 servers have all been upgraded, there should be no need for this option.
14598
14599
14600 .option dns_retrans main time 0s
14601 .cindex "DNS" "resolver options"
14602 .cindex timeout "dns lookup"
14603 .cindex "DNS" timeout
14604 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14605 retransmission and retry parameters for DNS lookups. Values of zero (the
14606 defaults) leave the system default settings unchanged. The first value is the
14607 time between retries, and the second is the number of retries. It isn't
14608 totally clear exactly how these settings affect the total time a DNS lookup may
14609 take. I haven't found any documentation about timeouts on DNS lookups; these
14610 parameter values are available in the external resolver interface structure,
14611 but nowhere does it seem to describe how they are used or what you might want
14612 to set in them.
14613 See also the &%slow_lookup_log%& option.
14614
14615
14616 .option dns_retry main integer 0
14617 See &%dns_retrans%& above.
14618
14619
14620 .option dns_trust_aa main "domain list&!!" unset
14621 .cindex "DNS" "resolver options"
14622 .cindex "DNS" "DNSSEC"
14623 If this option is set then lookup results marked with the AA bit
14624 (Authoritative Answer) are trusted the same way as if they were
14625 DNSSEC-verified. The authority section's name of the answer must
14626 match with this expanded domain list.
14627
14628 Use this option only if you talk directly to a resolver that is
14629 authoritative for some zones and does not set the AD (Authentic Data)
14630 bit in the answer. Some DNS servers may have an configuration option to
14631 mark the answers from their own zones as verified (they set the AD bit).
14632 Others do not have this option. It is considered as poor practice using
14633 a resolver that is an authoritative server for some zones.
14634
14635 Use this option only if you really have to (e.g. if you want
14636 to use DANE for remote delivery to a server that is listed in the DNS
14637 zones that your resolver is authoritative for).
14638
14639 If the DNS answer packet has the AA bit set and contains resource record
14640 in the answer section, the name of the first NS record appearing in the
14641 authority section is compared against the list. If the answer packet is
14642 authoritative but the answer section is empty, the name of the first SOA
14643 record in the authoritative section is used instead.
14644
14645 .cindex "DNS" "resolver options"
14646 .option dns_use_edns0 main integer -1
14647 .cindex "DNS" "resolver options"
14648 .cindex "DNS" "EDNS0"
14649 If this option is set to a non-negative number then Exim will initialise the
14650 DNS resolver library to either use or not use EDNS0 extensions, overriding
14651 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14652 on.
14653
14654 If the resolver library does not support EDNS0 then this option has no effect.
14655
14656
14657 .option drop_cr main boolean false
14658 This is an obsolete option that is now a no-op. It used to affect the way Exim
14659 handled CR and LF characters in incoming messages. What happens now is
14660 described in section &<<SECTlineendings>>&.
14661
14662 .option dsn_advertise_hosts main "host list&!!" unset
14663 .cindex "bounce messages" "success"
14664 .cindex "DSN" "success"
14665 .cindex "Delivery Status Notification" "success"
14666 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14667 and accepted from, these hosts.
14668 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14669 and RET and ORCPT options on MAIL FROM commands.
14670 A NOTIFY=SUCCESS option requests success-DSN messages.
14671 A NOTIFY= option with no argument requests that no delay or failure DSNs
14672 are sent.
14673
14674 .option dsn_from main "string&!!" "see below"
14675 .cindex "&'From:'& header line" "in bounces"
14676 .cindex "bounce messages" "&'From:'& line, specifying"
14677 This option can be used to vary the contents of &'From:'& header lines in
14678 bounces and other automatically generated messages (&"Delivery Status
14679 Notifications"& &-- hence the name of the option). The default setting is:
14680 .code
14681 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14682 .endd
14683 The value is expanded every time it is needed. If the expansion fails, a
14684 panic is logged, and the default value is used.
14685
14686 .option envelope_to_remove main boolean true
14687 .cindex "&'Envelope-to:'& header line"
14688 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14689 message when it is delivered, in exactly the same way as &'Return-path:'& is
14690 handled. &'Envelope-to:'& records the original recipient address from the
14691 message's envelope that caused the delivery to happen. Such headers should not
14692 be present in incoming messages, and this option causes them to be removed at
14693 the time the message is received, to avoid any problems that might occur when a
14694 delivered message is subsequently sent on to some other recipient.
14695
14696
14697 .option errors_copy main "string list&!!" unset
14698 .cindex "bounce message" "copy to other address"
14699 .cindex "copy of bounce message"
14700 Setting this option causes Exim to send bcc copies of bounce messages that it
14701 generates to other addresses. &*Note*&: This does not apply to bounce messages
14702 coming from elsewhere. The value of the option is a colon-separated list of
14703 items. Each item consists of a pattern, terminated by white space, followed by
14704 a comma-separated list of email addresses. If a pattern contains spaces, it
14705 must be enclosed in double quotes.
14706
14707 Each pattern is processed in the same way as a single item in an address list
14708 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14709 the bounce message, the message is copied to the addresses on the list. The
14710 items are scanned in order, and once a matching one is found, no further items
14711 are examined. For example:
14712 .code
14713 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14714               rqps@mydomain   hostmaster@mydomain.example,\
14715                               postmaster@mydomain.example
14716 .endd
14717 .vindex "&$domain$&"
14718 .vindex "&$local_part$&"
14719 The address list is expanded before use. The expansion variables &$local_part$&
14720 and &$domain$& are set from the original recipient of the error message, and if
14721 there was any wildcard matching in the pattern, the expansion
14722 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14723 variables &$0$&, &$1$&, etc. are set in the normal way.
14724
14725
14726 .option errors_reply_to main string unset
14727 .cindex "bounce message" "&'Reply-to:'& in"
14728 By default, Exim's bounce and delivery warning messages contain the header line
14729 .display
14730 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14731 .endd
14732 .oindex &%quota_warn_message%&
14733 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14734 A warning message that is generated by the &%quota_warn_message%& option in an
14735 &(appendfile)& transport may contain its own &'From:'& header line that
14736 overrides the default.
14737
14738 Experience shows that people reply to bounce messages. If the
14739 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14740 and warning messages. For example:
14741 .code
14742 errors_reply_to = postmaster@my.domain.example
14743 .endd
14744 The value of the option is not expanded. It must specify a valid RFC 2822
14745 address. However, if a warning message that is generated by the
14746 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14747 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14748 not used.
14749
14750
14751 .option event_action main string&!! unset
14752 .cindex events
14753 This option declares a string to be expanded for Exim's events mechanism.
14754 For details see &<<CHAPevents>>&.
14755
14756
14757 .option exim_group main string "compile-time configured"
14758 .cindex "gid (group id)" "Exim's own"
14759 .cindex "Exim group"
14760 This option changes the gid under which Exim runs when it gives up root
14761 privilege. The default value is compiled into the binary. The value of this
14762 option is used only when &%exim_user%& is also set. Unless it consists entirely
14763 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14764 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14765 security issues.
14766
14767
14768 .option exim_path main string "see below"
14769 .cindex "Exim binary, path name"
14770 This option specifies the path name of the Exim binary, which is used when Exim
14771 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14772 the directory configured at compile time by the BIN_DIRECTORY setting. It
14773 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14774 other place.
14775 &*Warning*&: Do not use a macro to define the value of this option, because
14776 you will break those Exim utilities that scan the configuration file to find
14777 where the binary is. (They then use the &%-bP%& option to extract option
14778 settings such as the value of &%spool_directory%&.)
14779
14780
14781 .option exim_user main string "compile-time configured"
14782 .cindex "uid (user id)" "Exim's own"
14783 .cindex "Exim user"
14784 This option changes the uid under which Exim runs when it gives up root
14785 privilege. The default value is compiled into the binary. Ownership of the run
14786 time configuration file and the use of the &%-C%& and &%-D%& command line
14787 options is checked against the values in the binary, not what is set here.
14788
14789 Unless it consists entirely of digits, the string is looked up using
14790 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14791 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14792 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14793
14794
14795 .option extra_local_interfaces main "string list" unset
14796 This option defines network interfaces that are to be considered local when
14797 routing, but which are not used for listening by the daemon. See section
14798 &<<SECTreclocipadd>>& for details.
14799
14800
14801 . Allow this long option name to split; give it unsplit as a fifth argument
14802 . for the automatic .oindex that is generated by .option.
14803
14804 .option "extract_addresses_remove_arguments" main boolean true &&&
14805          extract_addresses_remove_arguments
14806 .oindex "&%-t%&"
14807 .cindex "command line" "addresses with &%-t%&"
14808 .cindex "Sendmail compatibility" "&%-t%& option"
14809 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14810 are present on the command line when the &%-t%& option is used to build an
14811 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14812 line addresses are removed from the recipients list. This is also how Smail
14813 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14814 command line addresses are added to those obtained from the header lines. When
14815 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14816 argument headers. If it is set false, Exim adds rather than removes argument
14817 addresses.
14818
14819
14820 .option finduser_retries main integer 0
14821 .cindex "NIS, retrying user lookups"
14822 On systems running NIS or other schemes in which user and group information is
14823 distributed from a remote system, there can be times when &[getpwnam()]& and
14824 related functions fail, even when given valid data, because things time out.
14825 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14826 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14827 many extra times to find a user or a group, waiting for one second between
14828 retries.
14829
14830 .cindex "&_/etc/passwd_&" "multiple reading of"
14831 You should not set this option greater than zero if your user information is in
14832 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14833 search the file multiple times for non-existent users, and also cause delay.
14834
14835
14836
14837 .option freeze_tell main "string list, comma separated" unset
14838 .cindex "freezing messages" "sending a message when freezing"
14839 On encountering certain errors, or when configured to do so in a system filter,
14840 ACL, or special router, Exim freezes a message. This means that no further
14841 delivery attempts take place until an administrator thaws the message, or the
14842 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14843 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14844 warning message whenever it freezes something, unless the message it is
14845 freezing is a locally-generated bounce message. (Without this exception there
14846 is the possibility of looping.) The warning message is sent to the addresses
14847 supplied as the comma-separated value of this option. If several of the
14848 message's addresses cause freezing, only a single message is sent. If the
14849 freezing was automatic, the reason(s) for freezing can be found in the message
14850 log. If you configure freezing in a filter or ACL, you must arrange for any
14851 logging that you require.
14852
14853
14854 .option gecos_name main string&!! unset
14855 .cindex "HP-UX"
14856 .cindex "&""gecos""& field, parsing"
14857 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14858 password file to hold other information in addition to users' real names. Exim
14859 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14860 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14861 of the field are used unchanged, except that, if an ampersand is encountered,
14862 it is replaced by the user's login name with the first character forced to
14863 upper case, since this is a convention that is observed on many systems.
14864
14865 When these options are set, &%gecos_pattern%& is treated as a regular
14866 expression that is to be applied to the field (again with && replaced by the
14867 login name), and if it matches, &%gecos_name%& is expanded and used as the
14868 user's name.
14869
14870 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14871 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14872 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14873 name terminates at the first comma, the following can be used:
14874 .code
14875 gecos_pattern = ([^,]*)
14876 gecos_name = $1
14877 .endd
14878
14879 .option gecos_pattern main string unset
14880 See &%gecos_name%& above.
14881
14882
14883 .option gnutls_compat_mode main boolean unset
14884 This option controls whether GnuTLS is used in compatibility mode in an Exim
14885 server. This reduces security slightly, but improves interworking with older
14886 implementations of TLS.
14887
14888
14889 option gnutls_allow_auto_pkcs11 main boolean unset
14890 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14891 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14892
14893 See
14894 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14895 for documentation.
14896
14897
14898
14899 .option headers_charset main string "see below"
14900 This option sets a default character set for translating from encoded MIME
14901 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14902 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14903 ultimate default is ISO-8859-1. For more details see the description of header
14904 insertions in section &<<SECTexpansionitems>>&.
14905
14906
14907
14908 .option header_maxsize main integer "see below"
14909 .cindex "header section" "maximum size of"
14910 .cindex "limit" "size of message header section"
14911 This option controls the overall maximum size of a message's header
14912 section. The default is the value of HEADER_MAXSIZE in
14913 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14914 sections are rejected.
14915
14916
14917 .option header_line_maxsize main integer 0
14918 .cindex "header lines" "maximum size of"
14919 .cindex "limit" "size of one header line"
14920 This option limits the length of any individual header line in a message, after
14921 all the continuations have been joined together. Messages with individual
14922 header lines that are longer than the limit are rejected. The default value of
14923 zero means &"no limit"&.
14924
14925
14926
14927
14928 .option helo_accept_junk_hosts main "host list&!!" unset
14929 .cindex "HELO" "accepting junk data"
14930 .cindex "EHLO" "accepting junk data"
14931 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14932 mail, and gives an error response for invalid data. Unfortunately, there are
14933 some SMTP clients that send syntactic junk. They can be accommodated by setting
14934 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14935 if you want to do semantic checking.
14936 See also &%helo_allow_chars%& for a way of extending the permitted character
14937 set.
14938
14939
14940 .option helo_allow_chars main string unset
14941 .cindex "HELO" "underscores in"
14942 .cindex "EHLO" "underscores in"
14943 .cindex "underscore in EHLO/HELO"
14944 This option can be set to a string of rogue characters that are permitted in
14945 all EHLO and HELO names in addition to the standard letters, digits,
14946 hyphens, and dots. If you really must allow underscores, you can set
14947 .code
14948 helo_allow_chars = _
14949 .endd
14950 Note that the value is one string, not a list.
14951
14952
14953 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14954 .cindex "HELO" "forcing reverse lookup"
14955 .cindex "EHLO" "forcing reverse lookup"
14956 If the domain given by a client in a HELO or EHLO command matches this
14957 list, a reverse lookup is done in order to establish the host's true name. The
14958 default forces a lookup if the client host gives the server's name or any of
14959 its IP addresses (in brackets), something that broken clients have been seen to
14960 do.
14961
14962
14963 .option helo_try_verify_hosts main "host list&!!" unset
14964 .cindex "HELO verifying" "optional"
14965 .cindex "EHLO" "verifying, optional"
14966 By default, Exim just checks the syntax of HELO and EHLO commands (see
14967 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14968 to do more extensive checking of the data supplied by these commands. The ACL
14969 condition &`verify = helo`& is provided to make this possible.
14970 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14971 to force the check to occur. From release 4.53 onwards, this is no longer
14972 necessary. If the check has not been done before &`verify = helo`& is
14973 encountered, it is done at that time. Consequently, this option is obsolete.
14974 Its specification is retained here for backwards compatibility.
14975
14976 When an EHLO or HELO command is received, if the calling host matches
14977 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14978 EHLO command either:
14979
14980 .ilist
14981 is an IP literal matching the calling address of the host, or
14982 .next
14983 .cindex "DNS" "reverse lookup"
14984 .cindex "reverse DNS lookup"
14985 matches the host name that Exim obtains by doing a reverse lookup of the
14986 calling host address, or
14987 .next
14988 when looked up in DNS yields the calling host address.
14989 .endlist
14990
14991 However, the EHLO or HELO command is not rejected if any of the checks
14992 fail. Processing continues, but the result of the check is remembered, and can
14993 be detected later in an ACL by the &`verify = helo`& condition.
14994
14995 If DNS was used for successful verification, the variable
14996 .cindex "DNS" "DNSSEC"
14997 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14998
14999 .option helo_verify_hosts main "host list&!!" unset
15000 .cindex "HELO verifying" "mandatory"
15001 .cindex "EHLO" "verifying, mandatory"
15002 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15003 backwards compatibility. For hosts that match this option, Exim checks the host
15004 name given in the HELO or EHLO in the same way as for
15005 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15006 rejected with a 550 error, and entries are written to the main and reject logs.
15007 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15008 error.
15009
15010 .option hold_domains main "domain list&!!" unset
15011 .cindex "domain" "delaying delivery"
15012 .cindex "delivery" "delaying certain domains"
15013 This option allows mail for particular domains to be held on the queue
15014 manually. The option is overridden if a message delivery is forced with the
15015 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15016 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15017 item in &%hold_domains%&, no routing or delivery for that address is done, and
15018 it is deferred every time the message is looked at.
15019
15020 This option is intended as a temporary operational measure for delaying the
15021 delivery of mail while some problem is being sorted out, or some new
15022 configuration tested. If you just want to delay the processing of some
15023 domains until a queue run occurs, you should use &%queue_domains%& or
15024 &%queue_smtp_domains%&, not &%hold_domains%&.
15025
15026 A setting of &%hold_domains%& does not override Exim's code for removing
15027 messages from the queue if they have been there longer than the longest retry
15028 time in any retry rule. If you want to hold messages for longer than the normal
15029 retry times, insert a dummy retry rule with a long retry time.
15030
15031
15032 .option host_lookup main "host list&!!" unset
15033 .cindex "host name" "lookup, forcing"
15034 Exim does not look up the name of a calling host from its IP address unless it
15035 is required to compare against some host list, or the host matches
15036 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15037 option (which normally contains IP addresses rather than host names). The
15038 default configuration file contains
15039 .code
15040 host_lookup = *
15041 .endd
15042 which causes a lookup to happen for all hosts. If the expense of these lookups
15043 is felt to be too great, the setting can be changed or removed.
15044
15045 After a successful reverse lookup, Exim does a forward lookup on the name it
15046 has obtained, to verify that it yields the IP address that it started with. If
15047 this check fails, Exim behaves as if the name lookup failed.
15048
15049 .vindex "&$host_lookup_failed$&"
15050 .vindex "&$sender_host_name$&"
15051 After any kind of failure, the host name (in &$sender_host_name$&) remains
15052 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15053 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15054 &`verify = reverse_host_lookup`& in ACLs.
15055
15056
15057 .option host_lookup_order main "string list" &`bydns:byaddr`&
15058 This option specifies the order of different lookup methods when Exim is trying
15059 to find a host name from an IP address. The default is to do a DNS lookup
15060 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15061 if that fails. You can change the order of these lookups, or omit one entirely,
15062 if you want.
15063
15064 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15065 multiple PTR records in the DNS and the IP address is not listed in
15066 &_/etc/hosts_&. Different operating systems give different results in this
15067 case. That is why the default tries a DNS lookup first.
15068
15069
15070
15071 .option host_reject_connection main "host list&!!" unset
15072 .cindex "host" "rejecting connections from"
15073 If this option is set, incoming SMTP calls from the hosts listed are rejected
15074 as soon as the connection is made.
15075 This option is obsolete, and retained only for backward compatibility, because
15076 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15077 connections immediately.
15078
15079 The ability to give an immediate rejection (either by this option or using an
15080 ACL) is provided for use in unusual cases. Many hosts will just try again,
15081 sometimes without much delay. Normally, it is better to use an ACL to reject
15082 incoming messages at a later stage, such as after RCPT commands. See
15083 chapter &<<CHAPACL>>&.
15084
15085
15086 .option hosts_connection_nolog main "host list&!!" unset
15087 .cindex "host" "not logging connections from"
15088 This option defines a list of hosts for which connection logging does not
15089 happen, even though the &%smtp_connection%& log selector is set. For example,
15090 you might want not to log SMTP connections from local processes, or from
15091 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15092 the daemon; you should therefore strive to restrict its value to a short inline
15093 list of IP addresses and networks. To disable logging SMTP connections from
15094 local processes, you must create a host list with an empty item. For example:
15095 .code
15096 hosts_connection_nolog = :
15097 .endd
15098 If the &%smtp_connection%& log selector is not set, this option has no effect.
15099
15100
15101
15102 .option hosts_proxy main "host list&!!" unset
15103 .cindex proxy "proxy protocol"
15104 This option enables use of Proxy Protocol proxies for incoming
15105 connections.  For details see &<<SECTproxyInbound>>&.
15106
15107
15108 .option hosts_treat_as_local main "domain list&!!" unset
15109 .cindex "local host" "domains treated as"
15110 .cindex "host" "treated as local"
15111 If this option is set, any host names that match the domain list are treated as
15112 if they were the local host when Exim is scanning host lists obtained from MX
15113 records
15114 or other sources. Note that the value of this option is a domain list, not a
15115 host list, because it is always used to check host names, not IP addresses.
15116
15117 This option also applies when Exim is matching the special items
15118 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15119 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15120 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15121 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15122 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15123 interfaces and recognizing the local host.
15124
15125
15126 .option ibase_servers main "string list" unset
15127 .cindex "InterBase" "server list"
15128 This option provides a list of InterBase servers and associated connection data,
15129 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15130 The option is available only if Exim has been built with InterBase support.
15131
15132
15133
15134 .option ignore_bounce_errors_after main time 10w
15135 .cindex "bounce message" "discarding"
15136 .cindex "discarding bounce message"
15137 This option affects the processing of bounce messages that cannot be delivered,
15138 that is, those that suffer a permanent delivery failure. (Bounce messages that
15139 suffer temporary delivery failures are of course retried in the usual way.)
15140
15141 After a permanent delivery failure, bounce messages are frozen,
15142 because there is no sender to whom they can be returned. When a frozen bounce
15143 message has been on the queue for more than the given time, it is unfrozen at
15144 the next queue run, and a further delivery is attempted. If delivery fails
15145 again, the bounce message is discarded. This makes it possible to keep failed
15146 bounce messages around for a shorter time than the normal maximum retry time
15147 for frozen messages. For example,
15148 .code
15149 ignore_bounce_errors_after = 12h
15150 .endd
15151 retries failed bounce message deliveries after 12 hours, discarding any further
15152 failures. If the value of this option is set to a zero time period, bounce
15153 failures are discarded immediately. Setting a very long time (as in the default
15154 value) has the effect of disabling this option. For ways of automatically
15155 dealing with other kinds of frozen message, see &%auto_thaw%& and
15156 &%timeout_frozen_after%&.
15157
15158
15159 .option ignore_fromline_hosts main "host list&!!" unset
15160 .cindex "&""From""& line"
15161 .cindex "UUCP" "&""From""& line"
15162 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15163 the headers of a message. By default this is treated as the start of the
15164 message's body, which means that any following headers are not recognized as
15165 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15166 match those hosts that insist on sending it. If the sender is actually a local
15167 process rather than a remote host, and is using &%-bs%& to inject the messages,
15168 &%ignore_fromline_local%& must be set to achieve this effect.
15169
15170
15171 .option ignore_fromline_local main boolean false
15172 See &%ignore_fromline_hosts%& above.
15173
15174 .option keep_environment main "string list" unset
15175 .cindex "environment" "values from"
15176 This option contains a string list of environment variables to keep.
15177 You have to trust these variables or you have to be sure that
15178 these variables do not impose any security risk. Keep in mind that
15179 during the startup phase Exim is running with an effective UID 0 in most
15180 installations. As the default value is an empty list, the default
15181 environment for using libraries, running embedded Perl code, or running
15182 external binaries is empty, and does not not even contain PATH or HOME.
15183
15184 Actually the list is interpreted as a list of patterns
15185 (&<<SECTlistexpand>>&), except that it is not expanded first.
15186
15187 WARNING: Macro substitution is still done first, so having a macro
15188 FOO and having FOO_HOME in your &%keep_environment%& option may have
15189 unexpected results. You may work around this using a regular expression
15190 that does not match the macro name: ^[F]OO_HOME$.
15191
15192 Current versions of Exim issue a warning during startup if you do not mention
15193 &%keep_environment%& in your runtime configuration file and if your
15194 current environment is not empty. Future versions may not issue that warning
15195 anymore.
15196
15197 See the &%add_environment%& main config option for a way to set
15198 environment variables to a fixed value.  The environment for &(pipe)&
15199 transports is handled separately, see section &<<SECTpipeenv>>& for
15200 details.
15201
15202
15203 .option keep_malformed main time 4d
15204 This option specifies the length of time to keep messages whose spool files
15205 have been corrupted in some way. This should, of course, never happen. At the
15206 next attempt to deliver such a message, it gets removed. The incident is
15207 logged.
15208
15209
15210 .option ldap_ca_cert_dir main string unset
15211 .cindex "LDAP", "TLS CA certificate directory"
15212 .cindex certificate "directory for LDAP"
15213 This option indicates which directory contains CA certificates for verifying
15214 a TLS certificate presented by an LDAP server.
15215 While Exim does not provide a default value, your SSL library may.
15216 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15217 and constrained to be a directory.
15218
15219
15220 .option ldap_ca_cert_file main string unset
15221 .cindex "LDAP", "TLS CA certificate file"
15222 .cindex certificate "file for LDAP"
15223 This option indicates which file contains CA certificates for verifying
15224 a TLS certificate presented by an LDAP server.
15225 While Exim does not provide a default value, your SSL library may.
15226 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15227 and constrained to be a file.
15228
15229
15230 .option ldap_cert_file main string unset
15231 .cindex "LDAP" "TLS client certificate file"
15232 .cindex certificate "file for LDAP"
15233 This option indicates which file contains an TLS client certificate which
15234 Exim should present to the LDAP server during TLS negotiation.
15235 Should be used together with &%ldap_cert_key%&.
15236
15237
15238 .option ldap_cert_key main string unset
15239 .cindex "LDAP" "TLS client key file"
15240 .cindex certificate "key for LDAP"
15241 This option indicates which file contains the secret/private key to use
15242 to prove identity to the LDAP server during TLS negotiation.
15243 Should be used together with &%ldap_cert_file%&, which contains the
15244 identity to be proven.
15245
15246
15247 .option ldap_cipher_suite main string unset
15248 .cindex "LDAP" "TLS cipher suite"
15249 This controls the TLS cipher-suite negotiation during TLS negotiation with
15250 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15251 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15252
15253
15254 .option ldap_default_servers main "string list" unset
15255 .cindex "LDAP" "default servers"
15256 This option provides a list of LDAP servers which are tried in turn when an
15257 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15258 details of LDAP queries. This option is available only when Exim has been built
15259 with LDAP support.
15260
15261
15262 .option ldap_require_cert main string unset.
15263 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15264 This should be one of the values "hard", "demand", "allow", "try" or "never".
15265 A value other than one of these is interpreted as "never".
15266 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15267 Although Exim does not set a default, the LDAP library probably defaults
15268 to hard/demand.
15269
15270
15271 .option ldap_start_tls main boolean false
15272 .cindex "LDAP" "whether or not to negotiate TLS"
15273 If set, Exim will attempt to negotiate TLS with the LDAP server when
15274 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15275 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15276 of SSL-on-connect.
15277 In the event of failure to negotiate TLS, the action taken is controlled
15278 by &%ldap_require_cert%&.
15279
15280
15281 .option ldap_version main integer unset
15282 .cindex "LDAP" "protocol version, forcing"
15283 This option can be used to force Exim to set a specific protocol version for
15284 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15285 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15286 the LDAP headers; otherwise it is 2. This option is available only when Exim
15287 has been built with LDAP support.
15288
15289
15290
15291 .option local_from_check main boolean true
15292 .cindex "&'Sender:'& header line" "disabling addition of"
15293 .cindex "&'From:'& header line" "disabling checking of"
15294 When a message is submitted locally (that is, not over a TCP/IP connection) by
15295 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15296 checks that the &'From:'& header line matches the login of the calling user and
15297 the domain specified by &%qualify_domain%&.
15298
15299 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15300 locally submitted message is automatically qualified by Exim, unless the
15301 &%-bnq%& command line option is used.
15302
15303 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15304 on the local part. If the &'From:'& header line does not match, Exim adds a
15305 &'Sender:'& header with an address constructed from the calling user's login
15306 and the default qualify domain.
15307
15308 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15309 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15310 &'Sender:'& header lines supplied by untrusted users, you must also set
15311 &%local_sender_retain%& to be true.
15312
15313 .cindex "envelope sender"
15314 These options affect only the header lines in the message. The envelope sender
15315 is still forced to be the login id at the qualify domain unless
15316 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15317
15318 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15319 request similar header line checking. See section &<<SECTthesenhea>>&, which
15320 has more details about &'Sender:'& processing.
15321
15322
15323
15324
15325 .option local_from_prefix main string unset
15326 When Exim checks the &'From:'& header line of locally submitted messages for
15327 matching the login id (see &%local_from_check%& above), it can be configured to
15328 ignore certain prefixes and suffixes in the local part of the address. This is
15329 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15330 appropriate lists, in the same form as the &%local_part_prefix%& and
15331 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15332 example, if
15333 .code
15334 local_from_prefix = *-
15335 .endd
15336 is set, a &'From:'& line containing
15337 .code
15338 From: anything-user@your.domain.example
15339 .endd
15340 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15341 matches the actual sender address that is constructed from the login name and
15342 qualify domain.
15343
15344
15345 .option local_from_suffix main string unset
15346 See &%local_from_prefix%& above.
15347
15348
15349 .option local_interfaces main "string list" "see below"
15350 This option controls which network interfaces are used by the daemon for
15351 listening; they are also used to identify the local host when routing. Chapter
15352 &<<CHAPinterfaces>>& contains a full description of this option and the related
15353 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15354 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15355 &%local_interfaces%& is
15356 .code
15357 local_interfaces = 0.0.0.0
15358 .endd
15359 when Exim is built without IPv6 support; otherwise it is
15360 .code
15361 local_interfaces = <; ::0 ; 0.0.0.0
15362 .endd
15363
15364 .option local_scan_timeout main time 5m
15365 .cindex "timeout" "for &[local_scan()]& function"
15366 .cindex "&[local_scan()]& function" "timeout"
15367 This timeout applies to the &[local_scan()]& function (see chapter
15368 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15369 the incoming message is rejected with a temporary error if it is an SMTP
15370 message. For a non-SMTP message, the message is dropped and Exim ends with a
15371 non-zero code. The incident is logged on the main and reject logs.
15372
15373
15374
15375 .option local_sender_retain main boolean false
15376 .cindex "&'Sender:'& header line" "retaining from local submission"
15377 When a message is submitted locally (that is, not over a TCP/IP connection) by
15378 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15379 do not want this to happen, you must set &%local_sender_retain%&, and you must
15380 also set &%local_from_check%& to be false (Exim will complain if you do not).
15381 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15382 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15383
15384
15385
15386
15387 .option localhost_number main string&!! unset
15388 .cindex "host" "locally unique number for"
15389 .cindex "message ids" "with multiple hosts"
15390 .vindex "&$localhost_number$&"
15391 Exim's message ids are normally unique only within the local host. If
15392 uniqueness among a set of hosts is required, each host must set a different
15393 value for the &%localhost_number%& option. The string is expanded immediately
15394 after reading the configuration file (so that a number can be computed from the
15395 host name, for example) and the result of the expansion must be a number in the
15396 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15397 systems). This is available in subsequent string expansions via the variable
15398 &$localhost_number$&. When &%localhost_number is set%&, the final two
15399 characters of the message id, instead of just being a fractional part of the
15400 time, are computed from the time and the local host number as described in
15401 section &<<SECTmessiden>>&.
15402
15403
15404
15405 .option log_file_path main "string list&!!" "set at compile time"
15406 .cindex "log" "file path for"
15407 This option sets the path which is used to determine the names of Exim's log
15408 files, or indicates that logging is to be to syslog, or both. It is expanded
15409 when Exim is entered, so it can, for example, contain a reference to the host
15410 name. If no specific path is set for the log files at compile or run time,
15411 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15412 they are written in a sub-directory called &_log_& in Exim's spool directory.
15413 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15414 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15415 used. If this string is fixed at your installation (contains no expansion
15416 variables) it is recommended that you do not set this option in the
15417 configuration file, but instead supply the path using LOG_FILE_PATH in
15418 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15419 early on &-- in particular, failure to read the configuration file.
15420
15421
15422 .option log_selector main string unset
15423 .cindex "log" "selectors"
15424 This option can be used to reduce or increase the number of things that Exim
15425 writes to its log files. Its argument is made up of names preceded by plus or
15426 minus characters. For example:
15427 .code
15428 log_selector = +arguments -retry_defer
15429 .endd
15430 A list of possible names and what they control is given in the chapter on
15431 logging, in section &<<SECTlogselector>>&.
15432
15433
15434 .option log_timezone main boolean false
15435 .cindex "log" "timezone for entries"
15436 .vindex "&$tod_log$&"
15437 .vindex "&$tod_zone$&"
15438 By default, the timestamps on log lines are in local time without the
15439 timezone. This means that if your timezone changes twice a year, the timestamps
15440 in log lines are ambiguous for an hour when the clocks go back. One way of
15441 avoiding this problem is to set the timezone to UTC. An alternative is to set
15442 &%log_timezone%& true. This turns on the addition of the timezone offset to
15443 timestamps in log lines. Turning on this option can add quite a lot to the size
15444 of log files because each line is extended by 6 characters. Note that the
15445 &$tod_log$& variable contains the log timestamp without the zone, but there is
15446 another variable called &$tod_zone$& that contains just the timezone offset.
15447
15448
15449 .option lookup_open_max main integer 25
15450 .cindex "too many open files"
15451 .cindex "open files, too many"
15452 .cindex "file" "too many open"
15453 .cindex "lookup" "maximum open files"
15454 .cindex "limit" "open files for lookups"
15455 This option limits the number of simultaneously open files for single-key
15456 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15457 Exim normally keeps these files open during routing, because often the same
15458 file is required several times. If the limit is reached, Exim closes the least
15459 recently used file. Note that if you are using the &'ndbm'& library, it
15460 actually opens two files for each logical DBM database, though it still counts
15461 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15462 open files"& errors with NDBM, you need to reduce the value of
15463 &%lookup_open_max%&.
15464
15465
15466 .option max_username_length main integer 0
15467 .cindex "length of login name"
15468 .cindex "user name" "maximum length"
15469 .cindex "limit" "user name length"
15470 Some operating systems are broken in that they truncate long arguments to
15471 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15472 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15473 an argument that is longer behaves as if &[getpwnam()]& failed.
15474
15475
15476 .option message_body_newlines main bool false
15477 .cindex "message body" "newlines in variables"
15478 .cindex "newline" "in message body variables"
15479 .vindex "&$message_body$&"
15480 .vindex "&$message_body_end$&"
15481 By default, newlines in the message body are replaced by spaces when setting
15482 the &$message_body$& and &$message_body_end$& expansion variables. If this
15483 option is set true, this no longer happens.
15484
15485
15486 .option message_body_visible main integer 500
15487 .cindex "body of message" "visible size"
15488 .cindex "message body" "visible size"
15489 .vindex "&$message_body$&"
15490 .vindex "&$message_body_end$&"
15491 This option specifies how much of a message's body is to be included in the
15492 &$message_body$& and &$message_body_end$& expansion variables.
15493
15494
15495 .option message_id_header_domain main string&!! unset
15496 .cindex "&'Message-ID:'& header line"
15497 If this option is set, the string is expanded and used as the right hand side
15498 (domain) of the &'Message-ID:'& header that Exim creates if a
15499 locally-originated incoming message does not have one. &"Locally-originated"&
15500 means &"not received over TCP/IP."&
15501 Otherwise, the primary host name is used.
15502 Only letters, digits, dot and hyphen are accepted; any other characters are
15503 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15504 empty string, the option is ignored.
15505
15506
15507 .option message_id_header_text main string&!! unset
15508 If this variable is set, the string is expanded and used to augment the text of
15509 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15510 message does not have one. The text of this header is required by RFC 2822 to
15511 take the form of an address. By default, Exim uses its internal message id as
15512 the local part, and the primary host name as the domain. If this option is set,
15513 it is expanded, and provided the expansion is not forced to fail, and does not
15514 yield an empty string, the result is inserted into the header immediately
15515 before the @, separated from the internal message id by a dot. Any characters
15516 that are illegal in an address are automatically converted into hyphens. This
15517 means that variables such as &$tod_log$& can be used, because the spaces and
15518 colons will become hyphens.
15519
15520
15521 .option message_logs main boolean true
15522 .cindex "message logs" "disabling"
15523 .cindex "log" "message log; disabling"
15524 If this option is turned off, per-message log files are not created in the
15525 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15526 Exim, by reducing the number of files involved in handling a message from a
15527 minimum of four (header spool file, body spool file, delivery journal, and
15528 per-message log) to three. The other major I/O activity is Exim's main log,
15529 which is not affected by this option.
15530
15531
15532 .option message_size_limit main string&!! 50M
15533 .cindex "message" "size limit"
15534 .cindex "limit" "message size"
15535 .cindex "size" "of message, limit"
15536 This option limits the maximum size of message that Exim will process. The
15537 value is expanded for each incoming connection so, for example, it can be made
15538 to depend on the IP address of the remote host for messages arriving via
15539 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15540 optionally followed by K or M.
15541
15542 &*Note*&: This limit cannot be made to depend on a message's sender or any
15543 other properties of an individual message, because it has to be advertised in
15544 the server's response to EHLO. String expansion failure causes a temporary
15545 error. A value of zero means no limit, but its use is not recommended. See also
15546 &%bounce_return_size_limit%&.
15547
15548 Incoming SMTP messages are failed with a 552 error if the limit is
15549 exceeded; locally-generated messages either get a stderr message or a delivery
15550 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15551 an oversized message is logged in both the main and the reject logs. See also
15552 the generic transport option &%message_size_limit%&, which limits the size of
15553 message that an individual transport can process.
15554
15555 If you use a virus-scanner and set this option to to a value larger than the
15556 maximum size that your virus-scanner is configured to support, you may get
15557 failures triggered by large mails.  The right size to configure for the
15558 virus-scanner depends upon what data is passed and the options in use but it's
15559 probably safest to just set it to a little larger than this value.  E.g., with a
15560 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15561 some problems may result.
15562
15563 A value of 0 will disable size limit checking; Exim will still advertise the
15564 SIZE extension in an EHLO response, but without a limit, so as to permit
15565 SMTP clients to still indicate the message size along with the MAIL verb.
15566
15567
15568 .option move_frozen_messages main boolean false
15569 .cindex "frozen messages" "moving"
15570 This option, which is available only if Exim has been built with the setting
15571 .code
15572 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15573 .endd
15574 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15575 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15576 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15577 standard utilities for handling such moved messages, and they do not show up in
15578 lists generated by &%-bp%& or by the Exim monitor.
15579
15580
15581 .option mua_wrapper main boolean false
15582 Setting this option true causes Exim to run in a very restrictive mode in which
15583 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15584 contains a full description of this facility.
15585
15586
15587
15588 .option mysql_servers main "string list" unset
15589 .cindex "MySQL" "server list"
15590 This option provides a list of MySQL servers and associated connection data, to
15591 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15592 option is available only if Exim has been built with MySQL support.
15593
15594
15595 .option never_users main "string list&!!" unset
15596 This option is expanded just once, at the start of Exim's processing. Local
15597 message deliveries are normally run in processes that are setuid to the
15598 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15599 It is usually desirable to prevent any deliveries from running as root, as a
15600 safety precaution.
15601
15602 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15603 list of users that must not be used for local deliveries. This list is fixed in
15604 the binary and cannot be overridden by the configuration file. By default, it
15605 contains just the single user name &"root"&. The &%never_users%& runtime option
15606 can be used to add more users to the fixed list.
15607
15608 If a message is to be delivered as one of the users on the fixed list or the
15609 &%never_users%& list, an error occurs, and delivery is deferred. A common
15610 example is
15611 .code
15612 never_users = root:daemon:bin
15613 .endd
15614 Including root is redundant if it is also on the fixed list, but it does no
15615 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15616 transport driver.
15617
15618
15619 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15620 .cindex "OpenSSL "compatibility options"
15621 This option allows an administrator to adjust the SSL options applied
15622 by OpenSSL to connections.  It is given as a space-separated list of items,
15623 each one to be +added or -subtracted from the current value.
15624
15625 This option is only available if Exim is built against OpenSSL.  The values
15626 available for this option vary according to the age of your OpenSSL install.
15627 The &"all"& value controls a subset of flags which are available, typically
15628 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15629 list the values known on your system and Exim should support all the
15630 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15631 names lose the leading &"SSL_OP_"& and are lower-cased.
15632
15633 Note that adjusting the options can have severe impact upon the security of
15634 SSL as used by Exim.  It is possible to disable safety checks and shoot
15635 yourself in the foot in various unpleasant ways.  This option should not be
15636 adjusted lightly.  An unrecognised item will be detected at startup, by
15637 invoking Exim with the &%-bV%& flag.
15638
15639 The option affects Exim operating both as a server and as a client.
15640
15641 Historical note: prior to release 4.80, Exim defaulted this value to
15642 "+dont_insert_empty_fragments", which may still be needed for compatibility
15643 with some clients, but which lowers security by increasing exposure to
15644 some now infamous attacks.
15645
15646 Examples:
15647 .code
15648 # Make both old MS and old Eudora happy:
15649 openssl_options = -all +microsoft_big_sslv3_buffer \
15650                        +dont_insert_empty_fragments
15651
15652 # Disable older protocol versions:
15653 openssl_options = +no_sslv2 +no_sslv3
15654 .endd
15655
15656 Possible options may include:
15657 .ilist
15658 &`all`&
15659 .next
15660 &`allow_unsafe_legacy_renegotiation`&
15661 .next
15662 &`cipher_server_preference`&
15663 .next
15664 &`dont_insert_empty_fragments`&
15665 .next
15666 &`ephemeral_rsa`&
15667 .next
15668 &`legacy_server_connect`&
15669 .next
15670 &`microsoft_big_sslv3_buffer`&
15671 .next
15672 &`microsoft_sess_id_bug`&
15673 .next
15674 &`msie_sslv2_rsa_padding`&
15675 .next
15676 &`netscape_challenge_bug`&
15677 .next
15678 &`netscape_reuse_cipher_change_bug`&
15679 .next
15680 &`no_compression`&
15681 .next
15682 &`no_session_resumption_on_renegotiation`&
15683 .next
15684 &`no_sslv2`&
15685 .next
15686 &`no_sslv3`&
15687 .next
15688 &`no_ticket`&
15689 .next
15690 &`no_tlsv1`&
15691 .next
15692 &`no_tlsv1_1`&
15693 .next
15694 &`no_tlsv1_2`&
15695 .next
15696 &`safari_ecdhe_ecdsa_bug`&
15697 .next
15698 &`single_dh_use`&
15699 .next
15700 &`single_ecdh_use`&
15701 .next
15702 &`ssleay_080_client_dh_bug`&
15703 .next
15704 &`sslref2_reuse_cert_type_bug`&
15705 .next
15706 &`tls_block_padding_bug`&
15707 .next
15708 &`tls_d5_bug`&
15709 .next
15710 &`tls_rollback_bug`&
15711 .endlist
15712
15713 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15714 all clients connecting using the MacOS SecureTransport TLS facility prior
15715 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15716 to negotiate TLS then this option value might help, provided that your OpenSSL
15717 release is new enough to contain this work-around.  This may be a situation
15718 where you have to upgrade OpenSSL to get buggy clients working.
15719
15720
15721 .option oracle_servers main "string list" unset
15722 .cindex "Oracle" "server list"
15723 This option provides a list of Oracle servers and associated connection data,
15724 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15725 The option is available only if Exim has been built with Oracle support.
15726
15727
15728 .option percent_hack_domains main "domain list&!!" unset
15729 .cindex "&""percent hack""&"
15730 .cindex "source routing" "in email address"
15731 .cindex "address" "source-routed"
15732 The &"percent hack"& is the convention whereby a local part containing a
15733 percent sign is re-interpreted as a new email address, with the percent
15734 replaced by @. This is sometimes called &"source routing"&, though that term is
15735 also applied to RFC 2822 addresses that begin with an @ character. If this
15736 option is set, Exim implements the percent facility for those domains listed,
15737 but no others. This happens before an incoming SMTP address is tested against
15738 an ACL.
15739
15740 &*Warning*&: The &"percent hack"& has often been abused by people who are
15741 trying to get round relaying restrictions. For this reason, it is best avoided
15742 if at all possible. Unfortunately, a number of less security-conscious MTAs
15743 implement it unconditionally. If you are running Exim on a gateway host, and
15744 routing mail through to internal MTAs without processing the local parts, it is
15745 a good idea to reject recipient addresses with percent characters in their
15746 local parts. Exim's default configuration does this.
15747
15748
15749 .option perl_at_start main boolean false
15750 .cindex "Perl"
15751 This option is available only when Exim is built with an embedded Perl
15752 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15753
15754
15755 .option perl_startup main string unset
15756 .cindex "Perl"
15757 This option is available only when Exim is built with an embedded Perl
15758 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15759
15760 .option perl_startup main boolean false
15761 .cindex "Perl"
15762 This Option enables the taint mode of the embedded Perl interpreter.
15763
15764
15765 .option pgsql_servers main "string list" unset
15766 .cindex "PostgreSQL lookup type" "server list"
15767 This option provides a list of PostgreSQL servers and associated connection
15768 data, to be used in conjunction with &(pgsql)& lookups (see section
15769 &<<SECID72>>&). The option is available only if Exim has been built with
15770 PostgreSQL support.
15771
15772
15773 .option pid_file_path main string&!! "set at compile time"
15774 .cindex "daemon" "pid file path"
15775 .cindex "pid file, path for"
15776 This option sets the name of the file to which the Exim daemon writes its
15777 process id. The string is expanded, so it can contain, for example, references
15778 to the host name:
15779 .code
15780 pid_file_path = /var/log/$primary_hostname/exim.pid
15781 .endd
15782 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15783 spool directory.
15784 The value set by the option can be overridden by the &%-oP%& command line
15785 option. A pid file is not written if a &"non-standard"& daemon is run by means
15786 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15787
15788
15789 .option pipelining_advertise_hosts main "host list&!!" *
15790 .cindex "PIPELINING" "suppressing advertising"
15791 This option can be used to suppress the advertisement of the SMTP
15792 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15793 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15794 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15795 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15796 that clients will use it; &"out of order"& commands that are &"expected"& do
15797 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15798
15799
15800 .option prdr_enable main boolean false
15801 .cindex "PRDR" "enabling on server"
15802 This option can be used to enable the Per-Recipient Data Response extension
15803 to SMTP, defined by Eric Hall.
15804 If the option is set, PRDR is advertised by Exim when operating as a server.
15805 If the client requests PRDR, and more than one recipient, for a message
15806 an additional ACL is called for each recipient after the message content
15807 is received.  See section &<<SECTPRDRACL>>&.
15808
15809 .option preserve_message_logs main boolean false
15810 .cindex "message logs" "preserving"
15811 If this option is set, message log files are not deleted when messages are
15812 completed. Instead, they are moved to a sub-directory of the spool directory
15813 called &_msglog.OLD_&, where they remain available for statistical or debugging
15814 purposes. This is a dangerous option to set on systems with any appreciable
15815 volume of mail. Use with care!
15816
15817
15818 .option primary_hostname main string "see below"
15819 .cindex "name" "of local host"
15820 .cindex "host" "name of local"
15821 .cindex "local host" "name of"
15822 .vindex "&$primary_hostname$&"
15823 This specifies the name of the current host. It is used in the default EHLO or
15824 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15825 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15826 The value is also used by default in some SMTP response messages from an Exim
15827 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15828
15829 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15830 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15831 contains only one component, Exim passes it to &[gethostbyname()]& (or
15832 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15833 version. The variable &$primary_hostname$& contains the host name, whether set
15834 explicitly by this option, or defaulted.
15835
15836
15837 .option print_topbitchars main boolean false
15838 .cindex "printing characters"
15839 .cindex "8-bit characters"
15840 By default, Exim considers only those characters whose codes lie in the range
15841 32&--126 to be printing characters. In a number of circumstances (for example,
15842 when writing log entries) non-printing characters are converted into escape
15843 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15844 is set, code values of 128 and above are also considered to be printing
15845 characters.
15846
15847 This option also affects the header syntax checks performed by the
15848 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15849 the user's full name when constructing From: and Sender: addresses (as
15850 described in section &<<SECTconstr>>&). Setting this option can cause
15851 Exim to generate eight bit message headers that do not conform to the
15852 standards.
15853
15854
15855 .option process_log_path main string unset
15856 .cindex "process log path"
15857 .cindex "log" "process log"
15858 .cindex "&'exiwhat'&"
15859 This option sets the name of the file to which an Exim process writes its
15860 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15861 utility script. If this option is unset, the file called &_exim-process.info_&
15862 in Exim's spool directory is used. The ability to specify the name explicitly
15863 can be useful in environments where two different Exims are running, using
15864 different spool directories.
15865
15866
15867 .option prod_requires_admin main boolean true
15868 .oindex "&%-M%&"
15869 .oindex "&%-R%&"
15870 .oindex "&%-q%&"
15871 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15872 admin user unless &%prod_requires_admin%& is set false. See also
15873 &%queue_list_requires_admin%&.
15874
15875
15876 .option qualify_domain main string "see below"
15877 .cindex "domain" "for qualifying addresses"
15878 .cindex "address" "qualification"
15879 This option specifies the domain name that is added to any envelope sender
15880 addresses that do not have a domain qualification. It also applies to
15881 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15882 are accepted by default only for locally-generated messages. Qualification is
15883 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15884 locally-generated messages, unless the &%-bnq%& command line option is used.
15885
15886 Messages from external sources must always contain fully qualified addresses,
15887 unless the sending host matches &%sender_unqualified_hosts%& or
15888 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15889 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15890 necessary. Internally, Exim always works with fully qualified envelope
15891 addresses. If &%qualify_domain%& is not set, it defaults to the
15892 &%primary_hostname%& value.
15893
15894
15895 .option qualify_recipient main string "see below"
15896 This option allows you to specify a different domain for qualifying recipient
15897 addresses to the one that is used for senders. See &%qualify_domain%& above.
15898
15899
15900
15901 .option queue_domains main "domain list&!!" unset
15902 .cindex "domain" "specifying non-immediate delivery"
15903 .cindex "queueing incoming messages"
15904 .cindex "message" "queueing certain domains"
15905 This option lists domains for which immediate delivery is not required.
15906 A delivery process is started whenever a message is received, but only those
15907 domains that do not match are processed. All other deliveries wait until the
15908 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15909
15910
15911 .option queue_list_requires_admin main boolean true
15912 .oindex "&%-bp%&"
15913 The &%-bp%& command-line option, which lists the messages that are on the
15914 queue, requires the caller to be an admin user unless
15915 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15916
15917
15918 .option queue_only main boolean false
15919 .cindex "queueing incoming messages"
15920 .cindex "message" "queueing unconditionally"
15921 If &%queue_only%& is set, a delivery process is not automatically started
15922 whenever a message is received. Instead, the message waits on the queue for the
15923 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15924 delivered immediately when certain conditions (such as heavy load) occur.
15925
15926 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15927 and &%-odi%& command line options override &%queue_only%& unless
15928 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15929 &%queue_only_load%&, and &%smtp_accept_queue%&.
15930
15931
15932 .option queue_only_file main string unset
15933 .cindex "queueing incoming messages"
15934 .cindex "message" "queueing by file existence"
15935 This option can be set to a colon-separated list of absolute path names, each
15936 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15937 it tests for the existence of each listed path using a call to &[stat()]&. For
15938 each path that exists, the corresponding queueing option is set.
15939 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15940 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15941 .code
15942 queue_only_file = smtp/some/file
15943 .endd
15944 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15945 &_/some/file_& exists.
15946
15947
15948 .option queue_only_load main fixed-point unset
15949 .cindex "load average"
15950 .cindex "queueing incoming messages"
15951 .cindex "message" "queueing by load"
15952 If the system load average is higher than this value, incoming messages from
15953 all sources are queued, and no automatic deliveries are started. If this
15954 happens during local or remote SMTP input, all subsequent messages received on
15955 the same SMTP connection are queued by default, whatever happens to the load in
15956 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15957 false.
15958
15959 Deliveries will subsequently be performed by queue runner processes. This
15960 option has no effect on ancient operating systems on which Exim cannot
15961 determine the load average. See also &%deliver_queue_load_max%& and
15962 &%smtp_load_reserve%&.
15963
15964
15965 .option queue_only_load_latch main boolean true
15966 .cindex "load average" "re-evaluating per message"
15967 When this option is true (the default), once one message has been queued
15968 because the load average is higher than the value set by &%queue_only_load%&,
15969 all subsequent messages received on the same SMTP connection are also queued.
15970 This is a deliberate choice; even though the load average may fall below the
15971 threshold, it doesn't seem right to deliver later messages on the same
15972 connection when not delivering earlier ones. However, there are special
15973 circumstances such as very long-lived connections from scanning appliances
15974 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15975 should be set false. This causes the value of the load average to be
15976 re-evaluated for each message.
15977
15978
15979 .option queue_only_override main boolean true
15980 .cindex "queueing incoming messages"
15981 When this option is true, the &%-od%&&'x'& command line options override the
15982 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15983 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15984 to override; they are accepted, but ignored.
15985
15986
15987 .option queue_run_in_order main boolean false
15988 .cindex "queue runner" "processing messages in order"
15989 If this option is set, queue runs happen in order of message arrival instead of
15990 in an arbitrary order. For this to happen, a complete list of the entire queue
15991 must be set up before the deliveries start. When the queue is all held in a
15992 single directory (the default), a single list is created for both the ordered
15993 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15994 single list is not created when &%queue_run_in_order%& is false. In this case,
15995 the sub-directories are processed one at a time (in a random order), and this
15996 avoids setting up one huge list for the whole queue. Thus, setting
15997 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15998 when the queue is large, because of the extra work in setting up the single,
15999 large list. In most situations, &%queue_run_in_order%& should not be set.
16000
16001
16002
16003 .option queue_run_max main integer&!! 5
16004 .cindex "queue runner" "maximum number of"
16005 This controls the maximum number of queue runner processes that an Exim daemon
16006 can run simultaneously. This does not mean that it starts them all at once,
16007 but rather that if the maximum number are still running when the time comes to
16008 start another one, it refrains from starting another one. This can happen with
16009 very large queues and/or very sluggish deliveries. This option does not,
16010 however, interlock with other processes, so additional queue runners can be
16011 started by other means, or by killing and restarting the daemon.
16012
16013 Setting this option to zero does not suppress queue runs; rather, it disables
16014 the limit, allowing any number of simultaneous queue runner processes to be
16015 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16016 the daemon's command line.
16017
16018 .new
16019 .cindex queues named
16020 .cindex "named queues"
16021 To set limits for different named queues use
16022 an expansion depending on the &$queue_name$& variable.
16023 .wen
16024
16025 .option queue_smtp_domains main "domain list&!!" unset
16026 .cindex "queueing incoming messages"
16027 .cindex "message" "queueing remote deliveries"
16028 When this option is set, a delivery process is started whenever a message is
16029 received, routing is performed, and local deliveries take place.
16030 However, if any SMTP deliveries are required for domains that match
16031 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16032 message waits on the queue for the next queue run. Since routing of the message
16033 has taken place, Exim knows to which remote hosts it must be delivered, and so
16034 when the queue run happens, multiple messages for the same host are delivered
16035 over a single SMTP connection. The &%-odqs%& command line option causes all
16036 SMTP deliveries to be queued in this way, and is equivalent to setting
16037 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16038 &%queue_domains%&.
16039
16040
16041 .option receive_timeout main time 0s
16042 .cindex "timeout" "for non-SMTP input"
16043 This option sets the timeout for accepting a non-SMTP message, that is, the
16044 maximum time that Exim waits when reading a message on the standard input. If
16045 the value is zero, it will wait for ever. This setting is overridden by the
16046 &%-or%& command line option. The timeout for incoming SMTP messages is
16047 controlled by &%smtp_receive_timeout%&.
16048
16049 .option received_header_text main string&!! "see below"
16050 .cindex "customizing" "&'Received:'& header"
16051 .cindex "&'Received:'& header line" "customizing"
16052 This string defines the contents of the &'Received:'& message header that is
16053 added to each message, except for the timestamp, which is automatically added
16054 on at the end (preceded by a semicolon). The string is expanded each time it is
16055 used. If the expansion yields an empty string, no &'Received:'& header line is
16056 added to the message. Otherwise, the string should start with the text
16057 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16058 header lines. The default setting is:
16059
16060 .code
16061 received_header_text = Received: \
16062   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16063   {${if def:sender_ident \
16064   {from ${quote_local_part:$sender_ident} }}\
16065   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16066   by $primary_hostname \
16067   ${if def:received_protocol {with $received_protocol}} \
16068   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16069   (Exim $version_number)\n\t\
16070   ${if def:sender_address \
16071   {(envelope-from <$sender_address>)\n\t}}\
16072   id $message_exim_id\
16073   ${if def:received_for {\n\tfor $received_for}}
16074 .endd
16075
16076 The reference to the TLS cipher is omitted when Exim is built without TLS
16077 support. The use of conditional expansions ensures that this works for both
16078 locally generated messages and messages received from remote hosts, giving
16079 header lines such as the following:
16080 .code
16081 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16082 by marley.carol.example with esmtp (Exim 4.00)
16083 (envelope-from <bob@carol.example>)
16084 id 16IOWa-00019l-00
16085 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16086 Received: by scrooge.carol.example with local (Exim 4.00)
16087 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16088 .endd
16089 Until the body of the message has been received, the timestamp is the time when
16090 the message started to be received. Once the body has arrived, and all policy
16091 checks have taken place, the timestamp is updated to the time at which the
16092 message was accepted.
16093
16094
16095 .option received_headers_max main integer 30
16096 .cindex "loop" "prevention"
16097 .cindex "mail loop prevention"
16098 .cindex "&'Received:'& header line" "counting"
16099 When a message is to be delivered, the number of &'Received:'& headers is
16100 counted, and if it is greater than this parameter, a mail loop is assumed to
16101 have occurred, the delivery is abandoned, and an error message is generated.
16102 This applies to both local and remote deliveries.
16103
16104
16105 .option recipient_unqualified_hosts main "host list&!!" unset
16106 .cindex "unqualified addresses"
16107 .cindex "host" "unqualified addresses from"
16108 This option lists those hosts from which Exim is prepared to accept unqualified
16109 recipient addresses in message envelopes. The addresses are made fully
16110 qualified by the addition of the &%qualify_recipient%& value. This option also
16111 affects message header lines. Exim does not reject unqualified recipient
16112 addresses in headers, but it qualifies them only if the message came from a
16113 host that matches &%recipient_unqualified_hosts%&,
16114 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16115 option was not set.
16116
16117
16118 .option recipients_max main integer 0
16119 .cindex "limit" "number of recipients"
16120 .cindex "recipient" "maximum number"
16121 If this option is set greater than zero, it specifies the maximum number of
16122 original recipients for any message. Additional recipients that are generated
16123 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16124 all recipients over the limit; earlier recipients are delivered as normal.
16125 Non-SMTP messages with too many recipients are failed, and no deliveries are
16126 done.
16127
16128 .cindex "RCPT" "maximum number of incoming"
16129 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16130 RCPT commands in a single message.
16131
16132
16133 .option recipients_max_reject main boolean false
16134 If this option is set true, Exim rejects SMTP messages containing too many
16135 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16136 error to the eventual DATA command. Otherwise (the default) it gives a 452
16137 error to the surplus RCPT commands and accepts the message on behalf of the
16138 initial set of recipients. The remote server should then re-send the message
16139 for the remaining recipients at a later time.
16140
16141
16142 .option remote_max_parallel main integer 2
16143 .cindex "delivery" "parallelism for remote"
16144 This option controls parallel delivery of one message to a number of remote
16145 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16146 does all the remote deliveries for a message one by one. Otherwise, if a single
16147 message has to be delivered to more than one remote host, or if several copies
16148 have to be sent to the same remote host, up to &%remote_max_parallel%&
16149 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16150 deliveries are required, the maximum number of processes are started, and as
16151 each one finishes, another is begun. The order of starting processes is the
16152 same as if sequential delivery were being done, and can be controlled by the
16153 &%remote_sort_domains%& option. If parallel delivery takes place while running
16154 with debugging turned on, the debugging output from each delivery process is
16155 tagged with its process id.
16156
16157 This option controls only the maximum number of parallel deliveries for one
16158 message in one Exim delivery process. Because Exim has no central queue
16159 manager, there is no way of controlling the total number of simultaneous
16160 deliveries if the configuration allows a delivery attempt as soon as a message
16161 is received.
16162
16163 .cindex "number of deliveries"
16164 .cindex "delivery" "maximum number of"
16165 If you want to control the total number of deliveries on the system, you
16166 need to set the &%queue_only%& option. This ensures that all incoming messages
16167 are added to the queue without starting a delivery process. Then set up an Exim
16168 daemon to start queue runner processes at appropriate intervals (probably
16169 fairly often, for example, every minute), and limit the total number of queue
16170 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16171 delivers only one message at a time, the maximum number of deliveries that can
16172 then take place at once is &%queue_run_max%& multiplied by
16173 &%remote_max_parallel%&.
16174
16175 If it is purely remote deliveries you want to control, use
16176 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16177 doing the SMTP routing before queueing, so that several messages for the same
16178 host will eventually get delivered down the same connection.
16179
16180
16181 .option remote_sort_domains main "domain list&!!" unset
16182 .cindex "sorting remote deliveries"
16183 .cindex "delivery" "sorting remote"
16184 When there are a number of remote deliveries for a message, they are sorted by
16185 domain into the order given by this list. For example,
16186 .code
16187 remote_sort_domains = *.cam.ac.uk:*.uk
16188 .endd
16189 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16190 then to those in the &%uk%& domain, then to any others.
16191
16192
16193 .option retry_data_expire main time 7d
16194 .cindex "hints database" "data expiry"
16195 This option sets a &"use before"& time on retry information in Exim's hints
16196 database. Any older retry data is ignored. This means that, for example, once a
16197 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16198 past failures.
16199
16200
16201 .option retry_interval_max main time 24h
16202 .cindex "retry" "limit on interval"
16203 .cindex "limit" "on retry interval"
16204 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16205 intervals between delivery attempts for messages that cannot be delivered
16206 straight away. This option sets an overall limit to the length of time between
16207 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16208 the default value.
16209
16210
16211 .option return_path_remove main boolean true
16212 .cindex "&'Return-path:'& header line" "removing"
16213 RFC 2821, section 4.4, states that an SMTP server must insert a
16214 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16215 The &'Return-path:'& header preserves the sender address as received in the
16216 MAIL command. This description implies that this header should not be present
16217 in an incoming message. If &%return_path_remove%& is true, any existing
16218 &'Return-path:'& headers are removed from messages at the time they are
16219 received. Exim's transports have options for adding &'Return-path:'& headers at
16220 the time of delivery. They are normally used only for final local deliveries.
16221
16222
16223 .option return_size_limit main integer 100K
16224 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16225
16226
16227 .option rfc1413_hosts main "host list&!!" @[]
16228 .cindex "RFC 1413"
16229 .cindex "host" "for RFC 1413 calls"
16230 RFC 1413 identification calls are made to any client host which matches
16231 an item in the list.
16232 The default value specifies just this host, being any local interface
16233 for the system.
16234
16235 .option rfc1413_query_timeout main time 0s
16236 .cindex "RFC 1413" "query timeout"
16237 .cindex "timeout" "for RFC 1413 call"
16238 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16239 no RFC 1413 calls are ever made.
16240
16241
16242 .option sender_unqualified_hosts main "host list&!!" unset
16243 .cindex "unqualified addresses"
16244 .cindex "host" "unqualified addresses from"
16245 This option lists those hosts from which Exim is prepared to accept unqualified
16246 sender addresses. The addresses are made fully qualified by the addition of
16247 &%qualify_domain%&. This option also affects message header lines. Exim does
16248 not reject unqualified addresses in headers that contain sender addresses, but
16249 it qualifies them only if the message came from a host that matches
16250 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16251 using TCP/IP), and the &%-bnq%& option was not set.
16252
16253 .option set_environment main "string list" empty
16254 .cindex "environment"
16255 This option allows to set individual environment variables that the
16256 currently linked libraries and programs in child processes use. The
16257 default list is empty,
16258
16259
16260 .option slow_lookup_log main integer 0
16261 .cindex "logging" "slow lookups"
16262 .cindex "dns" "logging slow lookups"
16263 This option controls logging of slow lookups.
16264 If the value is nonzero it is taken as a number of milliseconds
16265 and lookups taking longer than this are logged.
16266 Currently this applies only to DNS lookups.
16267
16268
16269
16270 .option smtp_accept_keepalive main boolean true
16271 .cindex "keepalive" "on incoming connection"
16272 This option controls the setting of the SO_KEEPALIVE option on incoming
16273 TCP/IP socket connections. When set, it causes the kernel to probe idle
16274 connections periodically, by sending packets with &"old"& sequence numbers. The
16275 other end of the connection should send an acknowledgment if the connection is
16276 still okay or a reset if the connection has been aborted. The reason for doing
16277 this is that it has the beneficial effect of freeing up certain types of
16278 connection that can get stuck when the remote host is disconnected without
16279 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16280 hours to detect unreachable hosts.
16281
16282
16283
16284 .option smtp_accept_max main integer 20
16285 .cindex "limit" "incoming SMTP connections"
16286 .cindex "SMTP" "incoming connection count"
16287 .cindex "inetd"
16288 This option specifies the maximum number of simultaneous incoming SMTP calls
16289 that Exim will accept. It applies only to the listening daemon; there is no
16290 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16291 value is set to zero, no limit is applied. However, it is required to be
16292 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16293 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16294
16295 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16296 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16297 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16298 and &%smtp_load_reserve%& are then checked before accepting the connection.
16299
16300
16301 .option smtp_accept_max_nonmail main integer 10
16302 .cindex "limit" "non-mail SMTP commands"
16303 .cindex "SMTP" "limiting non-mail commands"
16304 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16305 the connection if there are too many. This option defines &"too many"&. The
16306 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16307 client looping sending EHLO, for example. The check is applied only if the
16308 client host matches &%smtp_accept_max_nonmail_hosts%&.
16309
16310 When a new message is expected, one occurrence of RSET is not counted. This
16311 allows a client to send one RSET between messages (this is not necessary,
16312 but some clients do it). Exim also allows one uncounted occurrence of HELO
16313 or EHLO, and one occurrence of STARTTLS between messages. After
16314 starting up a TLS session, another EHLO is expected, and so it too is not
16315 counted. The first occurrence of AUTH in a connection, or immediately
16316 following STARTTLS is not counted. Otherwise, all commands other than
16317 MAIL, RCPT, DATA, and QUIT are counted.
16318
16319
16320 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16321 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16322 check by setting this option. The default value makes it apply to all hosts. By
16323 changing the value, you can exclude any badly-behaved hosts that you have to
16324 live with.
16325
16326
16327 . Allow this long option name to split; give it unsplit as a fifth argument
16328 . for the automatic .oindex that is generated by .option.
16329 . We insert " &~&~" which is both pretty nasty visually and results in
16330 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16331 . zero-width-space, which would be nicer visually and results in (at least)
16332 . html that Firefox will split on when it's forced to reflow (rather than
16333 . inserting a horizontal scrollbar).  However, the text is still not
16334 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16335 . the option name to split.
16336
16337 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16338          smtp_accept_max_per_connection
16339 .cindex "SMTP" "limiting incoming message count"
16340 .cindex "limit" "messages per SMTP connection"
16341 The value of this option limits the number of MAIL commands that Exim is
16342 prepared to accept over a single SMTP connection, whether or not each command
16343 results in the transfer of a message. After the limit is reached, a 421
16344 response is given to subsequent MAIL commands. This limit is a safety
16345 precaution against a client that goes mad (incidents of this type have been
16346 seen).
16347
16348
16349 .option smtp_accept_max_per_host main string&!! unset
16350 .cindex "limit" "SMTP connections from one host"
16351 .cindex "host" "limiting SMTP connections from"
16352 This option restricts the number of simultaneous IP connections from a single
16353 host (strictly, from a single IP address) to the Exim daemon. The option is
16354 expanded, to enable different limits to be applied to different hosts by
16355 reference to &$sender_host_address$&. Once the limit is reached, additional
16356 connection attempts from the same host are rejected with error code 421. This
16357 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16358 of zero imposes no limit. If this option is set greater than zero, it is
16359 required that &%smtp_accept_max%& be non-zero.
16360
16361 &*Warning*&: When setting this option you should not use any expansion
16362 constructions that take an appreciable amount of time. The expansion and test
16363 happen in the main daemon loop, in order to reject additional connections
16364 without forking additional processes (otherwise a denial-of-service attack
16365 could cause a vast number or processes to be created). While the daemon is
16366 doing this processing, it cannot accept any other incoming connections.
16367
16368
16369
16370 .option smtp_accept_queue main integer 0
16371 .cindex "SMTP" "incoming connection count"
16372 .cindex "queueing incoming messages"
16373 .cindex "message" "queueing by SMTP connection count"
16374 If the number of simultaneous incoming SMTP connections being handled via the
16375 listening daemon exceeds this value, messages received by SMTP are just placed
16376 on the queue; no delivery processes are started automatically. The count is
16377 fixed at the start of an SMTP connection. It cannot be updated in the
16378 subprocess that receives messages, and so the queueing or not queueing applies
16379 to all messages received in the same connection.
16380
16381 A value of zero implies no limit, and clearly any non-zero value is useful only
16382 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16383 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16384 various &%-od%&&'x'& command line options.
16385
16386
16387 . See the comment on smtp_accept_max_per_connection
16388
16389 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16390          smtp_accept_queue_per_connection
16391 .cindex "queueing incoming messages"
16392 .cindex "message" "queueing by message count"
16393 This option limits the number of delivery processes that Exim starts
16394 automatically when receiving messages via SMTP, whether via the daemon or by
16395 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16396 and the number of messages received in a single SMTP session exceeds this
16397 number, subsequent messages are placed on the queue, but no delivery processes
16398 are started. This helps to limit the number of Exim processes when a server
16399 restarts after downtime and there is a lot of mail waiting for it on other
16400 systems. On large systems, the default should probably be increased, and on
16401 dial-in client systems it should probably be set to zero (that is, disabled).
16402
16403
16404 .option smtp_accept_reserve main integer 0
16405 .cindex "SMTP" "incoming call count"
16406 .cindex "host" "reserved"
16407 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16408 number of SMTP connections that are reserved for connections from the hosts
16409 that are specified in &%smtp_reserve_hosts%&. The value set in
16410 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16411 restricted to this number of connections; the option specifies a minimum number
16412 of connection slots for them, not a maximum. It is a guarantee that this group
16413 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16414 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16415 individual host.
16416
16417 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16418 set to 5, once there are 45 active connections (from any hosts), new
16419 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16420 provided the other criteria for acceptance are met.
16421
16422
16423 .option smtp_active_hostname main string&!! unset
16424 .cindex "host" "name in SMTP responses"
16425 .cindex "SMTP" "host name in responses"
16426 .vindex "&$primary_hostname$&"
16427 This option is provided for multi-homed servers that want to masquerade as
16428 several different hosts. At the start of an incoming SMTP connection, its value
16429 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16430 responses. For example, it is used as domain name in the response to an
16431 incoming HELO or EHLO command.
16432
16433 .vindex "&$smtp_active_hostname$&"
16434 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16435 is saved with any messages that are received. It is therefore available for use
16436 in routers and transports when the message is later delivered.
16437
16438 If this option is unset, or if its expansion is forced to fail, or if the
16439 expansion results in an empty string, the value of &$primary_hostname$& is
16440 used. Other expansion failures cause a message to be written to the main and
16441 panic logs, and the SMTP command receives a temporary error. Typically, the
16442 value of &%smtp_active_hostname%& depends on the incoming interface address.
16443 For example:
16444 .code
16445 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16446   {cox.mydomain}{box.mydomain}}
16447 .endd
16448
16449 Although &$smtp_active_hostname$& is primarily concerned with incoming
16450 messages, it is also used as the default for HELO commands in callout
16451 verification if there is no remote transport from which to obtain a
16452 &%helo_data%& value.
16453
16454 .option smtp_banner main string&!! "see below"
16455 .cindex "SMTP" "welcome banner"
16456 .cindex "banner for SMTP"
16457 .cindex "welcome banner for SMTP"
16458 .cindex "customizing" "SMTP banner"
16459 This string, which is expanded every time it is used, is output as the initial
16460 positive response to an SMTP connection. The default setting is:
16461 .code
16462 smtp_banner = $smtp_active_hostname ESMTP Exim \
16463   $version_number $tod_full
16464 .endd
16465 Failure to expand the string causes a panic error. If you want to create a
16466 multiline response to the initial SMTP connection, use &"\n"& in the string at
16467 appropriate points, but not at the end. Note that the 220 code is not included
16468 in this string. Exim adds it automatically (several times in the case of a
16469 multiline response).
16470
16471
16472 .option smtp_check_spool_space main boolean true
16473 .cindex "checking disk space"
16474 .cindex "disk space, checking"
16475 .cindex "spool directory" "checking space"
16476 When this option is set, if an incoming SMTP session encounters the SIZE
16477 option on a MAIL command, it checks that there is enough space in the
16478 spool directory's partition to accept a message of that size, while still
16479 leaving free the amount specified by &%check_spool_space%& (even if that value
16480 is zero). If there isn't enough space, a temporary error code is returned.
16481
16482
16483 .option smtp_connect_backlog main integer 20
16484 .cindex "connection backlog"
16485 .cindex "SMTP" "connection backlog"
16486 .cindex "backlog of connections"
16487 This option specifies a maximum number of waiting SMTP connections. Exim passes
16488 this value to the TCP/IP system when it sets up its listener. Once this number
16489 of connections are waiting for the daemon's attention, subsequent connection
16490 attempts are refused at the TCP/IP level. At least, that is what the manuals
16491 say; in some circumstances such connection attempts have been observed to time
16492 out instead. For large systems it is probably a good idea to increase the
16493 value (to 50, say). It also gives some protection against denial-of-service
16494 attacks by SYN flooding.
16495
16496
16497 .option smtp_enforce_sync main boolean true
16498 .cindex "SMTP" "synchronization checking"
16499 .cindex "synchronization checking in SMTP"
16500 The SMTP protocol specification requires the client to wait for a response from
16501 the server at certain points in the dialogue. Without PIPELINING these
16502 synchronization points are after every command; with PIPELINING they are
16503 fewer, but they still exist.
16504
16505 Some spamming sites send out a complete set of SMTP commands without waiting
16506 for any response. Exim protects against this by rejecting a message if the
16507 client has sent further input when it should not have. The error response &"554
16508 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16509 for this error cannot be perfect because of transmission delays (unexpected
16510 input may be on its way but not yet received when Exim checks). However, it
16511 does detect many instances.
16512
16513 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16514 If you want to disable the check selectively (for example, only for certain
16515 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16516 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16517
16518
16519
16520 .option smtp_etrn_command main string&!! unset
16521 .cindex "ETRN" "command to be run"
16522 .vindex "&$domain$&"
16523 If this option is set, the given command is run whenever an SMTP ETRN
16524 command is received from a host that is permitted to issue such commands (see
16525 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16526 are independently expanded. The expansion variable &$domain$& is set to the
16527 argument of the ETRN command, and no syntax checking is done on it. For
16528 example:
16529 .code
16530 smtp_etrn_command = /etc/etrn_command $domain \
16531                     $sender_host_address
16532 .endd
16533 A new process is created to run the command, but Exim does not wait for it to
16534 complete. Consequently, its status cannot be checked. If the command cannot be
16535 run, a line is written to the panic log, but the ETRN caller still receives
16536 a 250 success response. Exim is normally running under its own uid when
16537 receiving SMTP, so it is not possible for it to change the uid before running
16538 the command.
16539
16540
16541 .option smtp_etrn_serialize main boolean true
16542 .cindex "ETRN" "serializing"
16543 When this option is set, it prevents the simultaneous execution of more than
16544 one identical command as a result of ETRN in an SMTP connection. See
16545 section &<<SECTETRN>>& for details.
16546
16547
16548 .option smtp_load_reserve main fixed-point unset
16549 .cindex "load average"
16550 If the system load average ever gets higher than this, incoming SMTP calls are
16551 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16552 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16553 the load is over the limit. The option has no effect on ancient operating
16554 systems on which Exim cannot determine the load average. See also
16555 &%deliver_queue_load_max%& and &%queue_only_load%&.
16556
16557
16558
16559 .option smtp_max_synprot_errors main integer 3
16560 .cindex "SMTP" "limiting syntax and protocol errors"
16561 .cindex "limit" "SMTP syntax and protocol errors"
16562 Exim rejects SMTP commands that contain syntax or protocol errors. In
16563 particular, a syntactically invalid email address, as in this command:
16564 .code
16565 RCPT TO:<abc xyz@a.b.c>
16566 .endd
16567 causes immediate rejection of the command, before any other tests are done.
16568 (The ACL cannot be run if there is no valid address to set up for it.) An
16569 example of a protocol error is receiving RCPT before MAIL. If there are
16570 too many syntax or protocol errors in one SMTP session, the connection is
16571 dropped. The limit is set by this option.
16572
16573 .cindex "PIPELINING" "expected errors"
16574 When the PIPELINING extension to SMTP is in use, some protocol errors are
16575 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16576 Exim assumes that PIPELINING will be used if it advertises it (see
16577 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16578 not count towards the limit.
16579
16580
16581
16582 .option smtp_max_unknown_commands main integer 3
16583 .cindex "SMTP" "limiting unknown commands"
16584 .cindex "limit" "unknown SMTP commands"
16585 If there are too many unrecognized commands in an incoming SMTP session, an
16586 Exim server drops the connection. This is a defence against some kinds of abuse
16587 that subvert web
16588 clients
16589 into making connections to SMTP ports; in these circumstances, a number of
16590 non-SMTP command lines are sent first.
16591
16592
16593
16594 .option smtp_ratelimit_hosts main "host list&!!" unset
16595 .cindex "SMTP" "rate limiting"
16596 .cindex "limit" "rate of message arrival"
16597 .cindex "RCPT" "rate limiting"
16598 Some sites find it helpful to be able to limit the rate at which certain hosts
16599 can send them messages, and the rate at which an individual message can specify
16600 recipients.
16601
16602 Exim has two rate-limiting facilities. This section describes the older
16603 facility, which can limit rates within a single connection. The newer
16604 &%ratelimit%& ACL condition can limit rates across all connections. See section
16605 &<<SECTratelimiting>>& for details of the newer facility.
16606
16607 When a host matches &%smtp_ratelimit_hosts%&, the values of
16608 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16609 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16610 respectively. Each option, if set, must contain a set of four comma-separated
16611 values:
16612
16613 .ilist
16614 A threshold, before which there is no rate limiting.
16615 .next
16616 An initial time delay. Unlike other times in Exim, numbers with decimal
16617 fractional parts are allowed here.
16618 .next
16619 A factor by which to increase the delay each time.
16620 .next
16621 A maximum value for the delay. This should normally be less than 5 minutes,
16622 because after that time, the client is liable to timeout the SMTP command.
16623 .endlist
16624
16625 For example, these settings have been used successfully at the site which
16626 first suggested this feature, for controlling mail from their customers:
16627 .code
16628 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16629 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16630 .endd
16631 The first setting specifies delays that are applied to MAIL commands after
16632 two have been received over a single connection. The initial delay is 0.5
16633 seconds, increasing by a factor of 1.05 each time. The second setting applies
16634 delays to RCPT commands when more than four occur in a single message.
16635
16636
16637 .option smtp_ratelimit_mail main string unset
16638 See &%smtp_ratelimit_hosts%& above.
16639
16640
16641 .option smtp_ratelimit_rcpt main string unset
16642 See &%smtp_ratelimit_hosts%& above.
16643
16644
16645 .option smtp_receive_timeout main time&!! 5m
16646 .cindex "timeout" "for SMTP input"
16647 .cindex "SMTP" "input timeout"
16648 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16649 input, including batch SMTP. If a line of input (either an SMTP command or a
16650 data line) is not received within this time, the SMTP connection is dropped and
16651 the message is abandoned.
16652 A line is written to the log containing one of the following messages:
16653 .code
16654 SMTP command timeout on connection from...
16655 SMTP data timeout on connection from...
16656 .endd
16657 The former means that Exim was expecting to read an SMTP command; the latter
16658 means that it was in the DATA phase, reading the contents of a message.
16659
16660 If the first character of the option is a &"$"& the option is
16661 expanded before use and may depend on
16662 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16663
16664
16665 .oindex "&%-os%&"
16666 The value set by this option can be overridden by the
16667 &%-os%& command-line option. A setting of zero time disables the timeout, but
16668 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16669 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16670 timeout is controlled by &%receive_timeout%& and &%-or%&.
16671
16672
16673 .option smtp_reserve_hosts main "host list&!!" unset
16674 This option defines hosts for which SMTP connections are reserved; see
16675 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16676
16677
16678 .option smtp_return_error_details main boolean false
16679 .cindex "SMTP" "details policy failures"
16680 .cindex "policy control" "rejection, returning details"
16681 In the default state, Exim uses bland messages such as
16682 &"Administrative prohibition"& when it rejects SMTP commands for policy
16683 reasons. Many sysadmins like this because it gives away little information
16684 to spammers. However, some other sysadmins who are applying strict checking
16685 policies want to give out much fuller information about failures. Setting
16686 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16687 example, instead of &"Administrative prohibition"&, it might give:
16688 .code
16689 550-Rejected after DATA: '>' missing at end of address:
16690 550 failing address in "From" header is: <user@dom.ain
16691 .endd
16692
16693
16694 .option smtputf8_advertise_hosts main "host list&!!" *
16695 .cindex "SMTPUTF8" "advertising"
16696 When Exim is built with support for internationalised mail names,
16697 the availability therof is advertised in
16698 response to EHLO only to those client hosts that match this option. See
16699 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16700
16701
16702 .option spamd_address main string "see below"
16703 This option is available when Exim is compiled with the content-scanning
16704 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16705 The default value is
16706 .code
16707 127.0.0.1 783
16708 .endd
16709 See section &<<SECTscanspamass>>& for more details.
16710
16711
16712
16713 .option split_spool_directory main boolean false
16714 .cindex "multiple spool directories"
16715 .cindex "spool directory" "split"
16716 .cindex "directories, multiple"
16717 If this option is set, it causes Exim to split its input directory into 62
16718 subdirectories, each with a single alphanumeric character as its name. The
16719 sixth character of the message id is used to allocate messages to
16720 subdirectories; this is the least significant base-62 digit of the time of
16721 arrival of the message.
16722
16723 Splitting up the spool in this way may provide better performance on systems
16724 where there are long mail queues, by reducing the number of files in any one
16725 directory. The msglog directory is also split up in a similar way to the input
16726 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16727 are still placed in the single directory &_msglog.OLD_&.
16728
16729 It is not necessary to take any special action for existing messages when
16730 changing &%split_spool_directory%&. Exim notices messages that are in the
16731 &"wrong"& place, and continues to process them. If the option is turned off
16732 after a period of being on, the subdirectories will eventually empty and be
16733 automatically deleted.
16734
16735 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16736 changes. Instead of creating a list of all messages in the queue, and then
16737 trying to deliver each one in turn, it constructs a list of those in one
16738 sub-directory and tries to deliver them, before moving on to the next
16739 sub-directory. The sub-directories are processed in a random order. This
16740 spreads out the scanning of the input directories, and uses less memory. It is
16741 particularly beneficial when there are lots of messages on the queue. However,
16742 if &%queue_run_in_order%& is set, none of this new processing happens. The
16743 entire queue has to be scanned and sorted before any deliveries can start.
16744
16745
16746 .option spool_directory main string&!! "set at compile time"
16747 .cindex "spool directory" "path to"
16748 This defines the directory in which Exim keeps its spool, that is, the messages
16749 it is waiting to deliver. The default value is taken from the compile-time
16750 configuration setting, if there is one. If not, this option must be set. The
16751 string is expanded, so it can contain, for example, a reference to
16752 &$primary_hostname$&.
16753
16754 If the spool directory name is fixed on your installation, it is recommended
16755 that you set it at build time rather than from this option, particularly if the
16756 log files are being written to the spool directory (see &%log_file_path%&).
16757 Otherwise log files cannot be used for errors that are detected early on, such
16758 as failures in the configuration file.
16759
16760 By using this option to override the compiled-in path, it is possible to run
16761 tests of Exim without using the standard spool.
16762
16763 .option sqlite_lock_timeout main time 5s
16764 .cindex "sqlite lookup type" "lock timeout"
16765 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16766 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16767
16768 .option strict_acl_vars main boolean false
16769 .cindex "&ACL;" "variables, handling unset"
16770 This option controls what happens if a syntactically valid but undefined ACL
16771 variable is referenced. If it is false (the default), an empty string
16772 is substituted; if it is true, an error is generated. See section
16773 &<<SECTaclvariables>>& for details of ACL variables.
16774
16775 .option strip_excess_angle_brackets main boolean false
16776 .cindex "angle brackets, excess"
16777 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16778 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16779 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16780 passed on to another MTA, the excess angle brackets are not passed on. If this
16781 option is not set, multiple pairs of angle brackets cause a syntax error.
16782
16783
16784 .option strip_trailing_dot main boolean false
16785 .cindex "trailing dot on domain"
16786 .cindex "dot" "trailing on domain"
16787 If this option is set, a trailing dot at the end of a domain in an address is
16788 ignored. If this is in the envelope and the message is passed on to another
16789 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16790 domain causes a syntax error.
16791 However, addresses in header lines are checked only when an ACL requests header
16792 syntax checking.
16793
16794
16795 .option syslog_duplication main boolean true
16796 .cindex "syslog" "duplicate log lines; suppressing"
16797 When Exim is logging to syslog, it writes the log lines for its three
16798 separate logs at different syslog priorities so that they can in principle
16799 be separated on the logging hosts. Some installations do not require this
16800 separation, and in those cases, the duplication of certain log lines is a
16801 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16802 particular log line is written to syslog. For lines that normally go to
16803 both the main log and the reject log, the reject log version (possibly
16804 containing message header lines) is written, at LOG_NOTICE priority.
16805 Lines that normally go to both the main and the panic log are written at
16806 the LOG_ALERT priority.
16807
16808
16809 .option syslog_facility main string unset
16810 .cindex "syslog" "facility; setting"
16811 This option sets the syslog &"facility"& name, used when Exim is logging to
16812 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16813 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16814 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16815 details of Exim's logging.
16816
16817
16818
16819 .option syslog_processname main string &`exim`&
16820 .cindex "syslog" "process name; setting"
16821 This option sets the syslog &"ident"& name, used when Exim is logging to
16822 syslog. The value must be no longer than 32 characters. See chapter
16823 &<<CHAPlog>>& for details of Exim's logging.
16824
16825
16826
16827 .option syslog_timestamp main boolean true
16828 .cindex "syslog" "timestamps"
16829 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16830 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16831 details of Exim's logging.
16832
16833
16834 .option system_filter main string&!! unset
16835 .cindex "filter" "system filter"
16836 .cindex "system filter" "specifying"
16837 .cindex "Sieve filter" "not available for system filter"
16838 This option specifies an Exim filter file that is applied to all messages at
16839 the start of each delivery attempt, before any routing is done. System filters
16840 must be Exim filters; they cannot be Sieve filters. If the system filter
16841 generates any deliveries to files or pipes, or any new mail messages, the
16842 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16843 which transports are to be used. Details of this facility are given in chapter
16844 &<<CHAPsystemfilter>>&.
16845
16846
16847 .option system_filter_directory_transport main string&!! unset
16848 .vindex "&$address_file$&"
16849 This sets the name of the transport driver that is to be used when the
16850 &%save%& command in a system message filter specifies a path ending in &"/"&,
16851 implying delivery of each message into a separate file in some directory.
16852 During the delivery, the variable &$address_file$& contains the path name.
16853
16854
16855 .option system_filter_file_transport main string&!! unset
16856 .cindex "file" "transport for system filter"
16857 This sets the name of the transport driver that is to be used when the &%save%&
16858 command in a system message filter specifies a path not ending in &"/"&. During
16859 the delivery, the variable &$address_file$& contains the path name.
16860
16861 .option system_filter_group main string unset
16862 .cindex "gid (group id)" "system filter"
16863 This option is used only when &%system_filter_user%& is also set. It sets the
16864 gid under which the system filter is run, overriding any gid that is associated
16865 with the user. The value may be numerical or symbolic.
16866
16867 .option system_filter_pipe_transport main string&!! unset
16868 .cindex "&(pipe)& transport" "for system filter"
16869 .vindex "&$address_pipe$&"
16870 This specifies the transport driver that is to be used when a &%pipe%& command
16871 is used in a system filter. During the delivery, the variable &$address_pipe$&
16872 contains the pipe command.
16873
16874
16875 .option system_filter_reply_transport main string&!! unset
16876 .cindex "&(autoreply)& transport" "for system filter"
16877 This specifies the transport driver that is to be used when a &%mail%& command
16878 is used in a system filter.
16879
16880
16881 .option system_filter_user main string unset
16882 .cindex "uid (user id)" "system filter"
16883 If this option is set to root, the system filter is run in the main Exim
16884 delivery process, as root.  Otherwise, the system filter runs in a separate
16885 process, as the given user, defaulting to the Exim run-time user.
16886 Unless the string consists entirely of digits, it
16887 is looked up in the password data. Failure to find the named user causes a
16888 configuration error. The gid is either taken from the password data, or
16889 specified by &%system_filter_group%&. When the uid is specified numerically,
16890 &%system_filter_group%& is required to be set.
16891
16892 If the system filter generates any pipe, file, or reply deliveries, the uid
16893 under which the filter is run is used when transporting them, unless a
16894 transport option overrides.
16895
16896
16897 .option tcp_nodelay main boolean true
16898 .cindex "daemon" "TCP_NODELAY on sockets"
16899 .cindex "Nagle algorithm"
16900 .cindex "TCP_NODELAY on listening sockets"
16901 If this option is set false, it stops the Exim daemon setting the
16902 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16903 turns off the &"Nagle algorithm"&, which is a way of improving network
16904 performance in interactive (character-by-character) situations. Turning it off
16905 should improve Exim's performance a bit, so that is what happens by default.
16906 However, it appears that some broken clients cannot cope, and time out. Hence
16907 this option. It affects only those sockets that are set up for listening by the
16908 daemon. Sockets created by the smtp transport for delivering mail always set
16909 TCP_NODELAY.
16910
16911
16912 .option timeout_frozen_after main time 0s
16913 .cindex "frozen messages" "timing out"
16914 .cindex "timeout" "frozen messages"
16915 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16916 message of any kind that has been on the queue for longer than the given time
16917 is automatically cancelled at the next queue run. If the frozen message is a
16918 bounce message, it is just discarded; otherwise, a bounce is sent to the
16919 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16920 If you want to timeout frozen bounce messages earlier than other kinds of
16921 frozen message, see &%ignore_bounce_errors_after%&.
16922
16923 &*Note:*& the default value of zero means no timeouts; with this setting,
16924 frozen messages remain on the queue forever (except for any frozen bounce
16925 messages that are released by &%ignore_bounce_errors_after%&).
16926
16927
16928 .option timezone main string unset
16929 .cindex "timezone, setting"
16930 .cindex "environment" "values from"
16931 The value of &%timezone%& is used to set the environment variable TZ while
16932 running Exim (if it is different on entry). This ensures that all timestamps
16933 created by Exim are in the required timezone. If you want all your timestamps
16934 to be in UTC (aka GMT) you should set
16935 .code
16936 timezone = UTC
16937 .endd
16938 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16939 or, if that is not set, from the value of the TZ environment variable when Exim
16940 is built. If &%timezone%& is set to the empty string, either at build or run
16941 time, any existing TZ variable is removed from the environment when Exim
16942 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16943 unfortunately not all, operating systems.
16944
16945
16946 .option tls_advertise_hosts main "host list&!!" *
16947 .cindex "TLS" "advertising"
16948 .cindex "encryption" "on SMTP connection"
16949 .cindex "SMTP" "encrypted connection"
16950 When Exim is built with support for TLS encrypted connections, the availability
16951 of the STARTTLS command to set up an encrypted session is advertised in
16952 response to EHLO only to those client hosts that match this option. See
16953 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16954 Note that the default value requires that a certificate be supplied
16955 using the &%tls_certificate%& option.  If TLS support for incoming connections
16956 is not required the &%tls_advertise_hosts%& option should be set empty.
16957
16958
16959 .option tls_certificate main string&!! unset
16960 .cindex "TLS" "server certificate; location of"
16961 .cindex "certificate" "server, location of"
16962 The value of this option is expanded, and must then be the absolute path to a
16963 file which contains the server's certificates. The server's private key is also
16964 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16965 &<<CHAPTLS>>& for further details.
16966
16967 &*Note*&: The certificates defined by this option are used only when Exim is
16968 receiving incoming messages as a server. If you want to supply certificates for
16969 use when sending messages as a client, you must set the &%tls_certificate%&
16970 option in the relevant &(smtp)& transport.
16971
16972 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16973 if the OpenSSL build supports TLS extensions and the TLS client sends the
16974 Server Name Indication extension, then this option and others documented in
16975 &<<SECTtlssni>>& will be re-expanded.
16976
16977 .new
16978 If this option is unset or empty a fresh self-signed certificate will be
16979 generated for every connection.
16980 .wen
16981
16982 .option tls_crl main string&!! unset
16983 .cindex "TLS" "server certificate revocation list"
16984 .cindex "certificate" "revocation list for server"
16985 This option specifies a certificate revocation list. The expanded value must
16986 be the name of a file that contains a CRL in PEM format.
16987
16988 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16989
16990
16991 .option tls_dh_max_bits main integer 2236
16992 .cindex "TLS" "D-H bit count"
16993 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16994 the chosen TLS library.  That value might prove to be too high for
16995 interoperability.  This option provides a maximum clamp on the value
16996 suggested, trading off security for interoperability.
16997
16998 The value must be at least 1024.
16999
17000 The value 2236 was chosen because, at time of adding the option, it was the
17001 hard-coded maximum value supported by the NSS cryptographic library, as used
17002 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17003
17004 If you prefer more security and are willing to break some clients, raise this
17005 number.
17006
17007 Note that the value passed to GnuTLS for *generating* a new prime may be a
17008 little less than this figure, because GnuTLS is inexact and may produce a
17009 larger prime than requested.
17010
17011
17012 .option tls_dhparam main string&!! unset
17013 .cindex "TLS" "D-H parameters for server"
17014 The value of this option is expanded and indicates the source of DH parameters
17015 to be used by Exim.
17016
17017 If it is a filename starting with a &`/`&, then it names a file from which DH
17018 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17019 PKCS#3 representation of the DH prime.  If the file does not exist, for
17020 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17021 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17022 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17023 and treated as though the &%tls_dhparam%& were set to "none".
17024
17025 If this option expands to the string "none", then no DH parameters will be
17026 loaded by Exim.
17027
17028 If this option expands to the string "historic" and Exim is using GnuTLS, then
17029 Exim will attempt to load a file from inside the spool directory.  If the file
17030 does not exist, Exim will attempt to create it.
17031 See section &<<SECTgnutlsparam>>& for further details.
17032
17033 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17034 a default DH prime; the default is the 2048 bit prime described in section
17035 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17036 in IKE is assigned number 23.
17037
17038 Otherwise, the option must expand to the name used by Exim for any of a number
17039 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
17040 "ike" followed by the number used by IKE, or "default" which corresponds to
17041 "ike23".
17042
17043 The available primes are:
17044 &`ike1`&, &`ike2`&, &`ike5`&,
17045 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17046 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
17047
17048 Some of these will be too small to be accepted by clients.
17049 Some may be too large to be accepted by clients.
17050
17051 The TLS protocol does not negotiate an acceptable size for this; clients tend
17052 to hard-drop connections if what is offered by the server is unacceptable,
17053 whether too large or too small, and there's no provision for the client to
17054 tell the server what these constraints are.  Thus, as a server operator, you
17055 need to make an educated guess as to what is most likely to work for your
17056 userbase.
17057
17058 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17059 is most likely to maximise interoperability.  The upper bound comes from
17060 applications using the Mozilla Network Security Services (NSS) library, which
17061 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17062 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17063 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17064 acceptable bound from 1024 to 2048.
17065
17066
17067 .option tls_eccurve main string&!! prime256v1
17068 .cindex TLS "EC cryptography"
17069 If built with a recent-enough version of OpenSSL,
17070 this option selects a EC curve for use by Exim.
17071
17072 Curve names of the form &'prime256v1'& are accepted.
17073 For even more-recent library versions, names of the form &'P-512'&
17074 are also accepted, plus the special value &'auto'&
17075 which tells the library to choose.
17076
17077 If the option is set to an empty string, no EC curves will be enabled.
17078
17079
17080 .option tls_ocsp_file main string&!! unset
17081 .cindex TLS "certificate status"
17082 .cindex TLS "OCSP proof file"
17083 This option
17084 must if set expand to the absolute path to a file which contains a current
17085 status proof for the server's certificate, as obtained from the
17086 Certificate Authority.
17087
17088 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17089
17090
17091 .option tls_on_connect_ports main "string list" unset
17092 .cindex SSMTP
17093 .cindex SMTPS
17094 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17095 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17096 set up without waiting for the client to issue a STARTTLS command. For
17097 further details, see section &<<SECTsupobssmt>>&.
17098
17099
17100
17101 .option tls_privatekey main string&!! unset
17102 .cindex "TLS" "server private key; location of"
17103 The value of this option is expanded, and must then be the absolute path to a
17104 file which contains the server's private key. If this option is unset, or if
17105 the expansion is forced to fail, or the result is an empty string, the private
17106 key is assumed to be in the same file as the server's certificates. See chapter
17107 &<<CHAPTLS>>& for further details.
17108
17109 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17110
17111
17112 .option tls_remember_esmtp main boolean false
17113 .cindex "TLS" "esmtp state; remembering"
17114 .cindex "TLS" "broken clients"
17115 If this option is set true, Exim violates the RFCs by remembering that it is in
17116 &"esmtp"& state after successfully negotiating a TLS session. This provides
17117 support for broken clients that fail to send a new EHLO after starting a
17118 TLS session.
17119
17120
17121 .option tls_require_ciphers main string&!! unset
17122 .cindex "TLS" "requiring specific ciphers"
17123 .cindex "cipher" "requiring specific"
17124 This option controls which ciphers can be used for incoming TLS connections.
17125 The &(smtp)& transport has an option of the same name for controlling outgoing
17126 connections. This option is expanded for each connection, so can be varied for
17127 different clients if required. The value of this option must be a list of
17128 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17129 in somewhat different ways. If GnuTLS is being used, the client controls the
17130 preference order of the available ciphers. Details are given in sections
17131 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17132
17133
17134 .option tls_try_verify_hosts main "host list&!!" unset
17135 .cindex "TLS" "client certificate verification"
17136 .cindex "certificate" "verification of client"
17137 See &%tls_verify_hosts%& below.
17138
17139
17140 .option tls_verify_certificates main string&!! system
17141 .cindex "TLS" "client certificate verification"
17142 .cindex "certificate" "verification of client"
17143 The value of this option is expanded, and must then be either the
17144 word "system"
17145 or the absolute path to
17146 a file or directory containing permitted certificates for clients that
17147 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17148
17149 The "system" value for the option will use a
17150 system default location compiled into the SSL library.
17151 This is not available for GnuTLS versions preceding 3.0.20,
17152 and will be taken as empty; an explicit location
17153 must be specified.
17154
17155 The use of a directory for the option value is not available for GnuTLS versions
17156 preceding 3.3.6 and a single file must be used.
17157
17158 With OpenSSL the certificates specified
17159 explicitly
17160 either by file or directory
17161 are added to those given by the system default location.
17162
17163 These certificates should be for the certificate authorities trusted, rather
17164 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17165 the value is a file then the certificates are sent by Exim as a server to
17166 connecting clients, defining the list of accepted certificate authorities.
17167 Thus the values defined should be considered public data.  To avoid this,
17168 use the explicit directory version.
17169
17170 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17171
17172 A forced expansion failure or setting to an empty string is equivalent to
17173 being unset.
17174
17175
17176 .option tls_verify_hosts main "host list&!!" unset
17177 .cindex "TLS" "client certificate verification"
17178 .cindex "certificate" "verification of client"
17179 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17180 certificates from clients. The expected certificates are defined by
17181 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17182 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17183 &%tls_verify_certificates%& is not set.
17184
17185 Any client that matches &%tls_verify_hosts%& is constrained by
17186 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17187 present one of the listed certificates. If it does not, the connection is
17188 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17189 the host to use TLS. It can still send SMTP commands through unencrypted
17190 connections. Forcing a client to use TLS has to be done separately using an
17191 ACL to reject inappropriate commands when the connection is not encrypted.
17192
17193 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17194 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17195 certificate and checks it against &%tls_verify_certificates%&, but does not
17196 abort the connection if there is no certificate or if it does not match. This
17197 state can be detected in an ACL, which makes it possible to implement policies
17198 such as &"accept for relay only if a verified certificate has been received,
17199 but accept for local delivery if encrypted, even without a verified
17200 certificate"&.
17201
17202 Client hosts that match neither of these lists are not asked to present
17203 certificates.
17204
17205
17206 .option trusted_groups main "string list&!!" unset
17207 .cindex "trusted groups"
17208 .cindex "groups" "trusted"
17209 This option is expanded just once, at the start of Exim's processing. If this
17210 option is set, any process that is running in one of the listed groups, or
17211 which has one of them as a supplementary group, is trusted. The groups can be
17212 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17213 details of what trusted callers are permitted to do. If neither
17214 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17215 are trusted.
17216
17217 .option trusted_users main "string list&!!" unset
17218 .cindex "trusted users"
17219 .cindex "user" "trusted"
17220 This option is expanded just once, at the start of Exim's processing. If this
17221 option is set, any process that is running as one of the listed users is
17222 trusted. The users can be specified numerically or by name. See section
17223 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17224 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17225 Exim user are trusted.
17226
17227 .option unknown_login main string&!! unset
17228 .cindex "uid (user id)" "unknown caller"
17229 .vindex "&$caller_uid$&"
17230 This is a specialized feature for use in unusual configurations. By default, if
17231 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17232 gives up. The &%unknown_login%& option can be used to set a login name to be
17233 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17234 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17235 is used for the user's real name (gecos field), unless this has been set by the
17236 &%-F%& option.
17237
17238 .option unknown_username main string unset
17239 See &%unknown_login%&.
17240
17241 .option untrusted_set_sender main "address list&!!" unset
17242 .cindex "trusted users"
17243 .cindex "sender" "setting by untrusted user"
17244 .cindex "untrusted user setting sender"
17245 .cindex "user" "untrusted setting sender"
17246 .cindex "envelope sender"
17247 When an untrusted user submits a message to Exim using the standard input, Exim
17248 normally creates an envelope sender address from the user's login and the
17249 default qualification domain. Data from the &%-f%& option (for setting envelope
17250 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17251 is used) is ignored.
17252
17253 However, untrusted users are permitted to set an empty envelope sender address,
17254 to declare that a message should never generate any bounces. For example:
17255 .code
17256 exim -f '<>' user@domain.example
17257 .endd
17258 .vindex "&$sender_ident$&"
17259 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17260 other envelope sender addresses in a controlled way. When it is set, untrusted
17261 users are allowed to set envelope sender addresses that match any of the
17262 patterns in the list. Like all address lists, the string is expanded. The
17263 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17264 users to setting senders that start with their login ids
17265 followed by a hyphen
17266 by a setting like this:
17267 .code
17268 untrusted_set_sender = ^$sender_ident-
17269 .endd
17270 If you want to allow untrusted users to set envelope sender addresses without
17271 restriction, you can use
17272 .code
17273 untrusted_set_sender = *
17274 .endd
17275 The &%untrusted_set_sender%& option applies to all forms of local input, but
17276 only to the setting of the envelope sender. It does not permit untrusted users
17277 to use the other options which trusted user can use to override message
17278 parameters. Furthermore, it does not stop Exim from removing an existing
17279 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17280 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17281 overriding these actions. The handling of the &'Sender:'& header is also
17282 described in section &<<SECTthesenhea>>&.
17283
17284 The log line for a message's arrival shows the envelope sender following
17285 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17286 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17287 envelope sender address, the user's login is shown in parentheses after the
17288 sender address.
17289
17290
17291 .option uucp_from_pattern main string "see below"
17292 .cindex "&""From""& line"
17293 .cindex "UUCP" "&""From""& line"
17294 Some applications that pass messages to an MTA via a command line interface use
17295 an initial line starting with &"From&~"& to pass the envelope sender. In
17296 particular, this is used by UUCP software. Exim recognizes such a line by means
17297 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17298 matches, the sender address is constructed by expanding the contents of
17299 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17300 default pattern recognizes lines in the following two forms:
17301 .code
17302 From ph10 Fri Jan  5 12:35 GMT 1996
17303 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17304 .endd
17305 The pattern can be seen by running
17306 .code
17307 exim -bP uucp_from_pattern
17308 .endd
17309 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17310 year in the second case. The first word after &"From&~"& is matched in the
17311 regular expression by a parenthesized subpattern. The default value for
17312 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17313 (&"ph10"& in the example above) as the message's sender. See also
17314 &%ignore_fromline_hosts%&.
17315
17316
17317 .option uucp_from_sender main string&!! &`$1`&
17318 See &%uucp_from_pattern%& above.
17319
17320
17321 .option warn_message_file main string unset
17322 .cindex "warning of delay" "customizing the message"
17323 .cindex "customizing" "warning message"
17324 This option defines a template file containing paragraphs of text to be used
17325 for constructing the warning message which is sent by Exim when a message has
17326 been on the queue for a specified amount of time, as specified by
17327 &%delay_warning%&. Details of the file's contents are given in chapter
17328 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17329
17330
17331 .option write_rejectlog main boolean true
17332 .cindex "reject log" "disabling"
17333 If this option is set false, Exim no longer writes anything to the reject log.
17334 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17335 .ecindex IIDconfima
17336 .ecindex IIDmaiconf
17337
17338
17339
17340
17341 . ////////////////////////////////////////////////////////////////////////////
17342 . ////////////////////////////////////////////////////////////////////////////
17343
17344 .chapter "Generic options for routers" "CHAProutergeneric"
17345 .scindex IIDgenoprou1 "options" "generic; for routers"
17346 .scindex IIDgenoprou2 "generic options" "router"
17347 This chapter describes the generic options that apply to all routers.
17348 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17349
17350 For a general description of how a router operates, see sections
17351 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17352 which the preconditions are tested. The order of expansion of the options that
17353 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17354 &%headers_remove%&, &%transport%&.
17355
17356
17357
17358 .option address_data routers string&!! unset
17359 .cindex "router" "data attached to address"
17360 The string is expanded just before the router is run, that is, after all the
17361 precondition tests have succeeded. If the expansion is forced to fail, the
17362 router declines, the value of &%address_data%& remains unchanged, and the
17363 &%more%& option controls what happens next. Other expansion failures cause
17364 delivery of the address to be deferred.
17365
17366 .vindex "&$address_data$&"
17367 When the expansion succeeds, the value is retained with the address, and can be
17368 accessed using the variable &$address_data$& in the current router, subsequent
17369 routers, and the eventual transport.
17370
17371 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17372 that runs a user's filter file, the contents of &$address_data$& are accessible
17373 in the filter. This is not normally a problem, because such data is usually
17374 either not confidential or it &"belongs"& to the current user, but if you do
17375 put confidential data into &$address_data$& you need to remember this point.
17376
17377 Even if the router declines or passes, the value of &$address_data$& remains
17378 with the address, though it can be changed by another &%address_data%& setting
17379 on a subsequent router. If a router generates child addresses, the value of
17380 &$address_data$& propagates to them. This also applies to the special kind of
17381 &"child"& that is generated by a router with the &%unseen%& option.
17382
17383 The idea of &%address_data%& is that you can use it to look up a lot of data
17384 for the address once, and then pick out parts of the data later. For example,
17385 you could use a single LDAP lookup to return a string of the form
17386 .code
17387 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17388 .endd
17389 In the transport you could pick out the mailbox by a setting such as
17390 .code
17391 file = ${extract{mailbox}{$address_data}}
17392 .endd
17393 This makes the configuration file less messy, and also reduces the number of
17394 lookups (though Exim does cache lookups).
17395
17396 .vindex "&$sender_address_data$&"
17397 .vindex "&$address_data$&"
17398 The &%address_data%& facility is also useful as a means of passing information
17399 from one router to another, and from a router to a transport. In addition, if
17400 &$address_data$& is set by a router when verifying a recipient address from an
17401 ACL, it remains available for use in the rest of the ACL statement. After
17402 verifying a sender, the value is transferred to &$sender_address_data$&.
17403
17404
17405
17406 .option address_test routers&!? boolean true
17407 .oindex "&%-bt%&"
17408 .cindex "router" "skipping when address testing"
17409 If this option is set false, the router is skipped when routing is being tested
17410 by means of the &%-bt%& command line option. This can be a convenience when
17411 your first router sends messages to an external scanner, because it saves you
17412 having to set the &"already scanned"& indicator when testing real address
17413 routing.
17414
17415
17416
17417 .option cannot_route_message routers string&!! unset
17418 .cindex "router" "customizing &""cannot route""& message"
17419 .cindex "customizing" "&""cannot route""& message"
17420 This option specifies a text message that is used when an address cannot be
17421 routed because Exim has run out of routers. The default message is
17422 &"Unrouteable address"&. This option is useful only on routers that have
17423 &%more%& set false, or on the very last router in a configuration, because the
17424 value that is used is taken from the last router that is considered. This
17425 includes a router that is skipped because its preconditions are not met, as
17426 well as a router that declines. For example, using the default configuration,
17427 you could put:
17428 .code
17429 cannot_route_message = Remote domain not found in DNS
17430 .endd
17431 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17432 and
17433 .code
17434 cannot_route_message = Unknown local user
17435 .endd
17436 on the final router that checks for local users. If string expansion fails for
17437 this option, the default message is used. Unless the expansion failure was
17438 explicitly forced, a message about the failure is written to the main and panic
17439 logs, in addition to the normal message about the routing failure.
17440
17441
17442 .option caseful_local_part routers boolean false
17443 .cindex "case of local parts"
17444 .cindex "router" "case of local parts"
17445 By default, routers handle the local parts of addresses in a case-insensitive
17446 manner, though the actual case is preserved for transmission with the message.
17447 If you want the case of letters to be significant in a router, you must set
17448 this option true. For individual router options that contain address or local
17449 part lists (for example, &%local_parts%&), case-sensitive matching can be
17450 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17451 more details.
17452
17453 .vindex "&$local_part$&"
17454 .vindex "&$original_local_part$&"
17455 .vindex "&$parent_local_part$&"
17456 The value of the &$local_part$& variable is forced to lower case while a
17457 router is running unless &%caseful_local_part%& is set. When a router assigns
17458 an address to a transport, the value of &$local_part$& when the transport runs
17459 is the same as it was in the router. Similarly, when a router generates child
17460 addresses by aliasing or forwarding, the values of &$original_local_part$&
17461 and &$parent_local_part$& are those that were used by the redirecting router.
17462
17463 This option applies to the processing of an address by a router. When a
17464 recipient address is being processed in an ACL, there is a separate &%control%&
17465 modifier that can be used to specify case-sensitive processing within the ACL
17466 (see section &<<SECTcontrols>>&).
17467
17468
17469
17470 .option check_local_user routers&!? boolean false
17471 .cindex "local user, checking in router"
17472 .cindex "router" "checking for local user"
17473 .cindex "&_/etc/passwd_&"
17474 .vindex "&$home$&"
17475 When this option is true, Exim checks that the local part of the recipient
17476 address (with affixes removed if relevant) is the name of an account on the
17477 local system. The check is done by calling the &[getpwnam()]& function rather
17478 than trying to read &_/etc/passwd_& directly. This means that other methods of
17479 holding password data (such as NIS) are supported. If the local part is a local
17480 user, &$home$& is set from the password data, and can be tested in other
17481 preconditions that are evaluated after this one (the order of evaluation is
17482 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17483 overridden by &%router_home_directory%&. If the local part is not a local user,
17484 the router is skipped.
17485
17486 If you want to check that the local part is either the name of a local user
17487 or matches something else, you cannot combine &%check_local_user%& with a
17488 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17489 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17490 setting to achieve this. For example:
17491 .code
17492 local_parts = passwd;$local_part : lsearch;/etc/other/users
17493 .endd
17494 Note, however, that the side effects of &%check_local_user%& (such as setting
17495 up a home directory) do not occur when a &(passwd)& lookup is used in a
17496 &%local_parts%& (or any other) precondition.
17497
17498
17499
17500 .option condition routers&!? string&!! unset
17501 .cindex "router" "customized precondition"
17502 This option specifies a general precondition test that has to succeed for the
17503 router to be called. The &%condition%& option is the last precondition to be
17504 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17505 result is a forced failure, or an empty string, or one of the strings &"0"& or
17506 &"no"& or &"false"& (checked without regard to the case of the letters), the
17507 router is skipped, and the address is offered to the next one.
17508
17509 If the result is any other value, the router is run (as this is the last
17510 precondition to be evaluated, all the other preconditions must be true).
17511
17512 This option is unusual in that multiple &%condition%& options may be present.
17513 All &%condition%& options must succeed.
17514
17515 The &%condition%& option provides a means of applying custom conditions to the
17516 running of routers. Note that in the case of a simple conditional expansion,
17517 the default expansion values are exactly what is wanted. For example:
17518 .code
17519 condition = ${if >{$message_age}{600}}
17520 .endd
17521 Because of the default behaviour of the string expansion, this is equivalent to
17522 .code
17523 condition = ${if >{$message_age}{600}{true}{}}
17524 .endd
17525
17526 A multiple condition example, which succeeds:
17527 .code
17528 condition = ${if >{$message_age}{600}}
17529 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17530 condition = foobar
17531 .endd
17532
17533 If the expansion fails (other than forced failure) delivery is deferred. Some
17534 of the other precondition options are common special cases that could in fact
17535 be specified using &%condition%&.
17536
17537 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17538 are far older, and use one set of semantics.  ACLs are newer and when
17539 they were created, the ACL &%condition%& process was given far stricter
17540 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17541 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17542 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17543 Router rules processing behavior.
17544
17545 This is best illustrated in an example:
17546 .code
17547 # If used in an ACL condition will fail with a syntax error, but
17548 # in a router condition any extra characters are treated as a string
17549
17550 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17551 true {yes} {no}}
17552
17553 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17554  {yes} {no}}
17555 .endd
17556 In each example above, the &%if%& statement actually ends after
17557 &"{google.com}}"&.  Since no true or false braces were defined, the
17558 default &%if%& behavior is to return a boolean true or a null answer
17559 (which evaluates to false). The rest of the line is then treated as a
17560 string. So the first example resulted in the boolean answer &"true"&
17561 with the string &" {yes} {no}}"& appended to it. The second example
17562 resulted in the null output (indicating false) with the string
17563 &" {yes} {no}}"& appended to it.
17564
17565 In fact you can put excess forward braces in too.  In the router
17566 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17567 mean something, like after a &"$"& or when required as part of a
17568 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17569 string characters.
17570
17571 Thus, in a Router, the above expansion strings will both always evaluate
17572 true, as the result of expansion is a non-empty string which doesn't
17573 match an explicit false value.  This can be tricky to debug.  By
17574 contrast, in an ACL either of those strings will always result in an
17575 expansion error because the result doesn't look sufficiently boolean.
17576
17577
17578 .option debug_print routers string&!! unset
17579 .cindex "testing" "variables in drivers"
17580 If this option is set and debugging is enabled (see the &%-d%& command line
17581 option) or in address-testing mode (see the &%-bt%& command line option),
17582 the string is expanded and included in the debugging output.
17583 If expansion of the string fails, the error message is written to the debugging
17584 output, and Exim carries on processing.
17585 This option is provided to help with checking out the values of variables and
17586 so on when debugging router configurations. For example, if a &%condition%&
17587 option appears not to be working, &%debug_print%& can be used to output the
17588 variables it references. The output happens after checks for &%domains%&,
17589 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17590 are tested. A newline is added to the text if it does not end with one.
17591 The variable &$router_name$& contains the name of the router.
17592
17593
17594
17595 .option disable_logging routers boolean false
17596 If this option is set true, nothing is logged for any routing errors
17597 or for any deliveries caused by this router. You should not set this option
17598 unless you really, really know what you are doing. See also the generic
17599 transport option of the same name.
17600
17601 .option dnssec_request_domains routers "domain list&!!" unset
17602 .cindex "MX record" "security"
17603 .cindex "DNSSEC" "MX lookup"
17604 .cindex "security" "MX lookup"
17605 .cindex "DNS" "DNSSEC"
17606 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17607 the dnssec request bit set.
17608 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17609
17610 .option dnssec_require_domains routers "domain list&!!" unset
17611 .cindex "MX record" "security"
17612 .cindex "DNSSEC" "MX lookup"
17613 .cindex "security" "MX lookup"
17614 .cindex "DNS" "DNSSEC"
17615 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17616 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17617 (AD bit) set will be ignored and logged as a host-lookup failure.
17618 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17619
17620
17621 .option domains routers&!? "domain list&!!" unset
17622 .cindex "router" "restricting to specific domains"
17623 .vindex "&$domain_data$&"
17624 If this option is set, the router is skipped unless the current domain matches
17625 the list. If the match is achieved by means of a file lookup, the data that the
17626 lookup returned for the domain is placed in &$domain_data$& for use in string
17627 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17628 a list of the order in which preconditions are evaluated.
17629
17630
17631
17632 .option driver routers string unset
17633 This option must always be set. It specifies which of the available routers is
17634 to be used.
17635
17636
17637 .option dsn_lasthop routers boolean false
17638 .cindex "DSN" "success"
17639 .cindex "Delivery Status Notification" "success"
17640 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17641 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17642 instead send a success DSN as if the next hop does not support DSN.
17643 Not effective on redirect routers.
17644
17645
17646
17647 .option errors_to routers string&!! unset
17648 .cindex "envelope sender"
17649 .cindex "router" "changing address for errors"
17650 If a router successfully handles an address, it may assign the address to a
17651 transport for delivery or it may generate child addresses. In both cases, if
17652 there is a delivery problem during later processing, the resulting bounce
17653 message is sent to the address that results from expanding this string,
17654 provided that the address verifies successfully. The &%errors_to%& option is
17655 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17656
17657 The &%errors_to%& setting associated with an address can be overridden if it
17658 subsequently passes through other routers that have their own &%errors_to%&
17659 settings, or if the message is delivered by a transport with a &%return_path%&
17660 setting.
17661
17662 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17663 the expansion fails to verify, the errors address associated with the incoming
17664 address is used. At top level, this is the envelope sender. A non-forced
17665 expansion failure causes delivery to be deferred.
17666
17667 If an address for which &%errors_to%& has been set ends up being delivered over
17668 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17669 any bounces that are generated by other MTAs on the delivery route are also
17670 sent there. You can set &%errors_to%& to the empty string by either of these
17671 settings:
17672 .code
17673 errors_to =
17674 errors_to = ""
17675 .endd
17676 An expansion item that yields an empty string has the same effect. If you do
17677 this, a locally detected delivery error for addresses processed by this router
17678 no longer gives rise to a bounce message; the error is discarded. If the
17679 address is delivered to a remote host, the return path is set to &`<>`&, unless
17680 overridden by the &%return_path%& option on the transport.
17681
17682 .vindex "&$address_data$&"
17683 If for some reason you want to discard local errors, but use a non-empty
17684 MAIL command for remote delivery, you can preserve the original return
17685 path in &$address_data$& in the router, and reinstate it in the transport by
17686 setting &%return_path%&.
17687
17688 The most common use of &%errors_to%& is to direct mailing list bounces to the
17689 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17690 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17691
17692
17693
17694 .option expn routers&!? boolean true
17695 .cindex "address" "testing"
17696 .cindex "testing" "addresses"
17697 .cindex "EXPN" "router skipping"
17698 .cindex "router" "skipping for EXPN"
17699 If this option is turned off, the router is skipped when testing an address
17700 as a result of processing an SMTP EXPN command. You might, for example,
17701 want to turn it off on a router for users' &_.forward_& files, while leaving it
17702 on for the system alias file.
17703 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17704 are evaluated.
17705
17706 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17707 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17708 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17709
17710
17711
17712 .option fail_verify routers boolean false
17713 .cindex "router" "forcing verification failure"
17714 Setting this option has the effect of setting both &%fail_verify_sender%& and
17715 &%fail_verify_recipient%& to the same value.
17716
17717
17718
17719 .option fail_verify_recipient routers boolean false
17720 If this option is true and an address is accepted by this router when
17721 verifying a recipient, verification fails.
17722
17723
17724
17725 .option fail_verify_sender routers boolean false
17726 If this option is true and an address is accepted by this router when
17727 verifying a sender, verification fails.
17728
17729
17730
17731 .option fallback_hosts routers "string list" unset
17732 .cindex "router" "fallback hosts"
17733 .cindex "fallback" "hosts specified on router"
17734 String expansion is not applied to this option. The argument must be a
17735 colon-separated list of host names or IP addresses. The list separator can be
17736 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17737 each name or address. In fact, the format of each item is exactly the same as
17738 defined for the list of hosts in a &(manualroute)& router (see section
17739 &<<SECTformatonehostitem>>&).
17740
17741 If a router queues an address for a remote transport, this host list is
17742 associated with the address, and used instead of the transport's fallback host
17743 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17744 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17745 transport for further details.
17746
17747
17748 .option group routers string&!! "see below"
17749 .cindex "gid (group id)" "local delivery"
17750 .cindex "local transports" "uid and gid"
17751 .cindex "transport" "local"
17752 .cindex "router" "setting group"
17753 When a router queues an address for a transport, and the transport does not
17754 specify a group, the group given here is used when running the delivery
17755 process.
17756 The group may be specified numerically or by name. If expansion fails, the
17757 error is logged and delivery is deferred.
17758 The default is unset, unless &%check_local_user%& is set, when the default
17759 is taken from the password information. See also &%initgroups%& and &%user%&
17760 and the discussion in chapter &<<CHAPenvironment>>&.
17761
17762
17763
17764 .option headers_add routers list&!! unset
17765 .cindex "header lines" "adding"
17766 .cindex "router" "adding header lines"
17767 This option specifies a list of text headers,
17768 newline-separated (by default, changeable in the usual way),
17769 that is associated with any addresses that are accepted by the router.
17770 Each item is separately expanded, at routing time.  However, this
17771 option has no effect when an address is just being verified. The way in which
17772 the text is used to add header lines at transport time is described in section
17773 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17774 message is in the process of being transported. This means that references to
17775 header lines in string expansions in the transport's configuration do not
17776 &"see"& the added header lines.
17777
17778 The &%headers_add%& option is expanded after &%errors_to%&, but before
17779 &%headers_remove%& and &%transport%&. If an item is empty, or if
17780 an item expansion is forced to fail, the item has no effect. Other expansion
17781 failures are treated as configuration errors.
17782
17783 Unlike most options, &%headers_add%& can be specified multiple times
17784 for a router; all listed headers are added.
17785
17786 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17787 router that has the &%one_time%& option set.
17788
17789 .cindex "duplicate addresses"
17790 .oindex "&%unseen%&"
17791 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17792 additions are deleted when the address is passed on to subsequent routers.
17793 For a &%redirect%& router, if a generated address is the same as the incoming
17794 address, this can lead to duplicate addresses with different header
17795 modifications. Exim does not do duplicate deliveries (except, in certain
17796 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17797 which of the duplicates is discarded, so this ambiguous situation should be
17798 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17799
17800
17801
17802 .option headers_remove routers list&!! unset
17803 .cindex "header lines" "removing"
17804 .cindex "router" "removing header lines"
17805 This option specifies a list of text headers,
17806 colon-separated (by default, changeable in the usual way),
17807 that is associated with any addresses that are accepted by the router.
17808 Each item is separately expanded, at routing time.  However, this
17809 option has no effect when an address is just being verified. The way in which
17810 the text is used to remove header lines at transport time is described in
17811 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17812 the message is in the process of being transported. This means that references
17813 to header lines in string expansions in the transport's configuration still
17814 &"see"& the original header lines.
17815
17816 The &%headers_remove%& option is expanded after &%errors_to%& and
17817 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17818 the item has no effect. Other expansion failures are treated as configuration
17819 errors.
17820
17821 Unlike most options, &%headers_remove%& can be specified multiple times
17822 for a router; all listed headers are removed.
17823
17824 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17825 router that has the &%one_time%& option set.
17826
17827 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17828 removal requests are deleted when the address is passed on to subsequent
17829 routers, and this can lead to problems with duplicates -- see the similar
17830 warning for &%headers_add%& above.
17831
17832 &*Warning 3*&: Because of the separate expansion of the list items,
17833 items that contain a list separator must have it doubled.
17834 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17835
17836
17837
17838 .option ignore_target_hosts routers "host list&!!" unset
17839 .cindex "IP address" "discarding"
17840 .cindex "router" "discarding IP addresses"
17841 Although this option is a host list, it should normally contain IP address
17842 entries rather than names. If any host that is looked up by the router has an
17843 IP address that matches an item in this list, Exim behaves as if that IP
17844 address did not exist. This option allows you to cope with rogue DNS entries
17845 like
17846 .code
17847 remote.domain.example.  A  127.0.0.1
17848 .endd
17849 by setting
17850 .code
17851 ignore_target_hosts = 127.0.0.1
17852 .endd
17853 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17854 discarded in this way, the router declines. In a conventional configuration, an
17855 attempt to mail to such a domain would normally provoke the &"unrouteable
17856 domain"& error, and an attempt to verify an address in the domain would fail.
17857 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17858 router declines if presented with one of the listed addresses.
17859
17860 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17861 means of the first or the second of the following settings, respectively:
17862 .code
17863 ignore_target_hosts = 0.0.0.0/0
17864 ignore_target_hosts = <; 0::0/0
17865 .endd
17866 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17867 in the second line matches all IPv6 addresses.
17868
17869 This option may also be useful for ignoring link-local and site-local IPv6
17870 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17871 is expanded before use as a list, it is possible to make it dependent on the
17872 domain that is being routed.
17873
17874 .vindex "&$host_address$&"
17875 During its expansion, &$host_address$& is set to the IP address that is being
17876 checked.
17877
17878 .option initgroups routers boolean false
17879 .cindex "additional groups"
17880 .cindex "groups" "additional"
17881 .cindex "local transports" "uid and gid"
17882 .cindex "transport" "local"
17883 If the router queues an address for a transport, and this option is true, and
17884 the uid supplied by the router is not overridden by the transport, the
17885 &[initgroups()]& function is called when running the transport to ensure that
17886 any additional groups associated with the uid are set up. See also &%group%&
17887 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17888
17889
17890
17891 .option local_part_prefix routers&!? "string list" unset
17892 .cindex "router" "prefix for local part"
17893 .cindex "prefix" "for local part, used in router"
17894 If this option is set, the router is skipped unless the local part starts with
17895 one of the given strings, or &%local_part_prefix_optional%& is true. See
17896 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17897 evaluated.
17898
17899 The list is scanned from left to right, and the first prefix that matches is
17900 used. A limited form of wildcard is available; if the prefix begins with an
17901 asterisk, it matches the longest possible sequence of arbitrary characters at
17902 the start of the local part. An asterisk should therefore always be followed by
17903 some character that does not occur in normal local parts.
17904 .cindex "multiple mailboxes"
17905 .cindex "mailbox" "multiple"
17906 Wildcarding can be used to set up multiple user mailboxes, as described in
17907 section &<<SECTmulbox>>&.
17908
17909 .vindex "&$local_part$&"
17910 .vindex "&$local_part_prefix$&"
17911 During the testing of the &%local_parts%& option, and while the router is
17912 running, the prefix is removed from the local part, and is available in the
17913 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17914 the router accepts the address, this remains true during subsequent delivery by
17915 a transport. In particular, the local part that is transmitted in the RCPT
17916 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17917 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17918 the relevant transport.
17919
17920 When an address is being verified, &%local_part_prefix%& affects only the
17921 behaviour of the router. If the callout feature of verification is in use, this
17922 means that the full address, including the prefix, will be used during the
17923 callout.
17924
17925 The prefix facility is commonly used to handle local parts of the form
17926 &%owner-something%&. Another common use is to support local parts of the form
17927 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17928 to tell a user their forwarding is broken &-- by placing a router like this one
17929 immediately before the router that handles &_.forward_& files:
17930 .code
17931 real_localuser:
17932   driver = accept
17933   local_part_prefix = real-
17934   check_local_user
17935   transport = local_delivery
17936 .endd
17937 For security, it would probably be a good idea to restrict the use of this
17938 router to locally-generated messages, using a condition such as this:
17939 .code
17940   condition = ${if match {$sender_host_address}\
17941                          {\N^(|127\.0\.0\.1)$\N}}
17942 .endd
17943
17944 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17945 both conditions must be met if not optional. Care must be taken if wildcards
17946 are used in both a prefix and a suffix on the same router. Different
17947 separator characters must be used to avoid ambiguity.
17948
17949
17950 .option local_part_prefix_optional routers boolean false
17951 See &%local_part_prefix%& above.
17952
17953
17954
17955 .option local_part_suffix routers&!? "string list" unset
17956 .cindex "router" "suffix for local part"
17957 .cindex "suffix for local part" "used in router"
17958 This option operates in the same way as &%local_part_prefix%&, except that the
17959 local part must end (rather than start) with the given string, the
17960 &%local_part_suffix_optional%& option determines whether the suffix is
17961 mandatory, and the wildcard * character, if present, must be the last
17962 character of the suffix. This option facility is commonly used to handle local
17963 parts of the form &%something-request%& and multiple user mailboxes of the form
17964 &%username-foo%&.
17965
17966
17967 .option local_part_suffix_optional routers boolean false
17968 See &%local_part_suffix%& above.
17969
17970
17971
17972 .option local_parts routers&!? "local part list&!!" unset
17973 .cindex "router" "restricting to specific local parts"
17974 .cindex "local part" "checking in router"
17975 The router is run only if the local part of the address matches the list.
17976 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17977 are evaluated, and
17978 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17979 string is expanded, it is possible to make it depend on the domain, for
17980 example:
17981 .code
17982 local_parts = dbm;/usr/local/specials/$domain
17983 .endd
17984 .vindex "&$local_part_data$&"
17985 If the match is achieved by a lookup, the data that the lookup returned
17986 for the local part is placed in the variable &$local_part_data$& for use in
17987 expansions of the router's private options. You might use this option, for
17988 example, if you have a large number of local virtual domains, and you want to
17989 send all postmaster mail to the same place without having to set up an alias in
17990 each virtual domain:
17991 .code
17992 postmaster:
17993   driver = redirect
17994   local_parts = postmaster
17995   data = postmaster@real.domain.example
17996 .endd
17997
17998
17999 .option log_as_local routers boolean "see below"
18000 .cindex "log" "delivery line"
18001 .cindex "delivery" "log line format"
18002 Exim has two logging styles for delivery, the idea being to make local
18003 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18004 recipient address is given just as the local part, without a domain. The use of
18005 this style is controlled by this option. It defaults to true for the &(accept)&
18006 router, and false for all the others. This option applies only when a
18007 router assigns an address to a transport. It has no effect on routers that
18008 redirect addresses.
18009
18010
18011
18012 .option more routers boolean&!! true
18013 The result of string expansion for this option must be a valid boolean value,
18014 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18015 result causes an error, and delivery is deferred. If the expansion is forced to
18016 fail, the default value for the option (true) is used. Other failures cause
18017 delivery to be deferred.
18018
18019 If this option is set false, and the router declines to handle the address, no
18020 further routers are tried, routing fails, and the address is bounced.
18021 .oindex "&%self%&"
18022 However, if the router explicitly passes an address to the following router by
18023 means of the setting
18024 .code
18025 self = pass
18026 .endd
18027 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18028 does not affect the behaviour if one of the precondition tests fails. In that
18029 case, the address is always passed to the next router.
18030
18031 Note that &%address_data%& is not considered to be a precondition. If its
18032 expansion is forced to fail, the router declines, and the value of &%more%&
18033 controls what happens next.
18034
18035
18036 .option pass_on_timeout routers boolean false
18037 .cindex "timeout" "of router"
18038 .cindex "router" "timeout"
18039 If a router times out during a host lookup, it normally causes deferral of the
18040 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18041 router, overriding &%no_more%&. This may be helpful for systems that are
18042 intermittently connected to the Internet, or those that want to pass to a smart
18043 host any messages that cannot immediately be delivered.
18044
18045 There are occasional other temporary errors that can occur while doing DNS
18046 lookups. They are treated in the same way as a timeout, and this option
18047 applies to all of them.
18048
18049
18050
18051 .option pass_router routers string unset
18052 .cindex "router" "go to after &""pass""&"
18053 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18054 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18055 routing to continue, and overriding a false setting of &%more%&. When one of
18056 these routers returns &"pass"&, the address is normally handed on to the next
18057 router in sequence. This can be changed by setting &%pass_router%& to the name
18058 of another router. However (unlike &%redirect_router%&) the named router must
18059 be below the current router, to avoid loops. Note that this option applies only
18060 to the special case of &"pass"&. It does not apply when a router returns
18061 &"decline"& because it cannot handle an address.
18062
18063
18064
18065 .option redirect_router routers string unset
18066 .cindex "router" "start at after redirection"
18067 Sometimes an administrator knows that it is pointless to reprocess addresses
18068 generated from alias or forward files with the same router again. For
18069 example, if an alias file translates real names into login ids there is no
18070 point searching the alias file a second time, especially if it is a large file.
18071
18072 The &%redirect_router%& option can be set to the name of any router instance.
18073 It causes the routing of any generated addresses to start at the named router
18074 instead of at the first router. This option has no effect if the router in
18075 which it is set does not generate new addresses.
18076
18077
18078
18079 .option require_files routers&!? "string list&!!" unset
18080 .cindex "file" "requiring for router"
18081 .cindex "router" "requiring file existence"
18082 This option provides a general mechanism for predicating the running of a
18083 router on the existence or non-existence of certain files or directories.
18084 Before running a router, as one of its precondition tests, Exim works its way
18085 through the &%require_files%& list, expanding each item separately.
18086
18087 Because the list is split before expansion, any colons in expansion items must
18088 be doubled, or the facility for using a different list separator must be used.
18089 If any expansion is forced to fail, the item is ignored. Other expansion
18090 failures cause routing of the address to be deferred.
18091
18092 If any expanded string is empty, it is ignored. Otherwise, except as described
18093 below, each string must be a fully qualified file path, optionally preceded by
18094 &"!"&. The paths are passed to the &[stat()]& function to test for the
18095 existence of the files or directories. The router is skipped if any paths not
18096 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18097
18098 .cindex "NFS"
18099 If &[stat()]& cannot determine whether a file exists or not, delivery of
18100 the message is deferred. This can happen when NFS-mounted filesystems are
18101 unavailable.
18102
18103 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18104 options, so you cannot use it to check for the existence of a file in which to
18105 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18106 full list of the order in which preconditions are evaluated.) However, as
18107 these options are all expanded, you can use the &%exists%& expansion condition
18108 to make such tests. The &%require_files%& option is intended for checking files
18109 that the router may be going to use internally, or which are needed by a
18110 transport (for example &_.procmailrc_&).
18111
18112 During delivery, the &[stat()]& function is run as root, but there is a
18113 facility for some checking of the accessibility of a file by another user.
18114 This is not a proper permissions check, but just a &"rough"& check that
18115 operates as follows:
18116
18117 If an item in a &%require_files%& list does not contain any forward slash
18118 characters, it is taken to be the user (and optional group, separated by a
18119 comma) to be checked for subsequent files in the list. If no group is specified
18120 but the user is specified symbolically, the gid associated with the uid is
18121 used. For example:
18122 .code
18123 require_files = mail:/some/file
18124 require_files = $local_part:$home/.procmailrc
18125 .endd
18126 If a user or group name in a &%require_files%& list does not exist, the
18127 &%require_files%& condition fails.
18128
18129 Exim performs the check by scanning along the components of the file path, and
18130 checking the access for the given uid and gid. It checks for &"x"& access on
18131 directories, and &"r"& access on the final file. Note that this means that file
18132 access control lists, if the operating system has them, are ignored.
18133
18134 &*Warning 1*&: When the router is being run to verify addresses for an
18135 incoming SMTP message, Exim is not running as root, but under its own uid. This
18136 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18137 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18138 user is not permitted to read one of the directories on the file's path.
18139
18140 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18141 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18142 without root access. In this case, if a check for access by a particular user
18143 is requested, Exim creates a subprocess that runs as that user, and tries the
18144 check again in that process.
18145
18146 The default action for handling an unresolved EACCES is to consider it to
18147 be caused by a configuration error, and routing is deferred because the
18148 existence or non-existence of the file cannot be determined. However, in some
18149 circumstances it may be desirable to treat this condition as if the file did
18150 not exist. If the file name (or the exclamation mark that precedes the file
18151 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18152 as if the file did not exist. For example:
18153 .code
18154 require_files = +/some/file
18155 .endd
18156 If the router is not an essential part of verification (for example, it
18157 handles users' &_.forward_& files), another solution is to set the &%verify%&
18158 option false so that the router is skipped when verifying.
18159
18160
18161
18162 .option retry_use_local_part routers boolean "see below"
18163 .cindex "hints database" "retry keys"
18164 .cindex "local part" "in retry keys"
18165 When a delivery suffers a temporary routing failure, a retry record is created
18166 in Exim's hints database. For addresses whose routing depends only on the
18167 domain, the key for the retry record should not involve the local part, but for
18168 other addresses, both the domain and the local part should be included.
18169 Usually, remote routing is of the former kind, and local routing is of the
18170 latter kind.
18171
18172 This option controls whether the local part is used to form the key for retry
18173 hints for addresses that suffer temporary errors while being handled by this
18174 router. The default value is true for any router that has &%check_local_user%&
18175 set, and false otherwise. Note that this option does not apply to hints keys
18176 for transport delays; they are controlled by a generic transport option of the
18177 same name.
18178
18179 The setting of &%retry_use_local_part%& applies only to the router on which it
18180 appears. If the router generates child addresses, they are routed
18181 independently; this setting does not become attached to them.
18182
18183
18184
18185 .option router_home_directory routers string&!! unset
18186 .cindex "router" "home directory for"
18187 .cindex "home directory" "for router"
18188 .vindex "&$home$&"
18189 This option sets a home directory for use while the router is running. (Compare
18190 &%transport_home_directory%&, which sets a home directory for later
18191 transporting.) In particular, if used on a &(redirect)& router, this option
18192 sets a value for &$home$& while a filter is running. The value is expanded;
18193 forced expansion failure causes the option to be ignored &-- other failures
18194 cause the router to defer.
18195
18196 Expansion of &%router_home_directory%& happens immediately after the
18197 &%check_local_user%& test (if configured), before any further expansions take
18198 place.
18199 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18200 are evaluated.)
18201 While the router is running, &%router_home_directory%& overrides the value of
18202 &$home$& that came from &%check_local_user%&.
18203
18204 When a router accepts an address and assigns it to a local transport (including
18205 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18206 delivery), the home directory setting for the transport is taken from the first
18207 of these values that is set:
18208
18209 .ilist
18210 The &%home_directory%& option on the transport;
18211 .next
18212 The &%transport_home_directory%& option on the router;
18213 .next
18214 The password data if &%check_local_user%& is set on the router;
18215 .next
18216 The &%router_home_directory%& option on the router.
18217 .endlist
18218
18219 In other words, &%router_home_directory%& overrides the password data for the
18220 router, but not for the transport.
18221
18222
18223
18224 .option self routers string freeze
18225 .cindex "MX record" "pointing to local host"
18226 .cindex "local host" "MX pointing to"
18227 This option applies to those routers that use a recipient address to find a
18228 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18229 and &(manualroute)& routers.
18230 Certain configurations of the &(queryprogram)& router can also specify a list
18231 of remote hosts.
18232 Usually such routers are configured to send the message to a remote host via an
18233 &(smtp)& transport. The &%self%& option specifies what happens when the first
18234 host on the list turns out to be the local host.
18235 The way in which Exim checks for the local host is described in section
18236 &<<SECTreclocipadd>>&.
18237
18238 Normally this situation indicates either an error in Exim's configuration (for
18239 example, the router should be configured not to process this domain), or an
18240 error in the DNS (for example, the MX should not point to this host). For this
18241 reason, the default action is to log the incident, defer the address, and
18242 freeze the message. The following alternatives are provided for use in special
18243 cases:
18244
18245 .vlist
18246 .vitem &%defer%&
18247 Delivery of the message is tried again later, but the message is not frozen.
18248
18249 .vitem "&%reroute%&: <&'domain'&>"
18250 The domain is changed to the given domain, and the address is passed back to
18251 be reprocessed by the routers. No rewriting of headers takes place. This
18252 behaviour is essentially a redirection.
18253
18254 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18255 The domain is changed to the given domain, and the address is passed back to be
18256 reprocessed by the routers. Any headers that contain the original domain are
18257 rewritten.
18258
18259 .vitem &%pass%&
18260 .oindex "&%more%&"
18261 .vindex "&$self_hostname$&"
18262 The router passes the address to the next router, or to the router named in the
18263 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18264 subsequent routing and delivery, the variable &$self_hostname$& contains the
18265 name of the local host that the router encountered. This can be used to
18266 distinguish between different cases for hosts with multiple names. The
18267 combination
18268 .code
18269 self = pass
18270 no_more
18271 .endd
18272 ensures that only those addresses that routed to the local host are passed on.
18273 Without &%no_more%&, addresses that were declined for other reasons would also
18274 be passed to the next router.
18275
18276 .vitem &%fail%&
18277 Delivery fails and an error report is generated.
18278
18279 .vitem &%send%&
18280 .cindex "local host" "sending to"
18281 The anomaly is ignored and the address is queued for the transport. This
18282 setting should be used with extreme caution. For an &(smtp)& transport, it
18283 makes sense only in cases where the program that is listening on the SMTP port
18284 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18285 different configuration file that handles the domain in another way.
18286 .endlist
18287
18288
18289
18290 .option senders routers&!? "address list&!!" unset
18291 .cindex "router" "checking senders"
18292 If this option is set, the router is skipped unless the message's sender
18293 address matches something on the list.
18294 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18295 are evaluated.
18296
18297 There are issues concerning verification when the running of routers is
18298 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18299 setting, it sets the sender to the null string. When using the &%-bt%& option
18300 to check a configuration file, it is necessary also to use the &%-f%& option to
18301 set an appropriate sender. For incoming mail, the sender is unset when
18302 verifying the sender, but is available when verifying any recipients. If the
18303 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18304 matters.
18305
18306
18307 .option translate_ip_address routers string&!! unset
18308 .cindex "IP address" "translating"
18309 .cindex "packet radio"
18310 .cindex "router" "IP address translation"
18311 There exist some rare networking situations (for example, packet radio) where
18312 it is helpful to be able to translate IP addresses generated by normal routing
18313 mechanisms into other IP addresses, thus performing a kind of manual IP
18314 routing. This should be done only if the normal IP routing of the TCP/IP stack
18315 is inadequate or broken. Because this is an extremely uncommon requirement, the
18316 code to support this option is not included in the Exim binary unless
18317 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18318
18319 .vindex "&$host_address$&"
18320 The &%translate_ip_address%& string is expanded for every IP address generated
18321 by the router, with the generated address set in &$host_address$&. If the
18322 expansion is forced to fail, no action is taken.
18323 For any other expansion error, delivery of the message is deferred.
18324 If the result of the expansion is an IP address, that replaces the original
18325 address; otherwise the result is assumed to be a host name &-- this is looked
18326 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18327 produce one or more replacement IP addresses. For example, to subvert all IP
18328 addresses in some specific networks, this could be added to a router:
18329 .code
18330 translate_ip_address = \
18331   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18332     {$value}fail}}
18333 .endd
18334 The file would contain lines like
18335 .code
18336 10.2.3.128/26    some.host
18337 10.8.4.34/26     10.44.8.15
18338 .endd
18339 You should not make use of this facility unless you really understand what you
18340 are doing.
18341
18342
18343
18344 .option transport routers string&!! unset
18345 This option specifies the transport to be used when a router accepts an address
18346 and sets it up for delivery. A transport is never needed if a router is used
18347 only for verification. The value of the option is expanded at routing time,
18348 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18349 and result must be the name of one of the configured transports. If it is not,
18350 delivery is deferred.
18351
18352 The &%transport%& option is not used by the &(redirect)& router, but it does
18353 have some private options that set up transports for pipe and file deliveries
18354 (see chapter &<<CHAPredirect>>&).
18355
18356
18357
18358 .option transport_current_directory routers string&!! unset
18359 .cindex "current directory for local transport"
18360 This option associates a current directory with any address that is routed
18361 to a local transport. This can happen either because a transport is
18362 explicitly configured for the router, or because it generates a delivery to a
18363 file or a pipe. During the delivery process (that is, at transport time), this
18364 option string is expanded and is set as the current directory, unless
18365 overridden by a setting on the transport.
18366 If the expansion fails for any reason, including forced failure, an error is
18367 logged, and delivery is deferred.
18368 See chapter &<<CHAPenvironment>>& for details of the local delivery
18369 environment.
18370
18371
18372
18373
18374 .option transport_home_directory routers string&!! "see below"
18375 .cindex "home directory" "for local transport"
18376 This option associates a home directory with any address that is routed to a
18377 local transport. This can happen either because a transport is explicitly
18378 configured for the router, or because it generates a delivery to a file or a
18379 pipe. During the delivery process (that is, at transport time), the option
18380 string is expanded and is set as the home directory, unless overridden by a
18381 setting of &%home_directory%& on the transport.
18382 If the expansion fails for any reason, including forced failure, an error is
18383 logged, and delivery is deferred.
18384
18385 If the transport does not specify a home directory, and
18386 &%transport_home_directory%& is not set for the router, the home directory for
18387 the transport is taken from the password data if &%check_local_user%& is set for
18388 the router. Otherwise it is taken from &%router_home_directory%& if that option
18389 is set; if not, no home directory is set for the transport.
18390
18391 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18392 environment.
18393
18394
18395
18396
18397 .option unseen routers boolean&!! false
18398 .cindex "router" "carrying on after success"
18399 The result of string expansion for this option must be a valid boolean value,
18400 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18401 result causes an error, and delivery is deferred. If the expansion is forced to
18402 fail, the default value for the option (false) is used. Other failures cause
18403 delivery to be deferred.
18404
18405 When this option is set true, routing does not cease if the router accepts the
18406 address. Instead, a copy of the incoming address is passed to the next router,
18407 overriding a false setting of &%more%&. There is little point in setting
18408 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18409 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18410 sometimes true and sometimes false).
18411
18412 .cindex "copy of message (&%unseen%& option)"
18413 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18414 qualifier in filter files. It can be used to cause copies of messages to be
18415 delivered to some other destination, while also carrying out a normal delivery.
18416 In effect, the current address is made into a &"parent"& that has two children
18417 &-- one that is delivered as specified by this router, and a clone that goes on
18418 to be routed further. For this reason, &%unseen%& may not be combined with the
18419 &%one_time%& option in a &(redirect)& router.
18420
18421 &*Warning*&: Header lines added to the address (or specified for removal) by
18422 this router or by previous routers affect the &"unseen"& copy of the message
18423 only. The clone that continues to be processed by further routers starts with
18424 no added headers and none specified for removal. For a &%redirect%& router, if
18425 a generated address is the same as the incoming address, this can lead to
18426 duplicate addresses with different header modifications. Exim does not do
18427 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18428 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18429 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18430 &%redirect%& router may be of help.
18431
18432 Unlike the handling of header modifications, any data that was set by the
18433 &%address_data%& option in the current or previous routers &'is'& passed on to
18434 subsequent routers.
18435
18436
18437 .option user routers string&!! "see below"
18438 .cindex "uid (user id)" "local delivery"
18439 .cindex "local transports" "uid and gid"
18440 .cindex "transport" "local"
18441 .cindex "router" "user for filter processing"
18442 .cindex "filter" "user for processing"
18443 When a router queues an address for a transport, and the transport does not
18444 specify a user, the user given here is used when running the delivery process.
18445 The user may be specified numerically or by name. If expansion fails, the
18446 error is logged and delivery is deferred.
18447 This user is also used by the &(redirect)& router when running a filter file.
18448 The default is unset, except when &%check_local_user%& is set. In this case,
18449 the default is taken from the password information. If the user is specified as
18450 a name, and &%group%& is not set, the group associated with the user is used.
18451 See also &%initgroups%& and &%group%& and the discussion in chapter
18452 &<<CHAPenvironment>>&.
18453
18454
18455
18456 .option verify routers&!? boolean true
18457 Setting this option has the effect of setting &%verify_sender%& and
18458 &%verify_recipient%& to the same value.
18459
18460
18461 .option verify_only routers&!? boolean false
18462 .cindex "EXPN" "with &%verify_only%&"
18463 .oindex "&%-bv%&"
18464 .cindex "router" "used only when verifying"
18465 If this option is set, the router is used only when verifying an address,
18466 delivering in cutthrough mode or
18467 testing with the &%-bv%& option, not when actually doing a delivery, testing
18468 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18469 restricted to verifying only senders or recipients by means of
18470 &%verify_sender%& and &%verify_recipient%&.
18471
18472 &*Warning*&: When the router is being run to verify addresses for an incoming
18473 SMTP message, Exim is not running as root, but under its own uid. If the router
18474 accesses any files, you need to make sure that they are accessible to the Exim
18475 user or group.
18476
18477
18478 .option verify_recipient routers&!? boolean true
18479 If this option is false, the router is skipped when verifying recipient
18480 addresses,
18481 delivering in cutthrough mode
18482 or testing recipient verification using &%-bv%&.
18483 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18484 are evaluated.
18485 See also the &$verify_mode$& variable.
18486
18487
18488 .option verify_sender routers&!? boolean true
18489 If this option is false, the router is skipped when verifying sender addresses
18490 or testing sender verification using &%-bvs%&.
18491 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18492 are evaluated.
18493 See also the &$verify_mode$& variable.
18494 .ecindex IIDgenoprou1
18495 .ecindex IIDgenoprou2
18496
18497
18498
18499
18500
18501
18502 . ////////////////////////////////////////////////////////////////////////////
18503 . ////////////////////////////////////////////////////////////////////////////
18504
18505 .chapter "The accept router" "CHID4"
18506 .cindex "&(accept)& router"
18507 .cindex "routers" "&(accept)&"
18508 The &(accept)& router has no private options of its own. Unless it is being
18509 used purely for verification (see &%verify_only%&) a transport is required to
18510 be defined by the generic &%transport%& option. If the preconditions that are
18511 specified by generic options are met, the router accepts the address and queues
18512 it for the given transport. The most common use of this router is for setting
18513 up deliveries to local mailboxes. For example:
18514 .code
18515 localusers:
18516   driver = accept
18517   domains = mydomain.example
18518   check_local_user
18519   transport = local_delivery
18520 .endd
18521 The &%domains%& condition in this example checks the domain of the address, and
18522 &%check_local_user%& checks that the local part is the login of a local user.
18523 When both preconditions are met, the &(accept)& router runs, and queues the
18524 address for the &(local_delivery)& transport.
18525
18526
18527
18528
18529
18530
18531 . ////////////////////////////////////////////////////////////////////////////
18532 . ////////////////////////////////////////////////////////////////////////////
18533
18534 .chapter "The dnslookup router" "CHAPdnslookup"
18535 .scindex IIDdnsrou1 "&(dnslookup)& router"
18536 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18537 The &(dnslookup)& router looks up the hosts that handle mail for the
18538 recipient's domain in the DNS. A transport must always be set for this router,
18539 unless &%verify_only%& is set.
18540
18541 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18542 SRV records. If none are found, or if SRV support is not configured,
18543 MX records are looked up. If no MX records exist, address records are sought.
18544 However, &%mx_domains%& can be set to disable the direct use of address
18545 records.
18546
18547 MX records of equal priority are sorted by Exim into a random order. Exim then
18548 looks for address records for the host names obtained from MX or SRV records.
18549 When a host has more than one IP address, they are sorted into a random order,
18550 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18551 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18552 generic option, the router declines.
18553
18554 Unless they have the highest priority (lowest MX value), MX records that point
18555 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18556 are discarded, together with any other MX records of equal or lower priority.
18557
18558 .cindex "MX record" "pointing to local host"
18559 .cindex "local host" "MX pointing to"
18560 .oindex "&%self%&" "in &(dnslookup)& router"
18561 If the host pointed to by the highest priority MX record, or looked up as an
18562 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18563 happens is controlled by the generic &%self%& option.
18564
18565
18566 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18567 There have been problems with DNS servers when SRV records are looked up.
18568 Some misbehaving servers return a DNS error or timeout when a non-existent
18569 SRV record is sought. Similar problems have in the past been reported for
18570 MX records. The global &%dns_again_means_nonexist%& option can help with this
18571 problem, but it is heavy-handed because it is a global option.
18572
18573 For this reason, there are two options, &%srv_fail_domains%& and
18574 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18575 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18576 an attempt to look up an SRV or MX record causes one of these results, and the
18577 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18578 such record"&. In the case of an SRV lookup, this means that the router
18579 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18580 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18581 case routing fails.
18582
18583
18584 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18585 .cindex "&(dnslookup)& router" "declines"
18586 There are a few cases where a &(dnslookup)& router will decline to accept
18587 an address; if such a router is expected to handle "all remaining non-local
18588 domains", then it is important to set &%no_more%&.
18589
18590 The router will defer rather than decline if the domain
18591 is found in the &%fail_defer_domains%& router option.
18592
18593 Reasons for a &(dnslookup)& router to decline currently include:
18594 .ilist
18595 The domain does not exist in DNS
18596 .next
18597 The domain exists but the MX record's host part is just "."; this is a common
18598 convention (borrowed from SRV) used to indicate that there is no such service
18599 for this domain and to not fall back to trying A/AAAA records.
18600 .next
18601 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18602 .next
18603 MX record points to a non-existent host.
18604 .next
18605 MX record points to an IP address and the main section option
18606 &%allow_mx_to_ip%& is not set.
18607 .next
18608 MX records exist and point to valid hosts, but all hosts resolve only to
18609 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18610 .next
18611 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18612 &%dns_check_names_pattern%& for handling one variant of this)
18613 .next
18614 &%check_secondary_mx%& is set on this router but the local host can
18615 not be found in the MX records (see below)
18616 .endlist
18617
18618
18619
18620
18621 .section "Private options for dnslookup" "SECID118"
18622 .cindex "options" "&(dnslookup)& router"
18623 The private options for the &(dnslookup)& router are as follows:
18624
18625 .option check_secondary_mx dnslookup boolean false
18626 .cindex "MX record" "checking for secondary"
18627 If this option is set, the router declines unless the local host is found in
18628 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18629 process domains for which the local host is a secondary mail exchanger
18630 differently to other domains. The way in which Exim decides whether a host is
18631 the local host is described in section &<<SECTreclocipadd>>&.
18632
18633
18634 .option check_srv dnslookup string&!! unset
18635 .cindex "SRV record" "enabling use of"
18636 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18637 addition to MX and address records. The support is disabled by default. To
18638 enable SRV support, set the &%check_srv%& option to the name of the service
18639 required. For example,
18640 .code
18641 check_srv = smtp
18642 .endd
18643 looks for SRV records that refer to the normal smtp service. The option is
18644 expanded, so the service name can vary from message to message or address
18645 to address. This might be helpful if SRV records are being used for a
18646 submission service. If the expansion is forced to fail, the &%check_srv%&
18647 option is ignored, and the router proceeds to look for MX records in the
18648 normal way.
18649
18650 When the expansion succeeds, the router searches first for SRV records for
18651 the given service (it assumes TCP protocol). A single SRV record with a
18652 host name that consists of just a single dot indicates &"no such service for
18653 this domain"&; if this is encountered, the router declines. If other kinds of
18654 SRV record are found, they are used to construct a host list for delivery
18655 according to the rules of RFC 2782. MX records are not sought in this case.
18656
18657 When no SRV records are found, MX records (and address records) are sought in
18658 the traditional way. In other words, SRV records take precedence over MX
18659 records, just as MX records take precedence over address records. Note that
18660 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18661 defined it. It is apparently believed that MX records are sufficient for email
18662 and that SRV records should not be used for this purpose. However, SRV records
18663 have an additional &"weight"& feature which some people might find useful when
18664 trying to split an SMTP load between hosts of different power.
18665
18666 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18667 when there is a DNS lookup error.
18668
18669
18670
18671
18672 .option fail_defer_domains dnslookup "domain list&!!" unset
18673 .cindex "MX record" "not found"
18674 DNS lookups for domains matching &%fail_defer_domains%&
18675 which find no matching record will cause the router to defer
18676 rather than the default behaviour of decline.
18677 This maybe be useful for queueing messages for a newly created
18678 domain while the DNS configuration is not ready.
18679 However, it will result in any message with mistyped domains
18680 also being queued.
18681
18682
18683 .option mx_domains dnslookup "domain list&!!" unset
18684 .cindex "MX record" "required to exist"
18685 .cindex "SRV record" "required to exist"
18686 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18687 record in order to be recognized. (The name of this option could be improved.)
18688 For example, if all the mail hosts in &'fict.example'& are known to have MX
18689 records, except for those in &'discworld.fict.example'&, you could use this
18690 setting:
18691 .code
18692 mx_domains = ! *.discworld.fict.example : *.fict.example
18693 .endd
18694 This specifies that messages addressed to a domain that matches the list but
18695 has no MX record should be bounced immediately instead of being routed using
18696 the address record.
18697
18698
18699 .option mx_fail_domains dnslookup "domain list&!!" unset
18700 If the DNS lookup for MX records for one of the domains in this list causes a
18701 DNS lookup error, Exim behaves as if no MX records were found. See section
18702 &<<SECTprowitdnsloo>>& for more discussion.
18703
18704
18705
18706
18707 .option qualify_single dnslookup boolean true
18708 .cindex "DNS" "resolver options"
18709 .cindex "DNS" "qualifying single-component names"
18710 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18711 lookups. Typically, but not standardly, this causes the resolver to qualify
18712 single-component names with the default domain. For example, on a machine
18713 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18714 &'thesaurus.ref.example'& inside the resolver. For details of what your
18715 resolver actually does, consult your man pages for &'resolver'& and
18716 &'resolv.conf'&.
18717
18718
18719
18720 .option rewrite_headers dnslookup boolean true
18721 .cindex "rewriting" "header lines"
18722 .cindex "header lines" "rewriting"
18723 If the domain name in the address that is being processed is not fully
18724 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18725 an address is specified as &'dormouse@teaparty'&, the domain might be
18726 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18727 occur as a result of setting the &%widen_domains%& option. If
18728 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18729 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18730 header lines of the message are rewritten with the full domain name.
18731
18732 This option should be turned off only when it is known that no message is
18733 ever going to be sent outside an environment where the abbreviation makes
18734 sense.
18735
18736 When an MX record is looked up in the DNS and matches a wildcard record, name
18737 servers normally return a record containing the name that has been looked up,
18738 making it impossible to detect whether a wildcard was present or not. However,
18739 some name servers have recently been seen to return the wildcard entry. If the
18740 name returned by a DNS lookup begins with an asterisk, it is not used for
18741 header rewriting.
18742
18743
18744 .option same_domain_copy_routing dnslookup boolean false
18745 .cindex "address" "copying routing"
18746 Addresses with the same domain are normally routed by the &(dnslookup)& router
18747 to the same list of hosts. However, this cannot be presumed, because the router
18748 options and preconditions may refer to the local part of the address. By
18749 default, therefore, Exim routes each address in a message independently. DNS
18750 servers run caches, so repeated DNS lookups are not normally expensive, and in
18751 any case, personal messages rarely have more than a few recipients.
18752
18753 If you are running mailing lists with large numbers of subscribers at the same
18754 domain, and you are using a &(dnslookup)& router which is independent of the
18755 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18756 lookups for identical domains in one message. In this case, when &(dnslookup)&
18757 routes an address to a remote transport, any other unrouted addresses in the
18758 message that have the same domain are automatically given the same routing
18759 without processing them independently,
18760 provided the following conditions are met:
18761
18762 .ilist
18763 No router that processed the address specified &%headers_add%& or
18764 &%headers_remove%&.
18765 .next
18766 The router did not change the address in any way, for example, by &"widening"&
18767 the domain.
18768 .endlist
18769
18770
18771
18772
18773 .option search_parents dnslookup boolean false
18774 .cindex "DNS" "resolver options"
18775 When this option is true, the resolver option RES_DNSRCH is set for DNS
18776 lookups. This is different from the &%qualify_single%& option in that it
18777 applies to domains containing dots. Typically, but not standardly, it causes
18778 the resolver to search for the name in the current domain and in parent
18779 domains. For example, on a machine in the &'fict.example'& domain, if looking
18780 up &'teaparty.wonderland'& failed, the resolver would try
18781 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18782 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18783
18784 Setting this option true can cause problems in domains that have a wildcard MX
18785 record, because any domain that does not have its own MX record matches the
18786 local wildcard.
18787
18788
18789
18790 .option srv_fail_domains dnslookup "domain list&!!" unset
18791 If the DNS lookup for SRV records for one of the domains in this list causes a
18792 DNS lookup error, Exim behaves as if no SRV records were found. See section
18793 &<<SECTprowitdnsloo>>& for more discussion.
18794
18795
18796
18797
18798 .option widen_domains dnslookup "string list" unset
18799 .cindex "domain" "partial; widening"
18800 If a DNS lookup fails and this option is set, each of its strings in turn is
18801 added onto the end of the domain, and the lookup is tried again. For example,
18802 if
18803 .code
18804 widen_domains = fict.example:ref.example
18805 .endd
18806 is set and a lookup of &'klingon.dictionary'& fails,
18807 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18808 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18809 and &%search_parents%& options can cause some widening to be undertaken inside
18810 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18811 when verifying, unless &%rewrite_headers%& is false (not the default).
18812
18813
18814 .section "Effect of qualify_single and search_parents" "SECID119"
18815 When a domain from an envelope recipient is changed by the resolver as a result
18816 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18817 corresponding address in the message's header lines unless &%rewrite_headers%&
18818 is set false. Exim then re-routes the address, using the full domain.
18819
18820 These two options affect only the DNS lookup that takes place inside the router
18821 for the domain of the address that is being routed. They do not affect lookups
18822 such as that implied by
18823 .code
18824 domains = @mx_any
18825 .endd
18826 that may happen while processing a router precondition before the router is
18827 entered. No widening ever takes place for these lookups.
18828 .ecindex IIDdnsrou1
18829 .ecindex IIDdnsrou2
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839 . ////////////////////////////////////////////////////////////////////////////
18840 . ////////////////////////////////////////////////////////////////////////////
18841
18842 .chapter "The ipliteral router" "CHID5"
18843 .cindex "&(ipliteral)& router"
18844 .cindex "domain literal" "routing"
18845 .cindex "routers" "&(ipliteral)&"
18846 This router has no private options. Unless it is being used purely for
18847 verification (see &%verify_only%&) a transport is required to be defined by the
18848 generic &%transport%& option. The router accepts the address if its domain part
18849 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18850 router handles the address
18851 .code
18852 root@[192.168.1.1]
18853 .endd
18854 by setting up delivery to the host with that IP address. IPv4 domain literals
18855 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18856 are similar, but the address is preceded by &`ipv6:`&. For example:
18857 .code
18858 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18859 .endd
18860 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18861 grounds that sooner or later somebody will try it.
18862
18863 .oindex "&%self%&" "in &(ipliteral)& router"
18864 If the IP address matches something in &%ignore_target_hosts%&, the router
18865 declines. If an IP literal turns out to refer to the local host, the generic
18866 &%self%& option determines what happens.
18867
18868 The RFCs require support for domain literals; however, their use is
18869 controversial in today's Internet. If you want to use this router, you must
18870 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18871 Exim will not recognize the domain literal syntax in addresses.
18872
18873
18874
18875 . ////////////////////////////////////////////////////////////////////////////
18876 . ////////////////////////////////////////////////////////////////////////////
18877
18878 .chapter "The iplookup router" "CHID6"
18879 .cindex "&(iplookup)& router"
18880 .cindex "routers" "&(iplookup)&"
18881 The &(iplookup)& router was written to fulfil a specific requirement in
18882 Cambridge University (which in fact no longer exists). For this reason, it is
18883 not included in the binary of Exim by default. If you want to include it, you
18884 must set
18885 .code
18886 ROUTER_IPLOOKUP=yes
18887 .endd
18888 in your &_Local/Makefile_& configuration file.
18889
18890 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18891 connection to one or more specific hosts. The host can then return the same or
18892 a different address &-- in effect rewriting the recipient address in the
18893 message's envelope. The new address is then passed on to subsequent routers. If
18894 this process fails, the address can be passed on to other routers, or delivery
18895 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18896 must not be specified for it.
18897
18898 .cindex "options" "&(iplookup)& router"
18899 .option hosts iplookup string unset
18900 This option must be supplied. Its value is a colon-separated list of host
18901 names. The hosts are looked up using &[gethostbyname()]&
18902 (or &[getipnodebyname()]& when available)
18903 and are tried in order until one responds to the query. If none respond, what
18904 happens is controlled by &%optional%&.
18905
18906
18907 .option optional iplookup boolean false
18908 If &%optional%& is true, if no response is obtained from any host, the address
18909 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18910 delivery to the address is deferred.
18911
18912
18913 .option port iplookup integer 0
18914 .cindex "port" "&(iplookup)& router"
18915 This option must be supplied. It specifies the port number for the TCP or UDP
18916 call.
18917
18918
18919 .option protocol iplookup string udp
18920 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18921 protocols is to be used.
18922
18923
18924 .option query iplookup string&!! "see below"
18925 This defines the content of the query that is sent to the remote hosts. The
18926 default value is:
18927 .code
18928 $local_part@$domain $local_part@$domain
18929 .endd
18930 The repetition serves as a way of checking that a response is to the correct
18931 query in the default case (see &%response_pattern%& below).
18932
18933
18934 .option reroute iplookup string&!! unset
18935 If this option is not set, the rerouted address is precisely the byte string
18936 returned by the remote host, up to the first white space, if any. If set, the
18937 string is expanded to form the rerouted address. It can include parts matched
18938 in the response by &%response_pattern%& by means of numeric variables such as
18939 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18940 whether or not a pattern is in use. In all cases, the rerouted address must end
18941 up in the form &'local_part@domain'&.
18942
18943
18944 .option response_pattern iplookup string unset
18945 This option can be set to a regular expression that is applied to the string
18946 returned from the remote host. If the pattern does not match the response, the
18947 router declines. If &%response_pattern%& is not set, no checking of the
18948 response is done, unless the query was defaulted, in which case there is a
18949 check that the text returned after the first white space is the original
18950 address. This checks that the answer that has been received is in response to
18951 the correct question. For example, if the response is just a new domain, the
18952 following could be used:
18953 .code
18954 response_pattern = ^([^@]+)$
18955 reroute = $local_part@$1
18956 .endd
18957
18958 .option timeout iplookup time 5s
18959 This specifies the amount of time to wait for a response from the remote
18960 machine. The same timeout is used for the &[connect()]& function for a TCP
18961 call. It does not apply to UDP.
18962
18963
18964
18965
18966 . ////////////////////////////////////////////////////////////////////////////
18967 . ////////////////////////////////////////////////////////////////////////////
18968
18969 .chapter "The manualroute router" "CHID7"
18970 .scindex IIDmanrou1 "&(manualroute)& router"
18971 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18972 .cindex "domain" "manually routing"
18973 The &(manualroute)& router is so-called because it provides a way of manually
18974 routing an address according to its domain. It is mainly used when you want to
18975 route addresses to remote hosts according to your own rules, bypassing the
18976 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18977 route to local transports, a facility that may be useful if you want to save
18978 messages for dial-in hosts in local files.
18979
18980 The &(manualroute)& router compares a list of domain patterns with the domain
18981 it is trying to route. If there is no match, the router declines. Each pattern
18982 has associated with it a list of hosts and some other optional data, which may
18983 include a transport. The combination of a pattern and its data is called a
18984 &"routing rule"&. For patterns that do not have an associated transport, the
18985 generic &%transport%& option must specify a transport, unless the router is
18986 being used purely for verification (see &%verify_only%&).
18987
18988 .vindex "&$host$&"
18989 In the case of verification, matching the domain pattern is sufficient for the
18990 router to accept the address. When actually routing an address for delivery,
18991 an address that matches a domain pattern is queued for the associated
18992 transport. If the transport is not a local one, a host list must be associated
18993 with the pattern; IP addresses are looked up for the hosts, and these are
18994 passed to the transport along with the mail address. For local transports, a
18995 host list is optional. If it is present, it is passed in &$host$& as a single
18996 text string.
18997
18998 The list of routing rules can be provided as an inline string in
18999 &%route_list%&, or the data can be obtained by looking up the domain in a file
19000 or database by setting &%route_data%&. Only one of these settings may appear in
19001 any one instance of &(manualroute)&. The format of routing rules is described
19002 below, following the list of private options.
19003
19004
19005 .section "Private options for manualroute" "SECTprioptman"
19006
19007 .cindex "options" "&(manualroute)& router"
19008 The private options for the &(manualroute)& router are as follows:
19009
19010 .option host_all_ignored manualroute string defer
19011 See &%host_find_failed%&.
19012
19013 .option host_find_failed manualroute string freeze
19014 This option controls what happens when &(manualroute)& tries to find an IP
19015 address for a host, and the host does not exist. The option can be set to one
19016 of the following values:
19017 .code
19018 decline
19019 defer
19020 fail
19021 freeze
19022 ignore
19023 pass
19024 .endd
19025 The default (&"freeze"&) assumes that this state is a serious configuration
19026 error. The difference between &"pass"& and &"decline"& is that the former
19027 forces the address to be passed to the next router (or the router defined by
19028 &%pass_router%&),
19029 .oindex "&%more%&"
19030 overriding &%no_more%&, whereas the latter passes the address to the next
19031 router only if &%more%& is true.
19032
19033 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19034 cannot be found. If all the hosts in the list are ignored, the behaviour is
19035 controlled by the &%host_all_ignored%& option. This takes the same values
19036 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19037
19038 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19039 state; if a host lookup gets a temporary error, delivery is deferred unless the
19040 generic &%pass_on_timeout%& option is set.
19041
19042
19043 .option hosts_randomize manualroute boolean false
19044 .cindex "randomized host list"
19045 .cindex "host" "list of; randomized"
19046 If this option is set, the order of the items in a host list in a routing rule
19047 is randomized each time the list is used, unless an option in the routing rule
19048 overrides (see below). Randomizing the order of a host list can be used to do
19049 crude load sharing. However, if more than one mail address is routed by the
19050 same router to the same host list, the host lists are considered to be the same
19051 (even though they may be randomized into different orders) for the purpose of
19052 deciding whether to batch the deliveries into a single SMTP transaction.
19053
19054 When &%hosts_randomize%& is true, a host list may be split
19055 into groups whose order is separately randomized. This makes it possible to
19056 set up MX-like behaviour. The boundaries between groups are indicated by an
19057 item that is just &`+`& in the host list. For example:
19058 .code
19059 route_list = * host1:host2:host3:+:host4:host5
19060 .endd
19061 The order of the first three hosts and the order of the last two hosts is
19062 randomized for each use, but the first three always end up before the last two.
19063 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19064 randomized host list is passed to an &(smtp)& transport that also has
19065 &%hosts_randomize set%&, the list is not re-randomized.
19066
19067
19068 .option route_data manualroute string&!! unset
19069 If this option is set, it must expand to yield the data part of a routing rule.
19070 Typically, the expansion string includes a lookup based on the domain. For
19071 example:
19072 .code
19073 route_data = ${lookup{$domain}dbm{/etc/routes}}
19074 .endd
19075 If the expansion is forced to fail, or the result is an empty string, the
19076 router declines. Other kinds of expansion failure cause delivery to be
19077 deferred.
19078
19079
19080 .option route_list manualroute "string list" unset
19081 This string is a list of routing rules, in the form defined below. Note that,
19082 unlike most string lists, the items are separated by semicolons. This is so
19083 that they may contain colon-separated host lists.
19084
19085
19086 .option same_domain_copy_routing manualroute boolean false
19087 .cindex "address" "copying routing"
19088 Addresses with the same domain are normally routed by the &(manualroute)&
19089 router to the same list of hosts. However, this cannot be presumed, because the
19090 router options and preconditions may refer to the local part of the address. By
19091 default, therefore, Exim routes each address in a message independently. DNS
19092 servers run caches, so repeated DNS lookups are not normally expensive, and in
19093 any case, personal messages rarely have more than a few recipients.
19094
19095 If you are running mailing lists with large numbers of subscribers at the same
19096 domain, and you are using a &(manualroute)& router which is independent of the
19097 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19098 lookups for identical domains in one message. In this case, when
19099 &(manualroute)& routes an address to a remote transport, any other unrouted
19100 addresses in the message that have the same domain are automatically given the
19101 same routing without processing them independently. However, this is only done
19102 if &%headers_add%& and &%headers_remove%& are unset.
19103
19104
19105
19106
19107 .section "Routing rules in route_list" "SECID120"
19108 The value of &%route_list%& is a string consisting of a sequence of routing
19109 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19110 entered as two semicolons. Alternatively, the list separator can be changed as
19111 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19112 Empty rules are ignored. The format of each rule is
19113 .display
19114 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19115 .endd
19116 The following example contains two rules, each with a simple domain pattern and
19117 no options:
19118 .code
19119 route_list = \
19120   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19121   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19122 .endd
19123 The three parts of a rule are separated by white space. The pattern and the
19124 list of hosts can be enclosed in quotes if necessary, and if they are, the
19125 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19126 single domain pattern, which is the only mandatory item in the rule. The
19127 pattern is in the same format as one item in a domain list (see section
19128 &<<SECTdomainlist>>&),
19129 except that it may not be the name of an interpolated file.
19130 That is, it may be wildcarded, or a regular expression, or a file or database
19131 lookup (with semicolons doubled, because of the use of semicolon as a separator
19132 in a &%route_list%&).
19133
19134 The rules in &%route_list%& are searched in order until one of the patterns
19135 matches the domain that is being routed. The list of hosts and then options are
19136 then used as described below. If there is no match, the router declines. When
19137 &%route_list%& is set, &%route_data%& must not be set.
19138
19139
19140
19141 .section "Routing rules in route_data" "SECID121"
19142 The use of &%route_list%& is convenient when there are only a small number of
19143 routing rules. For larger numbers, it is easier to use a file or database to
19144 hold the routing information, and use the &%route_data%& option instead.
19145 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19146 Most commonly, &%route_data%& is set as a string that contains an
19147 expansion lookup. For example, suppose we place two routing rules in a file
19148 like this:
19149 .code
19150 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19151 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19152 .endd
19153 This data can be accessed by setting
19154 .code
19155 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19156 .endd
19157 Failure of the lookup results in an empty string, causing the router to
19158 decline. However, you do not have to use a lookup in &%route_data%&. The only
19159 requirement is that the result of expanding the string is a list of hosts,
19160 possibly followed by options, separated by white space. The list of hosts must
19161 be enclosed in quotes if it contains white space.
19162
19163
19164
19165
19166 .section "Format of the list of hosts" "SECID122"
19167 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19168 always separately expanded before use. If the expansion fails, the router
19169 declines. The result of the expansion must be a colon-separated list of names
19170 and/or IP addresses, optionally also including ports. The format of each item
19171 in the list is described in the next section. The list separator can be changed
19172 as described in section &<<SECTlistconstruct>>&.
19173
19174 If the list of hosts was obtained from a &%route_list%& item, the following
19175 variables are set during its expansion:
19176
19177 .ilist
19178 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19179 If the domain was matched against a regular expression, the numeric variables
19180 &$1$&, &$2$&, etc. may be set. For example:
19181 .code
19182 route_list = ^domain(\d+)   host-$1.text.example
19183 .endd
19184 .next
19185 &$0$& is always set to the entire domain.
19186 .next
19187 &$1$& is also set when partial matching is done in a file lookup.
19188
19189 .next
19190 .vindex "&$value$&"
19191 If the pattern that matched the domain was a lookup item, the data that was
19192 looked up is available in the expansion variable &$value$&. For example:
19193 .code
19194 route_list = lsearch;;/some/file.routes  $value
19195 .endd
19196 .endlist
19197
19198 Note the doubling of the semicolon in the pattern that is necessary because
19199 semicolon is the default route list separator.
19200
19201
19202
19203 .section "Format of one host item" "SECTformatonehostitem"
19204 Each item in the list of hosts is either a host name or an IP address,
19205 optionally with an attached port number. When no port is given, an IP address
19206 is not enclosed in brackets. When a port is specified, it overrides the port
19207 specification on the transport. The port is separated from the name or address
19208 by a colon. This leads to some complications:
19209
19210 .ilist
19211 Because colon is the default separator for the list of hosts, either
19212 the colon that specifies a port must be doubled, or the list separator must
19213 be changed. The following two examples have the same effect:
19214 .code
19215 route_list = * "host1.tld::1225 : host2.tld::1226"
19216 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19217 .endd
19218 .next
19219 When IPv6 addresses are involved, it gets worse, because they contain
19220 colons of their own. To make this case easier, it is permitted to
19221 enclose an IP address (either v4 or v6) in square brackets if a port
19222 number follows. For example:
19223 .code
19224 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19225 .endd
19226 .endlist
19227
19228 .section "How the list of hosts is used" "SECThostshowused"
19229 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19230 the hosts is tried, in the order specified, when carrying out the SMTP
19231 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19232 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19233 transport.
19234
19235 Hosts may be listed by name or by IP address. An unadorned name in the list of
19236 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19237 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19238 records in the DNS. For example:
19239 .code
19240 route_list = *  x.y.z:p.q.r/MX:e.f.g
19241 .endd
19242 If this feature is used with a port specifier, the port must come last. For
19243 example:
19244 .code
19245 route_list = *  dom1.tld/mx::1225
19246 .endd
19247 If the &%hosts_randomize%& option is set, the order of the items in the list is
19248 randomized before any lookups are done. Exim then scans the list; for any name
19249 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19250 be an interface on the local host and the item is not the first in the list,
19251 Exim discards it and any subsequent items. If it is the first item, what
19252 happens is controlled by the
19253 .oindex "&%self%&" "in &(manualroute)& router"
19254 &%self%& option of the router.
19255
19256 A name on the list that is followed by &`/MX`& is replaced with the list of
19257 hosts obtained by looking up MX records for the name. This is always a DNS
19258 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19259 below) are not relevant here. The order of these hosts is determined by the
19260 preference values in the MX records, according to the usual rules. Because
19261 randomizing happens before the MX lookup, it does not affect the order that is
19262 defined by MX preferences.
19263
19264 If the local host is present in the sublist obtained from MX records, but is
19265 not the most preferred host in that list, it and any equally or less
19266 preferred hosts are removed before the sublist is inserted into the main list.
19267
19268 If the local host is the most preferred host in the MX list, what happens
19269 depends on where in the original list of hosts the &`/MX`& item appears. If it
19270 is not the first item (that is, there are previous hosts in the main list),
19271 Exim discards this name and any subsequent items in the main list.
19272
19273 If the MX item is first in the list of hosts, and the local host is the
19274 most preferred host, what happens is controlled by the &%self%& option of the
19275 router.
19276
19277 DNS failures when lookup up the MX records are treated in the same way as DNS
19278 failures when looking up IP addresses: &%pass_on_timeout%& and
19279 &%host_find_failed%& are used when relevant.
19280
19281 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19282 whether obtained from an MX lookup or not.
19283
19284
19285
19286 .section "How the options are used" "SECThowoptused"
19287 The options are a sequence of words; in practice no more than three are ever
19288 present. One of the words can be the name of a transport; this overrides the
19289 &%transport%& option on the router for this particular routing rule only. The
19290 other words (if present) control randomization of the list of hosts on a
19291 per-rule basis, and how the IP addresses of the hosts are to be found when
19292 routing to a remote transport. These options are as follows:
19293
19294 .ilist
19295 &%randomize%&: randomize the order of the hosts in this list, overriding the
19296 setting of &%hosts_randomize%& for this routing rule only.
19297 .next
19298 &%no_randomize%&: do not randomize the order of the hosts in this list,
19299 overriding the setting of &%hosts_randomize%& for this routing rule only.
19300 .next
19301 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19302 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19303 also look in &_/etc/hosts_& or other sources of information.
19304 .next
19305 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19306 no address records are found. If there is a temporary DNS error (such as a
19307 timeout), delivery is deferred.
19308 .endlist
19309
19310 For example:
19311 .code
19312 route_list = domain1  host1:host2:host3  randomize bydns;\
19313              domain2  host4:host5
19314 .endd
19315 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19316 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19317 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19318 or &[gethostbyname()]&, and the result of the lookup is the result of that
19319 call.
19320
19321 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19322 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19323 instead of TRY_AGAIN. That is why the default action is to try a DNS
19324 lookup first. Only if that gives a definite &"no such host"& is the local
19325 function called.
19326
19327
19328
19329 If no IP address for a host can be found, what happens is controlled by the
19330 &%host_find_failed%& option.
19331
19332 .vindex "&$host$&"
19333 When an address is routed to a local transport, IP addresses are not looked up.
19334 The host list is passed to the transport in the &$host$& variable.
19335
19336
19337
19338 .section "Manualroute examples" "SECID123"
19339 In some of the examples that follow, the presence of the &%remote_smtp%&
19340 transport, as defined in the default configuration file, is assumed:
19341
19342 .ilist
19343 .cindex "smart host" "example router"
19344 The &(manualroute)& router can be used to forward all external mail to a
19345 &'smart host'&. If you have set up, in the main part of the configuration, a
19346 named domain list that contains your local domains, for example:
19347 .code
19348 domainlist local_domains = my.domain.example
19349 .endd
19350 You can arrange for all other domains to be routed to a smart host by making
19351 your first router something like this:
19352 .code
19353 smart_route:
19354   driver = manualroute
19355   domains = !+local_domains
19356   transport = remote_smtp
19357   route_list = * smarthost.ref.example
19358 .endd
19359 This causes all non-local addresses to be sent to the single host
19360 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19361 they are tried in order
19362 (but you can use &%hosts_randomize%& to vary the order each time).
19363 Another way of configuring the same thing is this:
19364 .code
19365 smart_route:
19366   driver = manualroute
19367   transport = remote_smtp
19368   route_list = !+local_domains  smarthost.ref.example
19369 .endd
19370 There is no difference in behaviour between these two routers as they stand.
19371 However, they behave differently if &%no_more%& is added to them. In the first
19372 example, the router is skipped if the domain does not match the &%domains%&
19373 precondition; the following router is always tried. If the router runs, it
19374 always matches the domain and so can never decline. Therefore, &%no_more%&
19375 would have no effect. In the second case, the router is never skipped; it
19376 always runs. However, if it doesn't match the domain, it declines. In this case
19377 &%no_more%& would prevent subsequent routers from running.
19378
19379 .next
19380 .cindex "mail hub example"
19381 A &'mail hub'& is a host which receives mail for a number of domains via MX
19382 records in the DNS and delivers it via its own private routing mechanism. Often
19383 the final destinations are behind a firewall, with the mail hub being the one
19384 machine that can connect to machines both inside and outside the firewall. The
19385 &(manualroute)& router is usually used on a mail hub to route incoming messages
19386 to the correct hosts. For a small number of domains, the routing can be inline,
19387 using the &%route_list%& option, but for a larger number a file or database
19388 lookup is easier to manage.
19389
19390 If the domain names are in fact the names of the machines to which the mail is
19391 to be sent by the mail hub, the configuration can be quite simple. For
19392 example:
19393 .code
19394 hub_route:
19395   driver = manualroute
19396   transport = remote_smtp
19397   route_list = *.rhodes.tvs.example  $domain
19398 .endd
19399 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19400 whose names are the same as the mail domains. A similar approach can be taken
19401 if the host name can be obtained from the domain name by a string manipulation
19402 that the expansion facilities can handle. Otherwise, a lookup based on the
19403 domain can be used to find the host:
19404 .code
19405 through_firewall:
19406   driver = manualroute
19407   transport = remote_smtp
19408   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19409 .endd
19410 The result of the lookup must be the name or IP address of the host (or
19411 hosts) to which the address is to be routed. If the lookup fails, the route
19412 data is empty, causing the router to decline. The address then passes to the
19413 next router.
19414
19415 .next
19416 .cindex "batched SMTP output example"
19417 .cindex "SMTP" "batched outgoing; example"
19418 You can use &(manualroute)& to deliver messages to pipes or files in batched
19419 SMTP format for onward transportation by some other means. This is one way of
19420 storing mail for a dial-up host when it is not connected. The route list entry
19421 can be as simple as a single domain name in a configuration like this:
19422 .code
19423 save_in_file:
19424   driver = manualroute
19425   transport = batchsmtp_appendfile
19426   route_list = saved.domain.example
19427 .endd
19428 though often a pattern is used to pick up more than one domain. If there are
19429 several domains or groups of domains with different transport requirements,
19430 different transports can be listed in the routing information:
19431 .code
19432 save_in_file:
19433   driver = manualroute
19434   route_list = \
19435     *.saved.domain1.example  $domain  batch_appendfile; \
19436     *.saved.domain2.example  \
19437       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19438       batch_pipe
19439 .endd
19440 .vindex "&$domain$&"
19441 .vindex "&$host$&"
19442 The first of these just passes the domain in the &$host$& variable, which
19443 doesn't achieve much (since it is also in &$domain$&), but the second does a
19444 file lookup to find a value to pass, causing the router to decline to handle
19445 the address if the lookup fails.
19446
19447 .next
19448 .cindex "UUCP" "example of router for"
19449 Routing mail directly to UUCP software is a specific case of the use of
19450 &(manualroute)& in a gateway to another mail environment. This is an example of
19451 one way it can be done:
19452 .code
19453 # Transport
19454 uucp:
19455   driver = pipe
19456   user = nobody
19457   command = /usr/local/bin/uux -r - \
19458     ${substr_-5:$host}!rmail ${local_part}
19459   return_fail_output = true
19460
19461 # Router
19462 uucphost:
19463   transport = uucp
19464   driver = manualroute
19465   route_data = \
19466     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19467 .endd
19468 The file &_/usr/local/exim/uucphosts_& contains entries like
19469 .code
19470 darksite.ethereal.example:           darksite.UUCP
19471 .endd
19472 It can be set up more simply without adding and removing &".UUCP"& but this way
19473 makes clear the distinction between the domain name
19474 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19475 .endlist
19476 .ecindex IIDmanrou1
19477 .ecindex IIDmanrou2
19478
19479
19480
19481
19482
19483
19484
19485
19486 . ////////////////////////////////////////////////////////////////////////////
19487 . ////////////////////////////////////////////////////////////////////////////
19488
19489 .chapter "The queryprogram router" "CHAPdriverlast"
19490 .scindex IIDquerou1 "&(queryprogram)& router"
19491 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19492 .cindex "routing" "by external program"
19493 The &(queryprogram)& router routes an address by running an external command
19494 and acting on its output. This is an expensive way to route, and is intended
19495 mainly for use in lightly-loaded systems, or for performing experiments.
19496 However, if it is possible to use the precondition options (&%domains%&,
19497 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19498 be used in special cases, even on a busy host. There are the following private
19499 options:
19500 .cindex "options" "&(queryprogram)& router"
19501
19502 .option command queryprogram string&!! unset
19503 This option must be set. It specifies the command that is to be run. The
19504 command is split up into a command name and arguments, and then each is
19505 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19506 &<<CHAPpipetransport>>&).
19507
19508
19509 .option command_group queryprogram string unset
19510 .cindex "gid (group id)" "in &(queryprogram)& router"
19511 This option specifies a gid to be set when running the command while routing an
19512 address for deliver. It must be set if &%command_user%& specifies a numerical
19513 uid. If it begins with a digit, it is interpreted as the numerical value of the
19514 gid. Otherwise it is looked up using &[getgrnam()]&.
19515
19516
19517 .option command_user queryprogram string unset
19518 .cindex "uid (user id)" "for &(queryprogram)&"
19519 This option must be set. It specifies the uid which is set when running the
19520 command while routing an address for delivery. If the value begins with a digit,
19521 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19522 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19523 not set, a value for the gid also.
19524
19525 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19526 root, which it does during a normal delivery in a conventional configuration.
19527 However, when an address is being verified during message reception, Exim is
19528 usually running as the Exim user, not as root. If the &(queryprogram)& router
19529 is called from a non-root process, Exim cannot change uid or gid before running
19530 the command. In this circumstance the command runs under the current uid and
19531 gid.
19532
19533
19534 .option current_directory queryprogram string /
19535 This option specifies an absolute path which is made the current directory
19536 before running the command.
19537
19538
19539 .option timeout queryprogram time 1h
19540 If the command does not complete within the timeout period, its process group
19541 is killed and the message is frozen. A value of zero time specifies no
19542 timeout.
19543
19544
19545 The standard output of the command is connected to a pipe, which is read when
19546 the command terminates. It should consist of a single line of output,
19547 containing up to five fields, separated by white space. The maximum length of
19548 the line is 1023 characters. Longer lines are silently truncated. The first
19549 field is one of the following words (case-insensitive):
19550
19551 .ilist
19552 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19553 below).
19554 .next
19555 &'Decline'&: the router declines; pass the address to the next router, unless
19556 &%no_more%& is set.
19557 .next
19558 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19559 subsequent text on the line is an error message. If the router is run as part
19560 of address verification during an incoming SMTP message, the message is
19561 included in the SMTP response.
19562 .next
19563 &'Defer'&: routing could not be completed at this time; try again later. Any
19564 subsequent text on the line is an error message which is logged. It is not
19565 included in any SMTP response.
19566 .next
19567 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19568 .next
19569 &'Pass'&: pass the address to the next router (or the router specified by
19570 &%pass_router%&), overriding &%no_more%&.
19571 .next
19572 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19573 new addresses, which are routed independently, starting with the first router,
19574 or the router specified by &%redirect_router%&, if set.
19575 .endlist
19576
19577 When the first word is &'accept'&, the remainder of the line consists of a
19578 number of keyed data values, as follows (split into two lines here, to fit on
19579 the page):
19580 .code
19581 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19582 LOOKUP=byname|bydns DATA=<text>
19583 .endd
19584 The data items can be given in any order, and all are optional. If no transport
19585 is included, the transport specified by the generic &%transport%& option is
19586 used. The list of hosts and the lookup type are needed only if the transport is
19587 an &(smtp)& transport that does not itself supply a list of hosts.
19588
19589 The format of the list of hosts is the same as for the &(manualroute)& router.
19590 As well as host names and IP addresses with optional port numbers, as described
19591 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19592 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19593 (see section &<<SECThostshowused>>&).
19594
19595 If the lookup type is not specified, Exim behaves as follows when trying to
19596 find an IP address for each host: First, a DNS lookup is done. If this yields
19597 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19598 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19599 result of the lookup is the result of that call.
19600
19601 .vindex "&$address_data$&"
19602 If the DATA field is set, its value is placed in the &$address_data$&
19603 variable. For example, this return line
19604 .code
19605 accept hosts=x1.y.example:x2.y.example data="rule1"
19606 .endd
19607 routes the address to the default transport, passing a list of two hosts. When
19608 the transport runs, the string &"rule1"& is in &$address_data$&.
19609 .ecindex IIDquerou1
19610 .ecindex IIDquerou2
19611
19612
19613
19614
19615 . ////////////////////////////////////////////////////////////////////////////
19616 . ////////////////////////////////////////////////////////////////////////////
19617
19618 .chapter "The redirect router" "CHAPredirect"
19619 .scindex IIDredrou1 "&(redirect)& router"
19620 .scindex IIDredrou2 "routers" "&(redirect)&"
19621 .cindex "alias file" "in a &(redirect)& router"
19622 .cindex "address redirection" "&(redirect)& router"
19623 The &(redirect)& router handles several kinds of address redirection. Its most
19624 common uses are for resolving local part aliases from a central alias file
19625 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19626 files, but it has many other potential uses. The incoming address can be
19627 redirected in several different ways:
19628
19629 .ilist
19630 It can be replaced by one or more new addresses which are themselves routed
19631 independently.
19632 .next
19633 It can be routed to be delivered to a given file or directory.
19634 .next
19635 It can be routed to be delivered to a specified pipe command.
19636 .next
19637 It can cause an automatic reply to be generated.
19638 .next
19639 It can be forced to fail, optionally with a custom error message.
19640 .next
19641 It can be temporarily deferred, optionally with a custom message.
19642 .next
19643 It can be discarded.
19644 .endlist
19645
19646 The generic &%transport%& option must not be set for &(redirect)& routers.
19647 However, there are some private options which define transports for delivery to
19648 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19649 &%pipe_transport%& and &%reply_transport%& descriptions below.
19650
19651 If success DSNs have been requested
19652 .cindex "DSN" "success"
19653 .cindex "Delivery Status Notification" "success"
19654 redirection triggers one and the DSN options are not passed any further.
19655
19656
19657
19658 .section "Redirection data" "SECID124"
19659 The router operates by interpreting a text string which it obtains either by
19660 expanding the contents of the &%data%& option, or by reading the entire
19661 contents of a file whose name is given in the &%file%& option. These two
19662 options are mutually exclusive. The first is commonly used for handling system
19663 aliases, in a configuration like this:
19664 .code
19665 system_aliases:
19666   driver = redirect
19667   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19668 .endd
19669 If the lookup fails, the expanded string in this example is empty. When the
19670 expansion of &%data%& results in an empty string, the router declines. A forced
19671 expansion failure also causes the router to decline; other expansion failures
19672 cause delivery to be deferred.
19673
19674 A configuration using &%file%& is commonly used for handling users'
19675 &_.forward_& files, like this:
19676 .code
19677 userforward:
19678   driver = redirect
19679   check_local_user
19680   file = $home/.forward
19681   no_verify
19682 .endd
19683 If the file does not exist, or causes no action to be taken (for example, it is
19684 empty or consists only of comments), the router declines. &*Warning*&: This
19685 is not the case when the file contains syntactically valid items that happen to
19686 yield empty addresses, for example, items containing only RFC 2822 address
19687 comments.
19688
19689
19690
19691 .section "Forward files and address verification" "SECID125"
19692 .cindex "address redirection" "while verifying"
19693 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19694 &_.forward_& files, as in the example above. There are two reasons for this:
19695
19696 .ilist
19697 When Exim is receiving an incoming SMTP message from a remote host, it is
19698 running under the Exim uid, not as root. Exim is unable to change uid to read
19699 the file as the user, and it may not be able to read it as the Exim user. So in
19700 practice the router may not be able to operate.
19701 .next
19702 However, even when the router can operate, the existence of a &_.forward_& file
19703 is unimportant when verifying an address. What should be checked is whether the
19704 local part is a valid user name or not. Cutting out the redirection processing
19705 saves some resources.
19706 .endlist
19707
19708
19709
19710
19711
19712
19713 .section "Interpreting redirection data" "SECID126"
19714 .cindex "Sieve filter" "specifying in redirection data"
19715 .cindex "filter" "specifying in redirection data"
19716 The contents of the data string, whether obtained from &%data%& or &%file%&,
19717 can be interpreted in two different ways:
19718
19719 .ilist
19720 If the &%allow_filter%& option is set true, and the data begins with the text
19721 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19722 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19723 respectively. Details of the syntax and semantics of filter files are described
19724 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19725 document is intended for use by end users.
19726 .next
19727 Otherwise, the data must be a comma-separated list of redirection items, as
19728 described in the next section.
19729 .endlist
19730
19731 When a message is redirected to a file (a &"mail folder"&), the file name given
19732 in a non-filter redirection list must always be an absolute path. A filter may
19733 generate a relative path &-- how this is handled depends on the transport's
19734 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19735 for the &(appendfile)& transport.
19736
19737
19738
19739 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19740 .cindex "address redirection" "non-filter list items"
19741 When the redirection data is not an Exim or Sieve filter, for example, if it
19742 comes from a conventional alias or forward file, it consists of a list of
19743 addresses, file names, pipe commands, or certain special items (see section
19744 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19745 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19746 depending on their default values. The items in the list are separated by
19747 commas or newlines.
19748 If a comma is required in an item, the entire item must be enclosed in double
19749 quotes.
19750
19751 Lines starting with a # character are comments, and are ignored, and # may
19752 also appear following a comma, in which case everything between the # and the
19753 next newline character is ignored.
19754
19755 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19756 double quotes are retained because some forms of mail address require their use
19757 (but never to enclose the entire address). In the following description,
19758 &"item"& refers to what remains after any surrounding double quotes have been
19759 removed.
19760
19761 .vindex "&$local_part$&"
19762 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19763 and the expansion contains a reference to &$local_part$&, you should make use
19764 of the &%quote_local_part%& expansion operator, in case the local part contains
19765 special characters. For example, to redirect all mail for the domain
19766 &'obsolete.example'&, retaining the existing local part, you could use this
19767 setting:
19768 .code
19769 data = ${quote_local_part:$local_part}@newdomain.example
19770 .endd
19771
19772
19773 .section "Redirecting to a local mailbox" "SECTredlocmai"
19774 .cindex "routing" "loops in"
19775 .cindex "loop" "while routing, avoidance of"
19776 .cindex "address redirection" "to local mailbox"
19777 A redirection item may safely be the same as the address currently under
19778 consideration. This does not cause a routing loop, because a router is
19779 automatically skipped if any ancestor of the address that is being processed
19780 is the same as the current address and was processed by the current router.
19781 Such an address is therefore passed to the following routers, so it is handled
19782 as if there were no redirection. When making this loop-avoidance test, the
19783 complete local part, including any prefix or suffix, is used.
19784
19785 .cindex "address redirection" "local part without domain"
19786 Specifying the same local part without a domain is a common usage in personal
19787 filter files when the user wants to have messages delivered to the local
19788 mailbox and also forwarded elsewhere. For example, the user whose login is
19789 &'cleo'& might have a &_.forward_& file containing this:
19790 .code
19791 cleo, cleopatra@egypt.example
19792 .endd
19793 .cindex "backslash in alias file"
19794 .cindex "alias file" "backslash in"
19795 For compatibility with other MTAs, such unqualified local parts may be
19796 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19797 it does make a difference if more than one domain is being handled
19798 synonymously.
19799
19800 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19801 2822 address that does not include a domain, the item is qualified using the
19802 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19803 addresses are qualified using the value in &%qualify_recipient%&, but you can
19804 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19805
19806 Care must be taken if there are alias names for local users.
19807 Consider an MTA handling a single local domain where the system alias file
19808 contains:
19809 .code
19810 Sam.Reman: spqr
19811 .endd
19812 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19813 messages in the local mailbox, and also forward copies elsewhere. He creates
19814 this forward file:
19815 .code
19816 Sam.Reman, spqr@reme.elsewhere.example
19817 .endd
19818 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19819 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19820 second time round, because it has previously routed it,
19821 and the following routers presumably cannot handle the alias. The forward file
19822 should really contain
19823 .code
19824 spqr, spqr@reme.elsewhere.example
19825 .endd
19826 but because this is such a common error, the &%check_ancestor%& option (see
19827 below) exists to provide a way to get round it. This is normally set on a
19828 &(redirect)& router that is handling users' &_.forward_& files.
19829
19830
19831
19832 .section "Special items in redirection lists" "SECTspecitredli"
19833 In addition to addresses, the following types of item may appear in redirection
19834 lists (that is, in non-filter redirection data):
19835
19836 .ilist
19837 .cindex "pipe" "in redirection list"
19838 .cindex "address redirection" "to pipe"
19839 An item is treated as a pipe command if it begins with &"|"& and does not parse
19840 as a valid RFC 2822 address that includes a domain. A transport for running the
19841 command must be specified by the &%pipe_transport%& option.
19842 Normally, either the router or the transport specifies a user and a group under
19843 which to run the delivery. The default is to use the Exim user and group.
19844
19845 Single or double quotes can be used for enclosing the individual arguments of
19846 the pipe command; no interpretation of escapes is done for single quotes. If
19847 the command contains a comma character, it is necessary to put the whole item
19848 in double quotes, for example:
19849 .code
19850 "|/some/command ready,steady,go"
19851 .endd
19852 since items in redirection lists are terminated by commas. Do not, however,
19853 quote just the command. An item such as
19854 .code
19855 |"/some/command ready,steady,go"
19856 .endd
19857 is interpreted as a pipe with a rather strange command name, and no arguments.
19858
19859 Note that the above example assumes that the text comes from a lookup source
19860 of some sort, so that the quotes are part of the data.  If composing a
19861 redirect router with a &%data%& option directly specifying this command, the
19862 quotes will be used by the configuration parser to define the extent of one
19863 string, but will not be passed down into the redirect router itself.  There
19864 are two main approaches to get around this: escape quotes to be part of the
19865 data itself, or avoid using this mechanism and instead create a custom
19866 transport with the &%command%& option set and reference that transport from
19867 an &%accept%& router.
19868
19869 .next
19870 .cindex "file" "in redirection list"
19871 .cindex "address redirection" "to file"
19872 An item is interpreted as a path name if it begins with &"/"& and does not
19873 parse as a valid RFC 2822 address that includes a domain. For example,
19874 .code
19875 /home/world/minbari
19876 .endd
19877 is treated as a file name, but
19878 .code
19879 /s=molari/o=babylon/@x400gate.way
19880 .endd
19881 is treated as an address. For a file name, a transport must be specified using
19882 the &%file_transport%& option. However, if the generated path name ends with a
19883 forward slash character, it is interpreted as a directory name rather than a
19884 file name, and &%directory_transport%& is used instead.
19885
19886 Normally, either the router or the transport specifies a user and a group under
19887 which to run the delivery. The default is to use the Exim user and group.
19888
19889 .cindex "&_/dev/null_&"
19890 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19891 bypassed at a high level, and the log entry shows &"**bypassed**"&
19892 instead of a transport name. In this case the user and group are not used.
19893
19894 .next
19895 .cindex "included address list"
19896 .cindex "address redirection" "included external list"
19897 If an item is of the form
19898 .code
19899 :include:<path name>
19900 .endd
19901 a list of further items is taken from the given file and included at that
19902 point. &*Note*&: Such a file can not be a filter file; it is just an
19903 out-of-line addition to the list. The items in the included list are separated
19904 by commas or newlines and are not subject to expansion. If this is the first
19905 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19906 the alias name. This example is incorrect:
19907 .code
19908 list1    :include:/opt/lists/list1
19909 .endd
19910 It must be given as
19911 .code
19912 list1:   :include:/opt/lists/list1
19913 .endd
19914 .next
19915 .cindex "address redirection" "to black hole"
19916 .cindex "delivery" "discard"
19917 .cindex "delivery" "blackhole"
19918 .cindex "black hole"
19919 .cindex "abandoning mail"
19920 Sometimes you want to throw away mail to a particular local part.  Making the
19921 &%data%& option expand to an empty string does not work, because that causes
19922 the router to decline. Instead, the alias item
19923 .code
19924 :blackhole:
19925 .endd
19926 can be used. It does what its name implies. No delivery is
19927 done, and no error message is generated. This has the same effect as specifying
19928 &_/dev/null_& as a destination, but it can be independently disabled.
19929
19930 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19931 delivery is done for the original local part, even if other redirection items
19932 are present. If you are generating a multi-item list (for example, by reading a
19933 database) and need the ability to provide a no-op item, you must use
19934 &_/dev/null_&.
19935
19936 .next
19937 .cindex "delivery" "forcing failure"
19938 .cindex "delivery" "forcing deferral"
19939 .cindex "failing delivery" "forcing"
19940 .cindex "deferred delivery, forcing"
19941 .cindex "customizing" "failure message"
19942 An attempt to deliver a particular address can be deferred or forced to fail by
19943 redirection items of the form
19944 .code
19945 :defer:
19946 :fail:
19947 .endd
19948 respectively. When a redirection list contains such an item, it applies
19949 to the entire redirection; any other items in the list are ignored. Any
19950 text following &':fail:'& or &':defer:'& is placed in the error text
19951 associated with the failure. For example, an alias file might contain:
19952 .code
19953 X.Employee:  :fail: Gone away, no forwarding address
19954 .endd
19955 In the case of an address that is being verified from an ACL or as the subject
19956 of a
19957 .cindex "VRFY" "error text, display of"
19958 VRFY command, the text is included in the SMTP error response by
19959 default.
19960 .cindex "EXPN" "error text, display of"
19961 The text is not included in the response to an EXPN command. In non-SMTP cases
19962 the text is included in the error message that Exim generates.
19963
19964 .cindex "SMTP" "error codes"
19965 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19966 &':fail:'&. However, if the message starts with three digits followed by a
19967 space, optionally followed by an extended code of the form &'n.n.n'&, also
19968 followed by a space, and the very first digit is the same as the default error
19969 code, the code from the message is used instead. If the very first digit is
19970 incorrect, a panic error is logged, and the default code is used. You can
19971 suppress the use of the supplied code in a redirect router by setting the
19972 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19973 ignored.
19974
19975 .vindex "&$acl_verify_message$&"
19976 In an ACL, an explicitly provided message overrides the default, but the
19977 default message is available in the variable &$acl_verify_message$& and can
19978 therefore be included in a custom message if this is desired.
19979
19980 Normally the error text is the rest of the redirection list &-- a comma does
19981 not terminate it &-- but a newline does act as a terminator. Newlines are not
19982 normally present in alias expansions. In &(lsearch)& lookups they are removed
19983 as part of the continuation process, but they may exist in other kinds of
19984 lookup and in &':include:'& files.
19985
19986 During routing for message delivery (as opposed to verification), a redirection
19987 containing &':fail:'& causes an immediate failure of the incoming address,
19988 whereas &':defer:'& causes the message to remain on the queue so that a
19989 subsequent delivery attempt can happen at a later time. If an address is
19990 deferred for too long, it will ultimately fail, because the normal retry
19991 rules still apply.
19992
19993 .next
19994 .cindex "alias file" "exception to default"
19995 Sometimes it is useful to use a single-key search type with a default (see
19996 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19997 for exceptions to the default. These can be handled by aliasing them to
19998 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19999 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20000 results in an empty redirection list has the same effect.
20001 .endlist
20002
20003
20004 .section "Duplicate addresses" "SECTdupaddr"
20005 .cindex "duplicate addresses"
20006 .cindex "address duplicate, discarding"
20007 .cindex "pipe" "duplicated"
20008 Exim removes duplicate addresses from the list to which it is delivering, so as
20009 to deliver just one copy to each address. This does not apply to deliveries
20010 routed to pipes by different immediate parent addresses, but an indirect
20011 aliasing scheme of the type
20012 .code
20013 pipe:       |/some/command $local_part
20014 localpart1: pipe
20015 localpart2: pipe
20016 .endd
20017 does not work with a message that is addressed to both local parts, because
20018 when the second is aliased to the intermediate local part &"pipe"& it gets
20019 discarded as being the same as a previously handled address. However, a scheme
20020 such as
20021 .code
20022 localpart1: |/some/command $local_part
20023 localpart2: |/some/command $local_part
20024 .endd
20025 does result in two different pipe deliveries, because the immediate parents of
20026 the pipes are distinct.
20027
20028
20029
20030 .section "Repeated redirection expansion" "SECID128"
20031 .cindex "repeated redirection expansion"
20032 .cindex "address redirection" "repeated for each delivery attempt"
20033 When a message cannot be delivered to all of its recipients immediately,
20034 leading to two or more delivery attempts, redirection expansion is carried out
20035 afresh each time for those addresses whose children were not all previously
20036 delivered. If redirection is being used as a mailing list, this can lead to new
20037 members of the list receiving copies of old messages. The &%one_time%& option
20038 can be used to avoid this.
20039
20040
20041 .section "Errors in redirection lists" "SECID129"
20042 .cindex "address redirection" "errors"
20043 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20044 error is skipped, and an entry is written to the main log. This may be useful
20045 for mailing lists that are automatically managed. Otherwise, if an error is
20046 detected while generating the list of new addresses, the original address is
20047 deferred. See also &%syntax_errors_to%&.
20048
20049
20050
20051 .section "Private options for the redirect router" "SECID130"
20052
20053 .cindex "options" "&(redirect)& router"
20054 The private options for the &(redirect)& router are as follows:
20055
20056
20057 .option allow_defer redirect boolean false
20058 Setting this option allows the use of &':defer:'& in non-filter redirection
20059 data, or the &%defer%& command in an Exim filter file.
20060
20061
20062 .option allow_fail redirect boolean false
20063 .cindex "failing delivery" "from filter"
20064 If this option is true, the &':fail:'& item can be used in a redirection list,
20065 and the &%fail%& command may be used in an Exim filter file.
20066
20067
20068 .option allow_filter redirect boolean false
20069 .cindex "filter" "enabling use of"
20070 .cindex "Sieve filter" "enabling use of"
20071 Setting this option allows Exim to interpret redirection data that starts with
20072 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20073 are some features of Exim filter files that some administrators may wish to
20074 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20075
20076 It is also possible to lock out Exim filters or Sieve filters while allowing
20077 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20078
20079
20080 The filter is run using the uid and gid set by the generic &%user%& and
20081 &%group%& options. These take their defaults from the password data if
20082 &%check_local_user%& is set, so in the normal case of users' personal filter
20083 files, the filter is run as the relevant user. When &%allow_filter%& is set
20084 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20085
20086
20087
20088 .option allow_freeze redirect boolean false
20089 .cindex "freezing messages" "allowing in filter"
20090 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20091 This command is more normally encountered in system filters, and is disabled by
20092 default for redirection filters because it isn't something you usually want to
20093 let ordinary users do.
20094
20095
20096
20097 .option check_ancestor redirect boolean false
20098 This option is concerned with handling generated addresses that are the same
20099 as some address in the list of redirection ancestors of the current address.
20100 Although it is turned off by default in the code, it is set in the default
20101 configuration file for handling users' &_.forward_& files. It is recommended
20102 for this use of the &(redirect)& router.
20103
20104 When &%check_ancestor%& is set, if a generated address (including the domain)
20105 is the same as any ancestor of the current address, it is replaced by a copy of
20106 the current address. This helps in the case where local part A is aliased to B,
20107 and B has a &_.forward_& file pointing back to A. For example, within a single
20108 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20109 &_&~jb/.forward_& contains:
20110 .code
20111 \Joe.Bloggs, <other item(s)>
20112 .endd
20113 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20114 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20115 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20116 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20117 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20118 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20119 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20120 original address. See also the &%repeat_use%& option below.
20121
20122
20123 .option check_group redirect boolean "see below"
20124 When the &%file%& option is used, the group owner of the file is checked only
20125 when this option is set. The permitted groups are those listed in the
20126 &%owngroups%& option, together with the user's default group if
20127 &%check_local_user%& is set. If the file has the wrong group, routing is
20128 deferred. The default setting for this option is true if &%check_local_user%&
20129 is set and the &%modemask%& option permits the group write bit, or if the
20130 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20131
20132
20133
20134 .option check_owner redirect boolean "see below"
20135 When the &%file%& option is used, the owner of the file is checked only when
20136 this option is set. If &%check_local_user%& is set, the local user is
20137 permitted; otherwise the owner must be one of those listed in the &%owners%&
20138 option. The default value for this option is true if &%check_local_user%& or
20139 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20140
20141
20142 .option data redirect string&!! unset
20143 This option is mutually exclusive with &%file%&. One or other of them must be
20144 set, but not both. The contents of &%data%& are expanded, and then used as the
20145 list of forwarding items, or as a set of filtering instructions. If the
20146 expansion is forced to fail, or the result is an empty string or a string that
20147 has no effect (consists entirely of comments), the router declines.
20148
20149 When filtering instructions are used, the string must begin with &"#Exim
20150 filter"&, and all comments in the string, including this initial one, must be
20151 terminated with newline characters. For example:
20152 .code
20153 data = #Exim filter\n\
20154        if $h_to: contains Exim then save $home/mail/exim endif
20155 .endd
20156 If you are reading the data from a database where newlines cannot be included,
20157 you can use the &${sg}$& expansion item to turn the escape string of your
20158 choice into a newline.
20159
20160
20161 .option directory_transport redirect string&!! unset
20162 A &(redirect)& router sets up a direct delivery to a directory when a path name
20163 ending with a slash is specified as a new &"address"&. The transport used is
20164 specified by this option, which, after expansion, must be the name of a
20165 configured transport. This should normally be an &(appendfile)& transport.
20166
20167
20168 .option file redirect string&!! unset
20169 This option specifies the name of a file that contains the redirection data. It
20170 is mutually exclusive with the &%data%& option. The string is expanded before
20171 use; if the expansion is forced to fail, the router declines. Other expansion
20172 failures cause delivery to be deferred. The result of a successful expansion
20173 must be an absolute path. The entire file is read and used as the redirection
20174 data. If the data is an empty string or a string that has no effect (consists
20175 entirely of comments), the router declines.
20176
20177 .cindex "NFS" "checking for file existence"
20178 If the attempt to open the file fails with a &"does not exist"& error, Exim
20179 runs a check on the containing directory,
20180 unless &%ignore_enotdir%& is true (see below).
20181 If the directory does not appear to exist, delivery is deferred. This can
20182 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20183 is a mount problem. If the containing directory does exist, but the file does
20184 not, the router declines.
20185
20186
20187 .option file_transport redirect string&!! unset
20188 .vindex "&$address_file$&"
20189 A &(redirect)& router sets up a direct delivery to a file when a path name not
20190 ending in a slash is specified as a new &"address"&. The transport used is
20191 specified by this option, which, after expansion, must be the name of a
20192 configured transport. This should normally be an &(appendfile)& transport. When
20193 it is running, the file name is in &$address_file$&.
20194
20195
20196 .option filter_prepend_home redirect boolean true
20197 When this option is true, if a &(save)& command in an Exim filter specifies a
20198 relative path, and &$home$& is defined, it is automatically prepended to the
20199 relative path. If this option is set false, this action does not happen. The
20200 relative path is then passed to the transport unmodified.
20201
20202
20203 .option forbid_blackhole redirect boolean false
20204 If this option is true, the &':blackhole:'& item may not appear in a
20205 redirection list.
20206
20207
20208 .option forbid_exim_filter redirect boolean false
20209 If this option is set true, only Sieve filters are permitted when
20210 &%allow_filter%& is true.
20211
20212
20213
20214
20215 .option forbid_file redirect boolean false
20216 .cindex "delivery" "to file; forbidding"
20217 .cindex "Sieve filter" "forbidding delivery to a file"
20218 .cindex "Sieve filter" "&""keep""& facility; disabling"
20219 If this option is true, this router may not generate a new address that
20220 specifies delivery to a local file or directory, either from a filter or from a
20221 conventional forward file. This option is forced to be true if &%one_time%& is
20222 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20223 locks out the Sieve's &"keep"& facility.
20224
20225
20226 .option forbid_filter_dlfunc redirect boolean false
20227 .cindex "filter" "locking out certain features"
20228 If this option is true, string expansions in Exim filters are not allowed to
20229 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20230 functions.
20231
20232 .option forbid_filter_existstest redirect boolean false
20233 .cindex "expansion" "statting a file"
20234 If this option is true, string expansions in Exim filters are not allowed to
20235 make use of the &%exists%& condition or the &%stat%& expansion item.
20236
20237 .option forbid_filter_logwrite redirect boolean false
20238 If this option is true, use of the logging facility in Exim filters is not
20239 permitted. Logging is in any case available only if the filter is being run
20240 under some unprivileged uid (which is normally the case for ordinary users'
20241 &_.forward_& files).
20242
20243
20244 .option forbid_filter_lookup redirect boolean false
20245 If this option is true, string expansions in Exim filter files are not allowed
20246 to make use of &%lookup%& items.
20247
20248
20249 .option forbid_filter_perl redirect boolean false
20250 This option has an effect only if Exim is built with embedded Perl support. If
20251 it is true, string expansions in Exim filter files are not allowed to make use
20252 of the embedded Perl support.
20253
20254
20255 .option forbid_filter_readfile redirect boolean false
20256 If this option is true, string expansions in Exim filter files are not allowed
20257 to make use of &%readfile%& items.
20258
20259
20260 .option forbid_filter_readsocket redirect boolean false
20261 If this option is true, string expansions in Exim filter files are not allowed
20262 to make use of &%readsocket%& items.
20263
20264
20265 .option forbid_filter_reply redirect boolean false
20266 If this option is true, this router may not generate an automatic reply
20267 message. Automatic replies can be generated only from Exim or Sieve filter
20268 files, not from traditional forward files. This option is forced to be true if
20269 &%one_time%& is set.
20270
20271
20272 .option forbid_filter_run redirect boolean false
20273 If this option is true, string expansions in Exim filter files are not allowed
20274 to make use of &%run%& items.
20275
20276
20277 .option forbid_include redirect boolean false
20278 If this option is true, items of the form
20279 .code
20280 :include:<path name>
20281 .endd
20282 are not permitted in non-filter redirection lists.
20283
20284
20285 .option forbid_pipe redirect boolean false
20286 .cindex "delivery" "to pipe; forbidding"
20287 If this option is true, this router may not generate a new address which
20288 specifies delivery to a pipe, either from an Exim filter or from a conventional
20289 forward file. This option is forced to be true if &%one_time%& is set.
20290
20291
20292 .option forbid_sieve_filter redirect boolean false
20293 If this option is set true, only Exim filters are permitted when
20294 &%allow_filter%& is true.
20295
20296
20297 .cindex "SMTP" "error codes"
20298 .option forbid_smtp_code redirect boolean false
20299 If this option is set true, any SMTP error codes that are present at the start
20300 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20301 the default codes (451 and 550, respectively) are always used.
20302
20303
20304
20305
20306 .option hide_child_in_errmsg redirect boolean false
20307 .cindex "bounce message" "redirection details; suppressing"
20308 If this option is true, it prevents Exim from quoting a child address if it
20309 generates a bounce or delay message for it. Instead it says &"an address
20310 generated from <&'the top level address'&>"&. Of course, this applies only to
20311 bounces generated locally. If a message is forwarded to another host, &'its'&
20312 bounce may well quote the generated address.
20313
20314
20315 .option ignore_eacces redirect boolean false
20316 .cindex "EACCES"
20317 If this option is set and an attempt to open a redirection file yields the
20318 EACCES error (permission denied), the &(redirect)& router behaves as if the
20319 file did not exist.
20320
20321
20322 .option ignore_enotdir redirect boolean false
20323 .cindex "ENOTDIR"
20324 If this option is set and an attempt to open a redirection file yields the
20325 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20326 router behaves as if the file did not exist.
20327
20328 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20329 router that has the &%file%& option set discovers that the file does not exist
20330 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20331 against unmounted NFS directories. If the parent can not be statted, delivery
20332 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20333 is set, because that option tells Exim to ignore &"something on the path is not
20334 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20335 that some operating systems give ENOENT where others give ENOTDIR.
20336
20337
20338
20339 .option include_directory redirect string unset
20340 If this option is set, the path names of any &':include:'& items in a
20341 redirection list must start with this directory.
20342
20343
20344 .option modemask redirect "octal integer" 022
20345 This specifies mode bits which must not be set for a file specified by the
20346 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20347
20348
20349 .option one_time redirect boolean false
20350 .cindex "one-time aliasing/forwarding expansion"
20351 .cindex "alias file" "one-time expansion"
20352 .cindex "forward file" "one-time expansion"
20353 .cindex "mailing lists" "one-time expansion"
20354 .cindex "address redirection" "one-time expansion"
20355 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20356 files each time it tries to deliver a message causes a problem when one or more
20357 of the generated addresses fails be delivered at the first attempt. The problem
20358 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20359 but of what happens when the redirection list changes during the time that the
20360 message is on Exim's queue. This is particularly true in the case of mailing
20361 lists, where new subscribers might receive copies of messages that were posted
20362 before they subscribed.
20363
20364 If &%one_time%& is set and any addresses generated by the router fail to
20365 deliver at the first attempt, the failing addresses are added to the message as
20366 &"top level"& addresses, and the parent address that generated them is marked
20367 &"delivered"&. Thus, redirection does not happen again at the next delivery
20368 attempt.
20369
20370 &*Warning 1*&: Any header line addition or removal that is specified by this
20371 router would be lost if delivery did not succeed at the first attempt. For this
20372 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20373 permitted when &%one_time%& is set.
20374
20375 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20376 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20377 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20378
20379 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20380 &%one_time%&.
20381
20382 The original top-level address is remembered with each of the generated
20383 addresses, and is output in any log messages. However, any intermediate parent
20384 addresses are not recorded. This makes a difference to the log only if
20385 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20386 typically be used for mailing lists, where there is normally just one level of
20387 expansion.
20388
20389
20390 .option owners redirect "string list" unset
20391 .cindex "ownership" "alias file"
20392 .cindex "ownership" "forward file"
20393 .cindex "alias file" "ownership"
20394 .cindex "forward file" "ownership"
20395 This specifies a list of permitted owners for the file specified by &%file%&.
20396 This list is in addition to the local user when &%check_local_user%& is set.
20397 See &%check_owner%& above.
20398
20399
20400 .option owngroups redirect "string list" unset
20401 This specifies a list of permitted groups for the file specified by &%file%&.
20402 The list is in addition to the local user's primary group when
20403 &%check_local_user%& is set. See &%check_group%& above.
20404
20405
20406 .option pipe_transport redirect string&!! unset
20407 .vindex "&$address_pipe$&"
20408 A &(redirect)& router sets up a direct delivery to a pipe when a string
20409 starting with a vertical bar character is specified as a new &"address"&. The
20410 transport used is specified by this option, which, after expansion, must be the
20411 name of a configured transport. This should normally be a &(pipe)& transport.
20412 When the transport is run, the pipe command is in &$address_pipe$&.
20413
20414
20415 .option qualify_domain redirect string&!! unset
20416 .vindex "&$qualify_recipient$&"
20417 If this option is set, and an unqualified address (one without a domain) is
20418 generated, and that address would normally be qualified by the global setting
20419 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20420 expanding this string. If the expansion fails, the router declines. If you want
20421 to revert to the default, you can have the expansion generate
20422 &$qualify_recipient$&.
20423
20424 This option applies to all unqualified addresses generated by Exim filters,
20425 but for traditional &_.forward_& files, it applies only to addresses that are
20426 not preceded by a backslash. Sieve filters cannot generate unqualified
20427 addresses.
20428
20429 .option qualify_preserve_domain redirect boolean false
20430 .cindex "domain" "in redirection; preserving"
20431 .cindex "preserving domain in redirection"
20432 .cindex "address redirection" "domain; preserving"
20433 If this option is set, the router's local &%qualify_domain%& option must not be
20434 set (a configuration error occurs if it is). If an unqualified address (one
20435 without a domain) is generated, it is qualified with the domain of the parent
20436 address (the immediately preceding ancestor) instead of the global
20437 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20438 this applies whether or not the address is preceded by a backslash.
20439
20440
20441 .option repeat_use redirect boolean true
20442 If this option is set false, the router is skipped for a child address that has
20443 any ancestor that was routed by this router. This test happens before any of
20444 the other preconditions are tested. Exim's default anti-looping rules skip
20445 only when the ancestor is the same as the current address. See also
20446 &%check_ancestor%& above and the generic &%redirect_router%& option.
20447
20448
20449 .option reply_transport redirect string&!! unset
20450 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20451 &%vacation%& command is used in a filter file. The transport used is specified
20452 by this option, which, after expansion, must be the name of a configured
20453 transport. This should normally be an &(autoreply)& transport. Other transports
20454 are unlikely to do anything sensible or useful.
20455
20456
20457 .option rewrite redirect boolean true
20458 .cindex "address redirection" "disabling rewriting"
20459 If this option is set false, addresses generated by the router are not
20460 subject to address rewriting. Otherwise, they are treated like new addresses
20461 and are rewritten according to the global rewriting rules.
20462
20463
20464 .option sieve_subaddress redirect string&!! unset
20465 The value of this option is passed to a Sieve filter to specify the
20466 :subaddress part of an address.
20467
20468 .option sieve_useraddress redirect string&!! unset
20469 The value of this option is passed to a Sieve filter to specify the :user part
20470 of an address. However, if it is unset, the entire original local part
20471 (including any prefix or suffix) is used for :user.
20472
20473
20474 .option sieve_vacation_directory redirect string&!! unset
20475 .cindex "Sieve filter" "vacation directory"
20476 To enable the &"vacation"& extension for Sieve filters, you must set
20477 &%sieve_vacation_directory%& to the directory where vacation databases are held
20478 (do not put anything else in that directory), and ensure that the
20479 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20480 needs their own directory; Exim will create it if necessary.
20481
20482
20483
20484 .option skip_syntax_errors redirect boolean false
20485 .cindex "forward file" "broken"
20486 .cindex "address redirection" "broken files"
20487 .cindex "alias file" "broken"
20488 .cindex "broken alias or forward files"
20489 .cindex "ignoring faulty addresses"
20490 .cindex "skipping faulty addresses"
20491 .cindex "error" "skipping bad syntax"
20492 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20493 non-filter redirection data are skipped, and each failing address is logged. If
20494 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20495 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20496 are expanded and placed at the head of the error message generated by
20497 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20498 be the same address as the generic &%errors_to%& option. The
20499 &%skip_syntax_errors%& option is often used when handling mailing lists.
20500
20501 If all the addresses in a redirection list are skipped because of syntax
20502 errors, the router declines to handle the original address, and it is passed to
20503 the following routers.
20504
20505 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20506 error in the filter causes filtering to be abandoned without any action being
20507 taken. The incident is logged, and the router declines to handle the address,
20508 so it is passed to the following routers.
20509
20510 .cindex "Sieve filter" "syntax errors in"
20511 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20512 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20513 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20514
20515 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20516 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20517 option, used with an address that does not get redirected, can be used to
20518 notify users of these errors, by means of a router like this:
20519 .code
20520 userforward:
20521   driver = redirect
20522   allow_filter
20523   check_local_user
20524   file = $home/.forward
20525   file_transport = address_file
20526   pipe_transport = address_pipe
20527   reply_transport = address_reply
20528   no_verify
20529   skip_syntax_errors
20530   syntax_errors_to = real-$local_part@$domain
20531   syntax_errors_text = \
20532    This is an automatically generated message. An error has\n\
20533    been found in your .forward file. Details of the error are\n\
20534    reported below. While this error persists, you will receive\n\
20535    a copy of this message for every message that is addressed\n\
20536    to you. If your .forward file is a filter file, or if it is\n\
20537    a non-filter file containing no valid forwarding addresses,\n\
20538    a copy of each incoming message will be put in your normal\n\
20539    mailbox. If a non-filter file contains at least one valid\n\
20540    forwarding address, forwarding to the valid addresses will\n\
20541    happen, and those will be the only deliveries that occur.
20542 .endd
20543 You also need a router to ensure that local addresses that are prefixed by
20544 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20545 put this immediately before the &(userforward)& router:
20546 .code
20547 real_localuser:
20548   driver = accept
20549   check_local_user
20550   local_part_prefix = real-
20551   transport = local_delivery
20552 .endd
20553 For security, it would probably be a good idea to restrict the use of this
20554 router to locally-generated messages, using a condition such as this:
20555 .code
20556   condition = ${if match {$sender_host_address}\
20557                          {\N^(|127\.0\.0\.1)$\N}}
20558 .endd
20559
20560
20561 .option syntax_errors_text redirect string&!! unset
20562 See &%skip_syntax_errors%& above.
20563
20564
20565 .option syntax_errors_to redirect string unset
20566 See &%skip_syntax_errors%& above.
20567 .ecindex IIDredrou1
20568 .ecindex IIDredrou2
20569
20570
20571
20572
20573
20574
20575 . ////////////////////////////////////////////////////////////////////////////
20576 . ////////////////////////////////////////////////////////////////////////////
20577
20578 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20579          "Environment for local transports"
20580 .scindex IIDenvlotra1 "local transports" "environment for"
20581 .scindex IIDenvlotra2 "environment" "local transports"
20582 .scindex IIDenvlotra3 "transport" "local; environment for"
20583 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20584 transport can be thought of as similar to a pipe.) Exim always runs transports
20585 in subprocesses, under specified uids and gids. Typical deliveries to local
20586 mailboxes run under the uid and gid of the local user.
20587
20588 Exim also sets a specific current directory while running the transport; for
20589 some transports a home directory setting is also relevant. The &(pipe)&
20590 transport is the only one that sets up environment variables; see section
20591 &<<SECTpipeenv>>& for details.
20592
20593 The values used for the uid, gid, and the directories may come from several
20594 different places. In many cases, the router that handles the address associates
20595 settings with that address as a result of its &%check_local_user%&, &%group%&,
20596 or &%user%& options. However, values may also be given in the transport's own
20597 configuration, and these override anything that comes from the router.
20598
20599
20600
20601 .section "Concurrent deliveries" "SECID131"
20602 .cindex "concurrent deliveries"
20603 .cindex "simultaneous deliveries"
20604 If two different messages for the same local recipient arrive more or less
20605 simultaneously, the two delivery processes are likely to run concurrently. When
20606 the &(appendfile)& transport is used to write to a file, Exim applies locking
20607 rules to stop concurrent processes from writing to the same file at the same
20608 time.
20609
20610 However, when you use a &(pipe)& transport, it is up to you to arrange any
20611 locking that is needed. Here is a silly example:
20612 .code
20613 my_transport:
20614   driver = pipe
20615   command = /bin/sh -c 'cat >>/some/file'
20616 .endd
20617 This is supposed to write the message at the end of the file. However, if two
20618 messages arrive at the same time, the file will be scrambled. You can use the
20619 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20620 file using the same algorithm that Exim itself uses.
20621
20622
20623
20624
20625 .section "Uids and gids" "SECTenvuidgid"
20626 .cindex "local transports" "uid and gid"
20627 .cindex "transport" "local; uid and gid"
20628 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20629 overrides any group that the router set in the address, even if &%user%& is not
20630 set for the transport. This makes it possible, for example, to run local mail
20631 delivery under the uid of the recipient (set by the router), but in a special
20632 group (set by the transport). For example:
20633 .code
20634 # Routers ...
20635 # User/group are set by check_local_user in this router
20636 local_users:
20637   driver = accept
20638   check_local_user
20639   transport = group_delivery
20640
20641 # Transports ...
20642 # This transport overrides the group
20643 group_delivery:
20644   driver = appendfile
20645   file = /var/spool/mail/$local_part
20646   group = mail
20647 .endd
20648 If &%user%& is set for a transport, its value overrides what is set in the
20649 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20650 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20651 set.
20652
20653 .oindex "&%initgroups%&"
20654 When the uid is taken from the transport's configuration, the &[initgroups()]&
20655 function is called for the groups associated with that uid if the
20656 &%initgroups%& option is set for the transport. When the uid is not specified
20657 by the transport, but is associated with the address by a router, the option
20658 for calling &[initgroups()]& is taken from the router configuration.
20659
20660 .cindex "&(pipe)& transport" "uid for"
20661 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20662 is set and &%user%& is not set, the uid of the process that called Exim to
20663 receive the message is used, and if &%group%& is not set, the corresponding
20664 original gid is also used.
20665
20666 This is the detailed preference order for obtaining a gid; the first of the
20667 following that is set is used:
20668
20669 .ilist
20670 A &%group%& setting of the transport;
20671 .next
20672 A &%group%& setting of the router;
20673 .next
20674 A gid associated with a user setting of the router, either as a result of
20675 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20676 .next
20677 The group associated with a non-numeric &%user%& setting of the transport;
20678 .next
20679 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20680 the uid is the creator's uid;
20681 .next
20682 The Exim gid if the Exim uid is being used as a default.
20683 .endlist
20684
20685 If, for example, the user is specified numerically on the router and there are
20686 no group settings, no gid is available. In this situation, an error occurs.
20687 This is different for the uid, for which there always is an ultimate default.
20688 The first of the following that is set is used:
20689
20690 .ilist
20691 A &%user%& setting of the transport;
20692 .next
20693 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20694 .next
20695 A &%user%& setting of the router;
20696 .next
20697 A &%check_local_user%& setting of the router;
20698 .next
20699 The Exim uid.
20700 .endlist
20701
20702 Of course, an error will still occur if the uid that is chosen is on the
20703 &%never_users%& list.
20704
20705
20706
20707
20708
20709 .section "Current and home directories" "SECID132"
20710 .cindex "current directory for local transport"
20711 .cindex "home directory" "for local transport"
20712 .cindex "transport" "local; home directory for"
20713 .cindex "transport" "local; current directory for"
20714 Routers may set current and home directories for local transports by means of
20715 the &%transport_current_directory%& and &%transport_home_directory%& options.
20716 However, if the transport's &%current_directory%& or &%home_directory%& options
20717 are set, they override the router's values. In detail, the home directory
20718 for a local transport is taken from the first of these values that is set:
20719
20720 .ilist
20721 The &%home_directory%& option on the transport;
20722 .next
20723 The &%transport_home_directory%& option on the router;
20724 .next
20725 The password data if &%check_local_user%& is set on the router;
20726 .next
20727 The &%router_home_directory%& option on the router.
20728 .endlist
20729
20730 The current directory is taken from the first of these values that is set:
20731
20732 .ilist
20733 The &%current_directory%& option on the transport;
20734 .next
20735 The &%transport_current_directory%& option on the router.
20736 .endlist
20737
20738
20739 If neither the router nor the transport sets a current directory, Exim uses the
20740 value of the home directory, if it is set. Otherwise it sets the current
20741 directory to &_/_& before running a local transport.
20742
20743
20744
20745 .section "Expansion variables derived from the address" "SECID133"
20746 .vindex "&$domain$&"
20747 .vindex "&$local_part$&"
20748 .vindex "&$original_domain$&"
20749 Normally a local delivery is handling a single address, and in that case the
20750 variables such as &$domain$& and &$local_part$& are set during local
20751 deliveries. However, in some circumstances more than one address may be handled
20752 at once (for example, while writing batch SMTP for onward transmission by some
20753 other means). In this case, the variables associated with the local part are
20754 never set, &$domain$& is set only if all the addresses have the same domain,
20755 and &$original_domain$& is never set.
20756 .ecindex IIDenvlotra1
20757 .ecindex IIDenvlotra2
20758 .ecindex IIDenvlotra3
20759
20760
20761
20762
20763
20764
20765
20766 . ////////////////////////////////////////////////////////////////////////////
20767 . ////////////////////////////////////////////////////////////////////////////
20768
20769 .chapter "Generic options for transports" "CHAPtransportgeneric"
20770 .scindex IIDgenoptra1 "generic options" "transport"
20771 .scindex IIDgenoptra2 "options" "generic; for transports"
20772 .scindex IIDgenoptra3 "transport" "generic options for"
20773 The following generic options apply to all transports:
20774
20775
20776 .option body_only transports boolean false
20777 .cindex "transport" "body only"
20778 .cindex "message" "transporting body only"
20779 .cindex "body of message" "transporting"
20780 If this option is set, the message's headers are not transported. It is
20781 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20782 or &(pipe)& transports, the settings of &%message_prefix%& and
20783 &%message_suffix%& should be checked, because this option does not
20784 automatically suppress them.
20785
20786
20787 .option current_directory transports string&!! unset
20788 .cindex "transport" "current directory for"
20789 This specifies the current directory that is to be set while running the
20790 transport, overriding any value that may have been set by the router.
20791 If the expansion fails for any reason, including forced failure, an error is
20792 logged, and delivery is deferred.
20793
20794
20795 .option disable_logging transports boolean false
20796 If this option is set true, nothing is logged for any
20797 deliveries by the transport or for any
20798 transport errors. You should not set this option unless you really, really know
20799 what you are doing.
20800
20801
20802 .option debug_print transports string&!! unset
20803 .cindex "testing" "variables in drivers"
20804 If this option is set and debugging is enabled (see the &%-d%& command line
20805 option), the string is expanded and included in the debugging output when the
20806 transport is run.
20807 If expansion of the string fails, the error message is written to the debugging
20808 output, and Exim carries on processing.
20809 This facility is provided to help with checking out the values of variables and
20810 so on when debugging driver configurations. For example, if a &%headers_add%&
20811 option is not working properly, &%debug_print%& could be used to output the
20812 variables it references. A newline is added to the text if it does not end with
20813 one.
20814 The variables &$transport_name$& and &$router_name$& contain the name of the
20815 transport and the router that called it.
20816
20817 .option delivery_date_add transports boolean false
20818 .cindex "&'Delivery-date:'& header line"
20819 If this option is true, a &'Delivery-date:'& header is added to the message.
20820 This gives the actual time the delivery was made. As this is not a standard
20821 header, Exim has a configuration option (&%delivery_date_remove%&) which
20822 requests its removal from incoming messages, so that delivered messages can
20823 safely be resent to other recipients.
20824
20825
20826 .option driver transports string unset
20827 This specifies which of the available transport drivers is to be used.
20828 There is no default, and this option must be set for every transport.
20829
20830
20831 .option envelope_to_add transports boolean false
20832 .cindex "&'Envelope-to:'& header line"
20833 If this option is true, an &'Envelope-to:'& header is added to the message.
20834 This gives the original address(es) in the incoming envelope that caused this
20835 delivery to happen. More than one address may be present if the transport is
20836 configured to handle several addresses at once, or if more than one original
20837 address was redirected to the same final address. As this is not a standard
20838 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20839 its removal from incoming messages, so that delivered messages can safely be
20840 resent to other recipients.
20841
20842
20843 .option event_action transports string&!! unset
20844 .cindex events
20845 This option declares a string to be expanded for Exim's events mechanism.
20846 For details see &<<CHAPevents>>&.
20847
20848
20849 .option group transports string&!! "Exim group"
20850 .cindex "transport" "group; specifying"
20851 This option specifies a gid for running the transport process, overriding any
20852 value that the router supplies, and also overriding any value associated with
20853 &%user%& (see below).
20854
20855
20856 .option headers_add transports list&!! unset
20857 .cindex "header lines" "adding in transport"
20858 .cindex "transport" "header lines; adding"
20859 This option specifies a list of text headers,
20860 newline-separated (by default, changeable in the usual way),
20861 which are (separately) expanded and added to the header
20862 portion of a message as it is transported, as described in section
20863 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20864 routers. If the result of the expansion is an empty string, or if the expansion
20865 is forced to fail, no action is taken. Other expansion failures are treated as
20866 errors and cause the delivery to be deferred.
20867
20868 Unlike most options, &%headers_add%& can be specified multiple times
20869 for a transport; all listed headers are added.
20870
20871
20872 .option headers_only transports boolean false
20873 .cindex "transport" "header lines only"
20874 .cindex "message" "transporting headers only"
20875 .cindex "header lines" "transporting"
20876 If this option is set, the message's body is not transported. It is mutually
20877 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20878 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20879 checked, since this option does not automatically suppress them.
20880
20881
20882 .option headers_remove transports list&!! unset
20883 .cindex "header lines" "removing"
20884 .cindex "transport" "header lines; removing"
20885 This option specifies a list of header names,
20886 colon-separated (by default, changeable in the usual way);
20887 these headers are omitted from the message as it is transported, as described
20888 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20889 routers.
20890 Each list item is separately expanded.
20891 If the result of the expansion is an empty string, or if the expansion
20892 is forced to fail, no action is taken. Other expansion failures are treated as
20893 errors and cause the delivery to be deferred.
20894
20895 Unlike most options, &%headers_remove%& can be specified multiple times
20896 for a transport; all listed headers are removed.
20897
20898 &*Warning*&: Because of the separate expansion of the list items,
20899 items that contain a list separator must have it doubled.
20900 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20901
20902
20903
20904 .option headers_rewrite transports string unset
20905 .cindex "transport" "header lines; rewriting"
20906 .cindex "rewriting" "at transport time"
20907 This option allows addresses in header lines to be rewritten at transport time,
20908 that is, as the message is being copied to its destination. The contents of the
20909 option are a colon-separated list of rewriting rules. Each rule is in exactly
20910 the same form as one of the general rewriting rules that are applied when a
20911 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20912 example,
20913 .code
20914 headers_rewrite = a@b c@d f : \
20915                   x@y w@z
20916 .endd
20917 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20918 &'w@z'& in all address-bearing header lines. The rules are applied to the
20919 header lines just before they are written out at transport time, so they affect
20920 only those copies of the message that pass through the transport. However, only
20921 the message's original header lines, and any that were added by a system
20922 filter, are rewritten. If a router or transport adds header lines, they are not
20923 affected by this option. These rewriting rules are &'not'& applied to the
20924 envelope. You can change the return path using &%return_path%&, but you cannot
20925 change envelope recipients at this time.
20926
20927
20928 .option home_directory transports string&!! unset
20929 .cindex "transport" "home directory for"
20930 .vindex "&$home$&"
20931 This option specifies a home directory setting for a local transport,
20932 overriding any value that may be set by the router. The home directory is
20933 placed in &$home$& while expanding the transport's private options. It is also
20934 used as the current directory if no current directory is set by the
20935 &%current_directory%& option on the transport or the
20936 &%transport_current_directory%& option on the router. If the expansion fails
20937 for any reason, including forced failure, an error is logged, and delivery is
20938 deferred.
20939
20940
20941 .option initgroups transports boolean false
20942 .cindex "additional groups"
20943 .cindex "groups" "additional"
20944 .cindex "transport" "group; additional"
20945 If this option is true and the uid for the delivery process is provided by the
20946 transport, the &[initgroups()]& function is called when running the transport
20947 to ensure that any additional groups associated with the uid are set up.
20948
20949
20950 .option max_parallel transports integer&!! unset
20951 .cindex limit "transport parallelism"
20952 .cindex transport "parallel processes"
20953 .cindex transport "concurrency limit"
20954 .cindex "delivery" "parallelism for transport"
20955 If this option is set and expands to an integer greater than zero
20956 it limits the number of concurrent runs of the transport.
20957 The control does not apply to shadow transports.
20958
20959 .cindex "hints database" "transport concurrency control"
20960 Exim implements this control by means of a hints database in which a record is
20961 incremented whenever a transport process is beaing created. The record
20962 is decremented and possibly removed when the process terminates.
20963 Obviously there is scope for
20964 records to get left lying around if there is a system or program crash. To
20965 guard against this, Exim ignores any records that are more than six hours old.
20966
20967 If you use this option, you should also arrange to delete the
20968 relevant hints database whenever your system reboots. The names of the files
20969 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20970 may be one or two files, depending on the type of DBM in use. The same files
20971 are used for ETRN and smtp transport serialization.
20972
20973
20974 .option message_size_limit transports string&!! 0
20975 .cindex "limit" "message size per transport"
20976 .cindex "size" "of message, limit"
20977 .cindex "transport" "message size; limiting"
20978 This option controls the size of messages passed through the transport. It is
20979 expanded before use; the result of the expansion must be a sequence of decimal
20980 digits, optionally followed by K or M. If the expansion fails for any reason,
20981 including forced failure, or if the result is not of the required form,
20982 delivery is deferred. If the value is greater than zero and the size of a
20983 message exceeds this limit, the address is failed. If there is any chance that
20984 the resulting bounce message could be routed to the same transport, you should
20985 ensure that &%return_size_limit%& is less than the transport's
20986 &%message_size_limit%&, as otherwise the bounce message will fail to get
20987 delivered.
20988
20989
20990
20991 .option rcpt_include_affixes transports boolean false
20992 .cindex "prefix" "for local part, including in envelope"
20993 .cindex "suffix for local part" "including in envelope"
20994 .cindex "local part" "prefix"
20995 .cindex "local part" "suffix"
20996 When this option is false (the default), and an address that has had any
20997 affixes (prefixes or suffixes) removed from the local part is delivered by any
20998 form of SMTP or LMTP, the affixes are not included. For example, if a router
20999 that contains
21000 .code
21001 local_part_prefix = *-
21002 .endd
21003 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21004 is delivered with
21005 .code
21006 RCPT TO:<xyz@some.domain>
21007 .endd
21008 This is also the case when an ACL-time callout is being used to verify a
21009 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21010 whole local part is included in the RCPT command. This option applies to BSMTP
21011 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21012 &(lmtp)& and &(smtp)& transports.
21013
21014
21015 .option retry_use_local_part transports boolean "see below"
21016 .cindex "hints database" "retry keys"
21017 When a delivery suffers a temporary failure, a retry record is created
21018 in Exim's hints database. For remote deliveries, the key for the retry record
21019 is based on the name and/or IP address of the failing remote host. For local
21020 deliveries, the key is normally the entire address, including both the local
21021 part and the domain. This is suitable for most common cases of local delivery
21022 temporary failure &-- for example, exceeding a mailbox quota should delay only
21023 deliveries to that mailbox, not to the whole domain.
21024
21025 However, in some special cases you may want to treat a temporary local delivery
21026 as a failure associated with the domain, and not with a particular local part.
21027 (For example, if you are storing all mail for some domain in files.) You can do
21028 this by setting &%retry_use_local_part%& false.
21029
21030 For all the local transports, its default value is true. For remote transports,
21031 the default value is false for tidiness, but changing the value has no effect
21032 on a remote transport in the current implementation.
21033
21034
21035 .option return_path transports string&!! unset
21036 .cindex "envelope sender"
21037 .cindex "transport" "return path; changing"
21038 .cindex "return path" "changing in transport"
21039 If this option is set, the string is expanded at transport time and replaces
21040 the existing return path (envelope sender) value in the copy of the message
21041 that is being delivered. An empty return path is permitted. This feature is
21042 designed for remote deliveries, where the value of this option is used in the
21043 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21044 only effect is to change the address that is placed in the &'Return-path:'&
21045 header line, if one is added to the message (see the next option).
21046
21047 &*Note:*& A changed return path is not logged unless you add
21048 &%return_path_on_delivery%& to the log selector.
21049
21050 .vindex "&$return_path$&"
21051 The expansion can refer to the existing value via &$return_path$&. This is
21052 either the message's envelope sender, or an address set by the
21053 &%errors_to%& option on a router. If the expansion is forced to fail, no
21054 replacement occurs; if it fails for another reason, delivery is deferred. This
21055 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21056 section &<<SECTverp>>&.
21057
21058 &*Note*&: If a delivery error is detected locally, including the case when a
21059 remote server rejects a message at SMTP time, the bounce message is not sent to
21060 the value of this option. It is sent to the previously set errors address.
21061 This defaults to the incoming sender address, but can be changed by setting
21062 &%errors_to%& in a router.
21063
21064
21065
21066 .option return_path_add transports boolean false
21067 .cindex "&'Return-path:'& header line"
21068 If this option is true, a &'Return-path:'& header is added to the message.
21069 Although the return path is normally available in the prefix line of BSD
21070 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21071 have easy access to it.
21072
21073 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21074 the delivery SMTP server makes the final delivery"&. This implies that this
21075 header should not be present in incoming messages. Exim has a configuration
21076 option, &%return_path_remove%&, which requests removal of this header from
21077 incoming messages, so that delivered messages can safely be resent to other
21078 recipients.
21079
21080
21081 .option shadow_condition transports string&!! unset
21082 See &%shadow_transport%& below.
21083
21084
21085 .option shadow_transport transports string unset
21086 .cindex "shadow transport"
21087 .cindex "transport" "shadow"
21088 A local transport may set the &%shadow_transport%& option to the name of
21089 another local transport. Shadow remote transports are not supported.
21090
21091 Whenever a delivery to the main transport succeeds, and either
21092 &%shadow_condition%& is unset, or its expansion does not result in the empty
21093 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21094 passed to the shadow transport, with the same delivery address or addresses. If
21095 expansion fails, no action is taken except that non-forced expansion failures
21096 cause a log line to be written.
21097
21098 The result of the shadow transport is discarded and does not affect the
21099 subsequent processing of the message. Only a single level of shadowing is
21100 provided; the &%shadow_transport%& option is ignored on any transport when it
21101 is running as a shadow. Options concerned with output from pipes are also
21102 ignored. The log line for the successful delivery has an item added on the end,
21103 of the form
21104 .code
21105 ST=<shadow transport name>
21106 .endd
21107 If the shadow transport did not succeed, the error message is put in
21108 parentheses afterwards. Shadow transports can be used for a number of different
21109 purposes, including keeping more detailed log information than Exim normally
21110 provides, and implementing automatic acknowledgment policies based on message
21111 headers that some sites insist on.
21112
21113
21114 .option transport_filter transports string&!! unset
21115 .cindex "transport" "filter"
21116 .cindex "filter" "transport filter"
21117 This option sets up a filtering (in the Unix shell sense) process for messages
21118 at transport time. It should not be confused with mail filtering as set up by
21119 individual users or via a system filter.
21120 If unset, or expanding to an empty string, no filtering is done.
21121
21122 When the message is about to be written out, the command specified by
21123 &%transport_filter%& is started up in a separate, parallel process, and
21124 the entire message, including the header lines, is passed to it on its standard
21125 input (this in fact is done from a third process, to avoid deadlock). The
21126 command must be specified as an absolute path.
21127
21128 The lines of the message that are written to the transport filter are
21129 terminated by newline (&"\n"&). The message is passed to the filter before any
21130 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21131 lines beginning with a dot, and also before any processing implied by the
21132 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21133 &(pipe)& transports.
21134
21135 The standard error for the filter process is set to the same destination as its
21136 standard output; this is read and written to the message's ultimate
21137 destination. The process that writes the message to the filter, the
21138 filter itself, and the original process that reads the result and delivers it
21139 are all run in parallel, like a shell pipeline.
21140
21141 The filter can perform any transformations it likes, but of course should take
21142 care not to break RFC 2822 syntax. Exim does not check the result, except to
21143 test for a final newline when SMTP is in use. All messages transmitted over
21144 SMTP must end with a newline, so Exim supplies one if it is missing.
21145
21146 .cindex "content scanning" "per user"
21147 A transport filter can be used to provide content-scanning on a per-user basis
21148 at delivery time if the only required effect of the scan is to modify the
21149 message. For example, a content scan could insert a new header line containing
21150 a spam score. This could be interpreted by a filter in the user's MUA. It is
21151 not possible to discard a message at this stage.
21152
21153 .cindex "SMTP" "SIZE"
21154 A problem might arise if the filter increases the size of a message that is
21155 being sent down an SMTP connection. If the receiving SMTP server has indicated
21156 support for the SIZE parameter, Exim will have sent the size of the message
21157 at the start of the SMTP session. If what is actually sent is substantially
21158 more, the server might reject the message. This can be worked round by setting
21159 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21160 additions to the message, or to disable the use of SIZE altogether.
21161
21162 .vindex "&$pipe_addresses$&"
21163 The value of the &%transport_filter%& option is the command string for starting
21164 the filter, which is run directly from Exim, not under a shell. The string is
21165 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21166 Exim breaks it up into arguments and then expands each argument separately (see
21167 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21168 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21169 of arguments, one for each address that applies to this delivery. (This isn't
21170 an ideal name for this feature here, but as it was already implemented for the
21171 &(pipe)& transport, it seemed sensible not to change it.)
21172
21173 .vindex "&$host$&"
21174 .vindex "&$host_address$&"
21175 The expansion variables &$host$& and &$host_address$& are available when the
21176 transport is a remote one. They contain the name and IP address of the host to
21177 which the message is being sent. For example:
21178 .code
21179 transport_filter = /some/directory/transport-filter.pl \
21180   $host $host_address $sender_address $pipe_addresses
21181 .endd
21182
21183 Two problems arise if you want to use more complicated expansion items to
21184 generate transport filter commands, both of which due to the fact that the
21185 command is split up &'before'& expansion.
21186 .ilist
21187 If an expansion item contains white space, you must quote it, so that it is all
21188 part of the same command item. If the entire option setting is one such
21189 expansion item, you have to take care what kind of quoting you use. For
21190 example:
21191 .code
21192 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21193 .endd
21194 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21195 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21196 stripped by Exim when it read the option's value. When the value is used, if
21197 the single quotes were missing, the line would be split into two items,
21198 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21199 Exim tried to expand the first one.
21200 .next
21201 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21202 expansion cannot generate multiple arguments, or a command name followed by
21203 arguments. Consider this example:
21204 .code
21205 transport_filter = ${lookup{$host}lsearch{/a/file}\
21206                     {$value}{/bin/cat}}
21207 .endd
21208 The result of the lookup is interpreted as the name of the command, even
21209 if it contains white space. The simplest way round this is to use a shell:
21210 .code
21211 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21212                                {$value}{/bin/cat}}
21213 .endd
21214 .endlist
21215
21216 The filter process is run under the same uid and gid as the normal delivery.
21217 For remote deliveries this is the Exim uid/gid by default. The command should
21218 normally yield a zero return code. Transport filters are not supposed to fail.
21219 A non-zero code is taken to mean that the transport filter encountered some
21220 serious problem. Delivery of the message is deferred; the message remains on
21221 the queue and is tried again later. It is not possible to cause a message to be
21222 bounced from a transport filter.
21223
21224 If a transport filter is set on an autoreply transport, the original message is
21225 passed through the filter as it is being copied into the newly generated
21226 message, which happens if the &%return_message%& option is set.
21227
21228
21229 .option transport_filter_timeout transports time 5m
21230 .cindex "transport" "filter, timeout"
21231 When Exim is reading the output of a transport filter, it applies a timeout
21232 that can be set by this option. Exceeding the timeout is normally treated as a
21233 temporary delivery failure. However, if a transport filter is used with a
21234 &(pipe)& transport, a timeout in the transport filter is treated in the same
21235 way as a timeout in the pipe command itself. By default, a timeout is a hard
21236 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21237 becomes a temporary error.
21238
21239
21240 .option user transports string&!! "Exim user"
21241 .cindex "uid (user id)" "local delivery"
21242 .cindex "transport" "user, specifying"
21243 This option specifies the user under whose uid the delivery process is to be
21244 run, overriding any uid that may have been set by the router. If the user is
21245 given as a name, the uid is looked up from the password data, and the
21246 associated group is taken as the value of the gid to be used if the &%group%&
21247 option is not set.
21248
21249 For deliveries that use local transports, a user and group are normally
21250 specified explicitly or implicitly (for example, as a result of
21251 &%check_local_user%&) by the router or transport.
21252
21253 .cindex "hints database" "access by remote transport"
21254 For remote transports, you should leave this option unset unless you really are
21255 sure you know what you are doing. When a remote transport is running, it needs
21256 to be able to access Exim's hints databases, because each host may have its own
21257 retry data.
21258 .ecindex IIDgenoptra1
21259 .ecindex IIDgenoptra2
21260 .ecindex IIDgenoptra3
21261
21262
21263
21264
21265
21266
21267 . ////////////////////////////////////////////////////////////////////////////
21268 . ////////////////////////////////////////////////////////////////////////////
21269
21270 .chapter "Address batching in local transports" "CHAPbatching" &&&
21271          "Address batching"
21272 .cindex "transport" "local; address batching in"
21273 The only remote transport (&(smtp)&) is normally configured to handle more than
21274 one address at a time, so that when several addresses are routed to the same
21275 remote host, just one copy of the message is sent. Local transports, however,
21276 normally handle one address at a time. That is, a separate instance of the
21277 transport is run for each address that is routed to the transport. A separate
21278 copy of the message is delivered each time.
21279
21280 .cindex "batched local delivery"
21281 .oindex "&%batch_max%&"
21282 .oindex "&%batch_id%&"
21283 In special cases, it may be desirable to handle several addresses at once in a
21284 local transport, for example:
21285
21286 .ilist
21287 In an &(appendfile)& transport, when storing messages in files for later
21288 delivery by some other means, a single copy of the message with multiple
21289 recipients saves space.
21290 .next
21291 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21292 a single copy saves time, and is the normal way LMTP is expected to work.
21293 .next
21294 In a &(pipe)& transport, when passing the message
21295 to a scanner program or
21296 to some other delivery mechanism such as UUCP, multiple recipients may be
21297 acceptable.
21298 .endlist
21299
21300 These three local transports all have the same options for controlling multiple
21301 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21302 repeating the information for each transport, these options are described here.
21303
21304 The &%batch_max%& option specifies the maximum number of addresses that can be
21305 delivered together in a single run of the transport. Its default value is one
21306 (no batching). When more than one address is routed to a transport that has a
21307 &%batch_max%& value greater than one, the addresses are delivered in a batch
21308 (that is, in a single run of the transport with multiple recipients), subject
21309 to certain conditions:
21310
21311 .ilist
21312 .vindex "&$local_part$&"
21313 If any of the transport's options contain a reference to &$local_part$&, no
21314 batching is possible.
21315 .next
21316 .vindex "&$domain$&"
21317 If any of the transport's options contain a reference to &$domain$&, only
21318 addresses with the same domain are batched.
21319 .next
21320 .cindex "customizing" "batching condition"
21321 If &%batch_id%& is set, it is expanded for each address, and only those
21322 addresses with the same expanded value are batched. This allows you to specify
21323 customized batching conditions. Failure of the expansion for any reason,
21324 including forced failure, disables batching, but it does not stop the delivery
21325 from taking place.
21326 .next
21327 Batched addresses must also have the same errors address (where to send
21328 delivery errors), the same header additions and removals, the same user and
21329 group for the transport, and if a host list is present, the first host must
21330 be the same.
21331 .endlist
21332
21333 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21334 both when the file or pipe command is specified in the transport, and when it
21335 is specified by a &(redirect)& router, but all the batched addresses must of
21336 course be routed to the same file or pipe command. These two transports have an
21337 option called &%use_bsmtp%&, which causes them to deliver the message in
21338 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21339 &%check_string%& and &%escape_string%& options are forced to the values
21340 .code
21341 check_string = "."
21342 escape_string = ".."
21343 .endd
21344 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21345 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21346 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21347
21348 .cindex "&'Envelope-to:'& header line"
21349 If the generic &%envelope_to_add%& option is set for a batching transport, the
21350 &'Envelope-to:'& header that is added to the message contains all the addresses
21351 that are being processed together. If you are using a batching &(appendfile)&
21352 transport without &%use_bsmtp%&, the only way to preserve the recipient
21353 addresses is to set the &%envelope_to_add%& option.
21354
21355 .cindex "&(pipe)& transport" "with multiple addresses"
21356 .vindex "&$pipe_addresses$&"
21357 If you are using a &(pipe)& transport without BSMTP, and setting the
21358 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21359 the command. This is not a true variable; it is a bit of magic that causes each
21360 of the recipient addresses to be inserted into the command as a separate
21361 argument. This provides a way of accessing all the addresses that are being
21362 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21363 are specified by a &(redirect)& router.
21364
21365
21366
21367
21368 . ////////////////////////////////////////////////////////////////////////////
21369 . ////////////////////////////////////////////////////////////////////////////
21370
21371 .chapter "The appendfile transport" "CHAPappendfile"
21372 .scindex IIDapptra1 "&(appendfile)& transport"
21373 .scindex IIDapptra2 "transports" "&(appendfile)&"
21374 .cindex "directory creation"
21375 .cindex "creating directories"
21376 The &(appendfile)& transport delivers a message by appending it to an existing
21377 file, or by creating an entirely new file in a specified directory. Single
21378 files to which messages are appended can be in the traditional Unix mailbox
21379 format, or optionally in the MBX format supported by the Pine MUA and
21380 University of Washington IMAP daemon, &'inter alia'&. When each message is
21381 being delivered as a separate file, &"maildir"& format can optionally be used
21382 to give added protection against failures that happen part-way through the
21383 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21384 supported. For all file formats, Exim attempts to create as many levels of
21385 directory as necessary, provided that &%create_directory%& is set.
21386
21387 The code for the optional formats is not included in the Exim binary by
21388 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21389 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21390 included.
21391
21392 .cindex "quota" "system"
21393 Exim recognizes system quota errors, and generates an appropriate message. Exim
21394 also supports its own quota control within the transport, for use when the
21395 system facility is unavailable or cannot be used for some reason.
21396
21397 If there is an error while appending to a file (for example, quota exceeded or
21398 partition filled), Exim attempts to reset the file's length and last
21399 modification time back to what they were before. If there is an error while
21400 creating an entirely new file, the new file is removed.
21401
21402 Before appending to a file, a number of security checks are made, and the
21403 file is locked. A detailed description is given below, after the list of
21404 private options.
21405
21406 The &(appendfile)& transport is most commonly used for local deliveries to
21407 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21408 putting messages into files for remote delivery by some means other than Exim.
21409 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21410 option).
21411
21412
21413
21414 .section "The file and directory options" "SECTfildiropt"
21415 The &%file%& option specifies a single file, to which the message is appended;
21416 the &%directory%& option specifies a directory, in which a new file containing
21417 the message is created. Only one of these two options can be set, and for
21418 normal deliveries to mailboxes, one of them &'must'& be set.
21419
21420 .vindex "&$address_file$&"
21421 .vindex "&$local_part$&"
21422 However, &(appendfile)& is also used for delivering messages to files or
21423 directories whose names (or parts of names) are obtained from alias,
21424 forwarding, or filtering operations (for example, a &%save%& command in a
21425 user's Exim filter). When such a transport is running, &$local_part$& contains
21426 the local part that was aliased or forwarded, and &$address_file$& contains the
21427 name (or partial name) of the file or directory generated by the redirection
21428 operation. There are two cases:
21429
21430 .ilist
21431 If neither &%file%& nor &%directory%& is set, the redirection operation
21432 must specify an absolute path (one that begins with &`/`&). This is the most
21433 common case when users with local accounts use filtering to sort mail into
21434 different folders. See for example, the &(address_file)& transport in the
21435 default configuration. If the path ends with a slash, it is assumed to be the
21436 name of a directory. A delivery to a directory can also be forced by setting
21437 &%maildir_format%& or &%mailstore_format%&.
21438 .next
21439 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21440 used to determine the file or directory name for the delivery. Normally, the
21441 contents of &$address_file$& are used in some way in the string expansion.
21442 .endlist
21443
21444
21445 .cindex "Sieve filter" "configuring &(appendfile)&"
21446 .cindex "Sieve filter" "relative mailbox path handling"
21447 As an example of the second case, consider an environment where users do not
21448 have home directories. They may be permitted to use Exim filter commands of the
21449 form:
21450 .code
21451 save folder23
21452 .endd
21453 or Sieve filter commands of the form:
21454 .code
21455 require "fileinto";
21456 fileinto "folder23";
21457 .endd
21458 In this situation, the expansion of &%file%& or &%directory%& in the transport
21459 must transform the relative path into an appropriate absolute file name. In the
21460 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21461 is used as a result of a &"keep"& action in the filter. This example shows one
21462 way of handling this requirement:
21463 .code
21464 file = ${if eq{$address_file}{inbox} \
21465             {/var/mail/$local_part} \
21466             {${if eq{${substr_0_1:$address_file}}{/} \
21467                   {$address_file} \
21468                   {$home/mail/$address_file} \
21469             }} \
21470        }
21471 .endd
21472 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21473 location, absolute paths are used without change, and other folders are in the
21474 &_mail_& directory within the home directory.
21475
21476 &*Note 1*&: While processing an Exim filter, a relative path such as
21477 &_folder23_& is turned into an absolute path if a home directory is known to
21478 the router. In particular, this is the case if &%check_local_user%& is set. If
21479 you want to prevent this happening at routing time, you can set
21480 &%router_home_directory%& empty. This forces the router to pass the relative
21481 path to the transport.
21482
21483 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21484 the &%file%& or &%directory%& option is still used if it is set.
21485
21486
21487
21488
21489 .section "Private options for appendfile" "SECID134"
21490 .cindex "options" "&(appendfile)& transport"
21491
21492
21493
21494 .option allow_fifo appendfile boolean false
21495 .cindex "fifo (named pipe)"
21496 .cindex "named pipe (fifo)"
21497 .cindex "pipe" "named (fifo)"
21498 Setting this option permits delivery to named pipes (FIFOs) as well as to
21499 regular files. If no process is reading the named pipe at delivery time, the
21500 delivery is deferred.
21501
21502
21503 .option allow_symlink appendfile boolean false
21504 .cindex "symbolic link" "to mailbox"
21505 .cindex "mailbox" "symbolic link"
21506 By default, &(appendfile)& will not deliver if the path name for the file is
21507 that of a symbolic link. Setting this option relaxes that constraint, but there
21508 are security issues involved in the use of symbolic links. Be sure you know
21509 what you are doing if you set this. Details of exactly what this option affects
21510 are included in the discussion which follows this list of options.
21511
21512
21513 .option batch_id appendfile string&!! unset
21514 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21515 However, batching is automatically disabled for &(appendfile)& deliveries that
21516 happen as a result of forwarding or aliasing or other redirection directly to a
21517 file.
21518
21519
21520 .option batch_max appendfile integer 1
21521 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21522
21523
21524 .option check_group appendfile boolean false
21525 When this option is set, the group owner of the file defined by the &%file%&
21526 option is checked to see that it is the same as the group under which the
21527 delivery process is running. The default setting is false because the default
21528 file mode is 0600, which means that the group is irrelevant.
21529
21530
21531 .option check_owner appendfile boolean true
21532 When this option is set, the owner of the file defined by the &%file%& option
21533 is checked to ensure that it is the same as the user under which the delivery
21534 process is running.
21535
21536
21537 .option check_string appendfile string "see below"
21538 .cindex "&""From""& line"
21539 As &(appendfile)& writes the message, the start of each line is tested for
21540 matching &%check_string%&, and if it does, the initial matching characters are
21541 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21542 a literal string, not a regular expression, and the case of any letters it
21543 contains is significant.
21544
21545 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21546 are forced to &"."& and &".."& respectively, and any settings in the
21547 configuration are ignored. Otherwise, they default to &"From&~"& and
21548 &">From&~"& when the &%file%& option is set, and unset when any of the
21549 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21550
21551 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21552 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21553 &"From&~"& indicates the start of a new message. All four options need changing
21554 if another format is used. For example, to deliver to mailboxes in MMDF format:
21555 .cindex "MMDF format mailbox"
21556 .cindex "mailbox" "MMDF format"
21557 .code
21558 check_string = "\1\1\1\1\n"
21559 escape_string = "\1\1\1\1 \n"
21560 message_prefix = "\1\1\1\1\n"
21561 message_suffix = "\1\1\1\1\n"
21562 .endd
21563 .option create_directory appendfile boolean true
21564 .cindex "directory creation"
21565 When this option is true, Exim attempts to create any missing superior
21566 directories for the file that it is about to write. A created directory's mode
21567 is given by the &%directory_mode%& option.
21568
21569 The group ownership of a newly created directory is highly dependent on the
21570 operating system (and possibly the file system) that is being used. For
21571 example, in Solaris, if the parent directory has the setgid bit set, its group
21572 is propagated to the child; if not, the currently set group is used. However,
21573 in FreeBSD, the parent's group is always used.
21574
21575
21576
21577 .option create_file appendfile string anywhere
21578 This option constrains the location of files and directories that are created
21579 by this transport. It applies to files defined by the &%file%& option and
21580 directories defined by the &%directory%& option. In the case of maildir
21581 delivery, it applies to the top level directory, not the maildir directories
21582 beneath.
21583
21584 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21585 &"belowhome"&. In the second and third cases, a home directory must have been
21586 set for the transport. This option is not useful when an explicit file name is
21587 given for normal mailbox deliveries. It is intended for the case when file
21588 names are generated from users' &_.forward_& files. These are usually handled
21589 by an &(appendfile)& transport called &%address_file%&. See also
21590 &%file_must_exist%&.
21591
21592
21593 .option directory appendfile string&!! unset
21594 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21595 or &%directory%& must be set, unless the delivery is the direct result of a
21596 redirection (see section &<<SECTfildiropt>>&).
21597
21598 When &%directory%& is set, the string is expanded, and the message is delivered
21599 into a new file or files in or below the given directory, instead of being
21600 appended to a single mailbox file. A number of different formats are provided
21601 (see &%maildir_format%& and &%mailstore_format%&), and see section
21602 &<<SECTopdir>>& for further details of this form of delivery.
21603
21604
21605 .option directory_file appendfile string&!! "see below"
21606 .cindex "base62"
21607 .vindex "&$inode$&"
21608 When &%directory%& is set, but neither &%maildir_format%& nor
21609 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21610 whose name is obtained by expanding this string. The default value is:
21611 .code
21612 q${base62:$tod_epoch}-$inode
21613 .endd
21614 This generates a unique name from the current time, in base 62 form, and the
21615 inode of the file. The variable &$inode$& is available only when expanding this
21616 option.
21617
21618
21619 .option directory_mode appendfile "octal integer" 0700
21620 If &(appendfile)& creates any directories as a result of the
21621 &%create_directory%& option, their mode is specified by this option.
21622
21623
21624 .option escape_string appendfile string "see description"
21625 See &%check_string%& above.
21626
21627
21628 .option file appendfile string&!! unset
21629 This option is mutually exclusive with the &%directory%& option, but one of
21630 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21631 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21632 specifies a single file, to which the message is appended. One or more of
21633 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21634 &%file%&.
21635
21636 .cindex "NFS" "lock file"
21637 .cindex "locking files"
21638 .cindex "lock files"
21639 If you are using more than one host to deliver over NFS into the same
21640 mailboxes, you should always use lock files.
21641
21642 The string value is expanded for each delivery, and must yield an absolute
21643 path. The most common settings of this option are variations on one of these
21644 examples:
21645 .code
21646 file = /var/spool/mail/$local_part
21647 file = /home/$local_part/inbox
21648 file = $home/inbox
21649 .endd
21650 .cindex "&""sticky""& bit"
21651 In the first example, all deliveries are done into the same directory. If Exim
21652 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21653 create a file in the directory, so the &"sticky"& bit must be turned on for
21654 deliveries to be possible, or alternatively the &%group%& option can be used to
21655 run the delivery under a group id which has write access to the directory.
21656
21657
21658
21659 .option file_format appendfile string unset
21660 .cindex "file" "mailbox; checking existing format"
21661 This option requests the transport to check the format of an existing file
21662 before adding to it. The check consists of matching a specific string at the
21663 start of the file. The value of the option consists of an even number of
21664 colon-separated strings. The first of each pair is the test string, and the
21665 second is the name of a transport. If the transport associated with a matched
21666 string is not the current transport, control is passed over to the other
21667 transport. For example, suppose the standard &(local_delivery)& transport has
21668 this added to it:
21669 .code
21670 file_format = "From       : local_delivery :\
21671                \1\1\1\1\n : local_mmdf_delivery"
21672 .endd
21673 Mailboxes that begin with &"From"& are still handled by this transport, but if
21674 a mailbox begins with four binary ones followed by a newline, control is passed
21675 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21676 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21677 is assumed to match the current transport. If the start of a mailbox doesn't
21678 match any string, or if the transport named for a given string is not defined,
21679 delivery is deferred.
21680
21681
21682 .option file_must_exist appendfile boolean false
21683 If this option is true, the file specified by the &%file%& option must exist.
21684 A temporary error occurs if it does not, causing delivery to be deferred.
21685 If this option is false, the file is created if it does not exist.
21686
21687
21688 .option lock_fcntl_timeout appendfile time 0s
21689 .cindex "timeout" "mailbox locking"
21690 .cindex "mailbox" "locking, blocking and non-blocking"
21691 .cindex "locking files"
21692 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21693 when locking an open mailbox file. If the call fails, the delivery process
21694 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21695 Non-blocking calls are used so that the file is not kept open during the wait
21696 for the lock; the reason for this is to make it as safe as possible for
21697 deliveries over NFS in the case when processes might be accessing an NFS
21698 mailbox without using a lock file. This should not be done, but
21699 misunderstandings and hence misconfigurations are not unknown.
21700
21701 On a busy system, however, the performance of a non-blocking lock approach is
21702 not as good as using a blocking lock with a timeout. In this case, the waiting
21703 is done inside the system call, and Exim's delivery process acquires the lock
21704 and can proceed as soon as the previous lock holder releases it.
21705
21706 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21707 timeout, are used. There may still be some retrying: the maximum number of
21708 retries is
21709 .code
21710 (lock_retries * lock_interval) / lock_fcntl_timeout
21711 .endd
21712 rounded up to the next whole number. In other words, the total time during
21713 which &(appendfile)& is trying to get a lock is roughly the same, unless
21714 &%lock_fcntl_timeout%& is set very large.
21715
21716 You should consider setting this option if you are getting a lot of delayed
21717 local deliveries because of errors of the form
21718 .code
21719 failed to lock mailbox /some/file (fcntl)
21720 .endd
21721
21722 .option lock_flock_timeout appendfile time 0s
21723 This timeout applies to file locking when using &[flock()]& (see
21724 &%use_flock%&); the timeout operates in a similar manner to
21725 &%lock_fcntl_timeout%&.
21726
21727
21728 .option lock_interval appendfile time 3s
21729 This specifies the time to wait between attempts to lock the file. See below
21730 for details of locking.
21731
21732
21733 .option lock_retries appendfile integer 10
21734 This specifies the maximum number of attempts to lock the file. A value of zero
21735 is treated as 1. See below for details of locking.
21736
21737
21738 .option lockfile_mode appendfile "octal integer" 0600
21739 This specifies the mode of the created lock file, when a lock file is being
21740 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21741
21742
21743 .option lockfile_timeout appendfile time 30m
21744 .cindex "timeout" "mailbox locking"
21745 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21746 exists and is older than this value, it is assumed to have been left behind by
21747 accident, and Exim attempts to remove it.
21748
21749
21750 .option mailbox_filecount appendfile string&!! unset
21751 .cindex "mailbox" "specifying size of"
21752 .cindex "size" "of mailbox"
21753 If this option is set, it is expanded, and the result is taken as the current
21754 number of files in the mailbox. It must be a decimal number, optionally
21755 followed by K or M. This provides a way of obtaining this information from an
21756 external source that maintains the data.
21757
21758
21759 .option mailbox_size appendfile string&!! unset
21760 .cindex "mailbox" "specifying size of"
21761 .cindex "size" "of mailbox"
21762 If this option is set, it is expanded, and the result is taken as the current
21763 size the mailbox. It must be a decimal number, optionally followed by K or M.
21764 This provides a way of obtaining this information from an external source that
21765 maintains the data. This is likely to be helpful for maildir deliveries where
21766 it is computationally expensive to compute the size of a mailbox.
21767
21768
21769
21770 .option maildir_format appendfile boolean false
21771 .cindex "maildir format" "specifying"
21772 If this option is set with the &%directory%& option, the delivery is into a new
21773 file, in the &"maildir"& format that is used by other mail software. When the
21774 transport is activated directly from a &(redirect)& router (for example, the
21775 &(address_file)& transport in the default configuration), setting
21776 &%maildir_format%& causes the path received from the router to be treated as a
21777 directory, whether or not it ends with &`/`&. This option is available only if
21778 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21779 &<<SECTmaildirdelivery>>& below for further details.
21780
21781
21782 .option maildir_quota_directory_regex appendfile string "See below"
21783 .cindex "maildir format" "quota; directories included in"
21784 .cindex "quota" "maildir; directories included in"
21785 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21786 a regular expression for specifying directories, relative to the quota
21787 directory (see &%quota_directory%&), that should be included in the quota
21788 calculation. The default value is:
21789 .code
21790 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21791 .endd
21792 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21793 (directories whose names begin with a dot). If you want to exclude the
21794 &_Trash_&
21795 folder from the count (as some sites do), you need to change this setting to
21796 .code
21797 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21798 .endd
21799 This uses a negative lookahead in the regular expression to exclude the
21800 directory whose name is &_.Trash_&. When a directory is excluded from quota
21801 calculations, quota processing is bypassed for any messages that are delivered
21802 directly into that directory.
21803
21804
21805 .option maildir_retries appendfile integer 10
21806 This option specifies the number of times to retry when writing a file in
21807 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21808
21809
21810 .option maildir_tag appendfile string&!! unset
21811 This option applies only to deliveries in maildir format, and is described in
21812 section &<<SECTmaildirdelivery>>& below.
21813
21814
21815 .option maildir_use_size_file appendfile&!! boolean false
21816 .cindex "maildir format" "&_maildirsize_& file"
21817 The result of string expansion for this option must be a valid boolean value.
21818 If it is true, it enables support for &_maildirsize_& files. Exim
21819 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21820 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21821 value is zero. See &%maildir_quota_directory_regex%& above and section
21822 &<<SECTmaildirdelivery>>& below for further details.
21823
21824 .option maildirfolder_create_regex appendfile string unset
21825 .cindex "maildir format" "&_maildirfolder_& file"
21826 .cindex "&_maildirfolder_&, creating"
21827 The value of this option is a regular expression. If it is unset, it has no
21828 effect. Otherwise, before a maildir delivery takes place, the pattern is
21829 matched against the name of the maildir directory, that is, the directory
21830 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21831 delivery. If there is a match, Exim checks for the existence of a file called
21832 &_maildirfolder_& in the directory, and creates it if it does not exist.
21833 See section &<<SECTmaildirdelivery>>& for more details.
21834
21835
21836 .option mailstore_format appendfile boolean false
21837 .cindex "mailstore format" "specifying"
21838 If this option is set with the &%directory%& option, the delivery is into two
21839 new files in  &"mailstore"& format. The option is available only if
21840 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21841 below for further details.
21842
21843
21844 .option mailstore_prefix appendfile string&!! unset
21845 This option applies only to deliveries in mailstore format, and is described in
21846 section &<<SECTopdir>>& below.
21847
21848
21849 .option mailstore_suffix appendfile string&!! unset
21850 This option applies only to deliveries in mailstore format, and is described in
21851 section &<<SECTopdir>>& below.
21852
21853
21854 .option mbx_format appendfile boolean false
21855 .cindex "locking files"
21856 .cindex "file" "locking"
21857 .cindex "file" "MBX format"
21858 .cindex "MBX format, specifying"
21859 This option is available only if Exim has been compiled with SUPPORT_MBX
21860 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21861 the message is appended to the mailbox file in MBX format instead of
21862 traditional Unix format. This format is supported by Pine4 and its associated
21863 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21864
21865 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21866 automatically changed by the use of &%mbx_format%&. They should normally be set
21867 empty when using MBX format, so this option almost always appears in this
21868 combination:
21869 .code
21870 mbx_format = true
21871 message_prefix =
21872 message_suffix =
21873 .endd
21874 If none of the locking options are mentioned in the configuration,
21875 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21876 is possible to specify the other kinds of locking with &%mbx_format%&, but
21877 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21878 interworks with &'c-client'&, providing for shared access to the mailbox. It
21879 should not be used if any program that does not use this form of locking is
21880 going to access the mailbox, nor should it be used if the mailbox file is NFS
21881 mounted, because it works only when the mailbox is accessed from a single host.
21882
21883 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21884 the standard version of &'c-client'&, because as long as it has a mailbox open
21885 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21886 append messages to it.
21887
21888
21889 .option message_prefix appendfile string&!! "see below"
21890 .cindex "&""From""& line"
21891 The string specified here is expanded and output at the start of every message.
21892 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21893 in which case it is:
21894 .code
21895 message_prefix = "From ${if def:return_path{$return_path}\
21896   {MAILER-DAEMON}} $tod_bsdinbox\n"
21897 .endd
21898 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21899 &`\n`& to &`\r\n`& in &%message_prefix%&.
21900
21901 .option message_suffix appendfile string&!! "see below"
21902 The string specified here is expanded and output at the end of every message.
21903 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21904 in which case it is a single newline character. The suffix can be suppressed by
21905 setting
21906 .code
21907 message_suffix =
21908 .endd
21909 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21910 &`\n`& to &`\r\n`& in &%message_suffix%&.
21911
21912 .option mode appendfile "octal integer" 0600
21913 If the output file is created, it is given this mode. If it already exists and
21914 has wider permissions, they are reduced to this mode. If it has narrower
21915 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21916 if the delivery is the result of a &%save%& command in a filter file specifying
21917 a particular mode, the mode of the output file is always forced to take that
21918 value, and this option is ignored.
21919
21920
21921 .option mode_fail_narrower appendfile boolean true
21922 This option applies in the case when an existing mailbox file has a narrower
21923 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21924 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21925 continues with the delivery attempt, using the existing mode of the file.
21926
21927
21928 .option notify_comsat appendfile boolean false
21929 If this option is true, the &'comsat'& daemon is notified after every
21930 successful delivery to a user mailbox. This is the daemon that notifies logged
21931 on users about incoming mail.
21932
21933
21934 .option quota appendfile string&!! unset
21935 .cindex "quota" "imposed by Exim"
21936 This option imposes a limit on the size of the file to which Exim is appending,
21937 or to the total space used in the directory tree when the &%directory%& option
21938 is set. In the latter case, computation of the space used is expensive, because
21939 all the files in the directory (and any sub-directories) have to be
21940 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21941 &%maildir_use_size_file%& for ways to avoid this in environments where users
21942 have no shell access to their mailboxes).
21943
21944 As there is no interlock against two simultaneous deliveries into a
21945 multi-file mailbox, it is possible for the quota to be overrun in this case.
21946 For single-file mailboxes, of course, an interlock is a necessity.
21947
21948 A file's size is taken as its &'used'& value. Because of blocking effects, this
21949 may be a lot less than the actual amount of disk space allocated to the file.
21950 If the sizes of a number of files are being added up, the rounding effect can
21951 become quite noticeable, especially on systems that have large block sizes.
21952 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21953 the obvious value which users understand most easily.
21954
21955 The value of the option is expanded, and must then be a numerical value
21956 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21957 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21958 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21959 be handled.
21960
21961 &*Note*&: A value of zero is interpreted as &"no quota"&.
21962
21963 The expansion happens while Exim is running as root, before it changes uid for
21964 the delivery. This means that files that are inaccessible to the end user can
21965 be used to hold quota values that are looked up in the expansion. When delivery
21966 fails because this quota is exceeded, the handling of the error is as for
21967 system quota failures.
21968
21969 By default, Exim's quota checking mimics system quotas, and restricts the
21970 mailbox to the specified maximum size, though the value is not accurate to the
21971 last byte, owing to separator lines and additional headers that may get added
21972 during message delivery. When a mailbox is nearly full, large messages may get
21973 refused even though small ones are accepted, because the size of the current
21974 message is added to the quota when the check is made. This behaviour can be
21975 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21976 for exceeding the quota does not include the current message. Thus, deliveries
21977 continue until the quota has been exceeded; thereafter, no further messages are
21978 delivered. See also &%quota_warn_threshold%&.
21979
21980
21981 .option quota_directory appendfile string&!! unset
21982 This option defines the directory to check for quota purposes when delivering
21983 into individual files. The default is the delivery directory, or, if a file
21984 called &_maildirfolder_& exists in a maildir directory, the parent of the
21985 delivery directory.
21986
21987
21988 .option quota_filecount appendfile string&!! 0
21989 This option applies when the &%directory%& option is set. It limits the total
21990 number of files in the directory (compare the inode limit in system quotas). It
21991 can only be used if &%quota%& is also set. The value is expanded; an expansion
21992 failure causes delivery to be deferred. A value of zero is interpreted as
21993 &"no quota"&.
21994
21995
21996 .option quota_is_inclusive appendfile boolean true
21997 See &%quota%& above.
21998
21999
22000 .option quota_size_regex appendfile string unset
22001 This option applies when one of the delivery modes that writes a separate file
22002 for each message is being used. When Exim wants to find the size of one of
22003 these files in order to test the quota, it first checks &%quota_size_regex%&.
22004 If this is set to a regular expression that matches the file name, and it
22005 captures one string, that string is interpreted as a representation of the
22006 file's size. The value of &%quota_size_regex%& is not expanded.
22007
22008 This feature is useful only when users have no shell access to their mailboxes
22009 &-- otherwise they could defeat the quota simply by renaming the files. This
22010 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22011 the file length to the file name. For example:
22012 .code
22013 maildir_tag = ,S=$message_size
22014 quota_size_regex = ,S=(\d+)
22015 .endd
22016 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22017 number of lines in the message.
22018
22019 The regular expression should not assume that the length is at the end of the
22020 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22021 sometimes add other information onto the ends of message file names.
22022
22023 Section &<<SECID136>>& contains further information.
22024
22025
22026 .option quota_warn_message appendfile string&!! "see below"
22027 See below for the use of this option. If it is not set when
22028 &%quota_warn_threshold%& is set, it defaults to
22029 .code
22030 quota_warn_message = "\
22031   To: $local_part@$domain\n\
22032   Subject: Your mailbox\n\n\
22033   This message is automatically created \
22034   by mail delivery software.\n\n\
22035   The size of your mailbox has exceeded \
22036   a warning threshold that is\n\
22037   set by the system administrator.\n"
22038 .endd
22039
22040
22041 .option quota_warn_threshold appendfile string&!! 0
22042 .cindex "quota" "warning threshold"
22043 .cindex "mailbox" "size warning"
22044 .cindex "size" "of mailbox"
22045 This option is expanded in the same way as &%quota%& (see above). If the
22046 resulting value is greater than zero, and delivery of the message causes the
22047 size of the file or total space in the directory tree to cross the given
22048 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22049 may be specified as a percentage of it by following the value with a percent
22050 sign. For example:
22051 .code
22052 quota = 10M
22053 quota_warn_threshold = 75%
22054 .endd
22055 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22056 percent sign is ignored.
22057
22058 The warning message itself is specified by the &%quota_warn_message%& option,
22059 and it must start with a &'To:'& header line containing the recipient(s) of the
22060 warning message. These do not necessarily have to include the recipient(s) of
22061 the original message. A &'Subject:'& line should also normally be supplied. You
22062 can include any other header lines that you want. If you do not include a
22063 &'From:'& line, the default is:
22064 .code
22065 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22066 .endd
22067 .oindex &%errors_reply_to%&
22068 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22069 option.
22070
22071 The &%quota%& option does not have to be set in order to use this option; they
22072 are independent of one another except when the threshold is specified as a
22073 percentage.
22074
22075
22076 .option use_bsmtp appendfile boolean false
22077 .cindex "envelope sender"
22078 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22079 format, with the envelope sender and recipient(s) included as SMTP commands. If
22080 you want to include a leading HELO command with such messages, you can do
22081 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22082 for details of batch SMTP.
22083
22084
22085 .option use_crlf appendfile boolean false
22086 .cindex "carriage return"
22087 .cindex "linefeed"
22088 This option causes lines to be terminated with the two-character CRLF sequence
22089 (carriage return, linefeed) instead of just a linefeed character. In the case
22090 of batched SMTP, the byte sequence written to the file is then an exact image
22091 of what would be sent down a real SMTP connection.
22092
22093 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22094 (which are used to supply the traditional &"From&~"& and blank line separators
22095 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22096 carriage return characters if these are needed. In cases where these options
22097 have non-empty defaults, the values end with a single linefeed, so they must be
22098 changed to end with &`\r\n`& if &%use_crlf%& is set.
22099
22100
22101 .option use_fcntl_lock appendfile boolean "see below"
22102 This option controls the use of the &[fcntl()]& function to lock a file for
22103 exclusive use when a message is being appended. It is set by default unless
22104 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22105 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22106 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22107
22108
22109 .option use_flock_lock appendfile boolean false
22110 This option is provided to support the use of &[flock()]& for file locking, for
22111 the few situations where it is needed. Most modern operating systems support
22112 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22113 each other. Exim uses &[fcntl()]& locking by default.
22114
22115 This option is required only if you are using an operating system where
22116 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22117 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22118 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22119
22120 .cindex "Solaris" "&[flock()]& support"
22121 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22122 have it (and some, I think, provide a not quite right version built on top of
22123 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22124 the ability to use it, and any attempt to do so will cause a configuration
22125 error.
22126
22127 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22128 is just being mapped onto &[fcntl()]& by the OS).
22129
22130
22131 .option use_lockfile appendfile boolean "see below"
22132 If this option is turned off, Exim does not attempt to create a lock file when
22133 appending to a mailbox file. In this situation, the only locking is by
22134 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22135 sure that every MUA that is ever going to look at your users' mailboxes uses
22136 &[fcntl()]& rather than a lock file, and even then only when you are not
22137 delivering over NFS from more than one host.
22138
22139 .cindex "NFS" "lock file"
22140 In order to append to an NFS file safely from more than one host, it is
22141 necessary to take out a lock &'before'& opening the file, and the lock file
22142 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22143 file corruption.
22144
22145 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22146 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22147 except when &%mbx_format%& is set.
22148
22149
22150 .option use_mbx_lock appendfile boolean "see below"
22151 This option is available only if Exim has been compiled with SUPPORT_MBX
22152 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22153 locking rules be used. It is set by default if &%mbx_format%& is set and none
22154 of the locking options are mentioned in the configuration. The locking rules
22155 are the same as are used by the &'c-client'& library that underlies Pine and
22156 the IMAP4 and POP daemons that come with it (see the discussion below). The
22157 rules allow for shared access to the mailbox. However, this kind of locking
22158 does not work when the mailbox is NFS mounted.
22159
22160 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22161 &%use_flock_lock%& to control what kind of locking is used in implementing the
22162 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22163 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22164
22165
22166
22167
22168 .section "Operational details for appending" "SECTopappend"
22169 .cindex "appending to a file"
22170 .cindex "file" "appending"
22171 Before appending to a file, the following preparations are made:
22172
22173 .ilist
22174 If the name of the file is &_/dev/null_&, no action is taken, and a success
22175 return is given.
22176
22177 .next
22178 .cindex "directory creation"
22179 If any directories on the file's path are missing, Exim creates them if the
22180 &%create_directory%& option is set. A created directory's mode is given by the
22181 &%directory_mode%& option.
22182
22183 .next
22184 If &%file_format%& is set, the format of an existing file is checked. If this
22185 indicates that a different transport should be used, control is passed to that
22186 transport.
22187
22188 .next
22189 .cindex "file" "locking"
22190 .cindex "locking files"
22191 .cindex "NFS" "lock file"
22192 If &%use_lockfile%& is set, a lock file is built in a way that will work
22193 reliably over NFS, as follows:
22194
22195 .olist
22196 Create a &"hitching post"& file whose name is that of the lock file with the
22197 current time, primary host name, and process id added, by opening for writing
22198 as a new file. If this fails with an access error, delivery is deferred.
22199 .next
22200 Close the hitching post file, and hard link it to the lock file name.
22201 .next
22202 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22203 Unlink the hitching post name.
22204 .next
22205 Otherwise, use &[stat()]& to get information about the hitching post file, and
22206 then unlink hitching post name. If the number of links is exactly two, creation
22207 of the lock file succeeded but something (for example, an NFS server crash and
22208 restart) caused this fact not to be communicated to the &[link()]& call.
22209 .next
22210 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22211 up to &%lock_retries%& times. However, since any program that writes to a
22212 mailbox should complete its task very quickly, it is reasonable to time out old
22213 lock files that are normally the result of user agent and system crashes. If an
22214 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22215 it before trying again.
22216 .endlist olist
22217
22218 .next
22219 A call is made to &[lstat()]& to discover whether the main file exists, and if
22220 so, what its characteristics are. If &[lstat()]& fails for any reason other
22221 than non-existence, delivery is deferred.
22222
22223 .next
22224 .cindex "symbolic link" "to mailbox"
22225 .cindex "mailbox" "symbolic link"
22226 If the file does exist and is a symbolic link, delivery is deferred, unless the
22227 &%allow_symlink%& option is set, in which case the ownership of the link is
22228 checked, and then &[stat()]& is called to find out about the real file, which
22229 is then subjected to the checks below. The check on the top-level link
22230 ownership prevents one user creating a link for another's mailbox in a sticky
22231 directory, though allowing symbolic links in this case is definitely not a good
22232 idea. If there is a chain of symbolic links, the intermediate ones are not
22233 checked.
22234
22235 .next
22236 If the file already exists but is not a regular file, or if the file's owner
22237 and group (if the group is being checked &-- see &%check_group%& above) are
22238 different from the user and group under which the delivery is running,
22239 delivery is deferred.
22240
22241 .next
22242 If the file's permissions are more generous than specified, they are reduced.
22243 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22244 is set false, in which case the delivery is tried using the existing
22245 permissions.
22246
22247 .next
22248 The file's inode number is saved, and the file is then opened for appending.
22249 If this fails because the file has vanished, &(appendfile)& behaves as if it
22250 hadn't existed (see below). For any other failures, delivery is deferred.
22251
22252 .next
22253 If the file is opened successfully, check that the inode number hasn't
22254 changed, that it is still a regular file, and that the owner and permissions
22255 have not changed. If anything is wrong, defer delivery and freeze the message.
22256
22257 .next
22258 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22259 option is set. Otherwise, check that the file is being created in a permitted
22260 directory if the &%create_file%& option is set (deferring on failure), and then
22261 open for writing as a new file, with the O_EXCL and O_CREAT options,
22262 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22263 set). In this case, which can happen if the link points to a non-existent file,
22264 the file is opened for writing using O_CREAT but not O_EXCL, because
22265 that prevents link following.
22266
22267 .next
22268 .cindex "loop" "while file testing"
22269 If opening fails because the file exists, obey the tests given above for
22270 existing files. However, to avoid looping in a situation where the file is
22271 being continuously created and destroyed, the exists/not-exists loop is broken
22272 after 10 repetitions, and the message is then frozen.
22273
22274 .next
22275 If opening fails with any other error, defer delivery.
22276
22277 .next
22278 .cindex "file" "locking"
22279 .cindex "locking files"
22280 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22281 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22282 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22283 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22284 file, and an exclusive lock on the file whose name is
22285 .code
22286 /tmp/.<device-number>.<inode-number>
22287 .endd
22288 using the device and inode numbers of the open mailbox file, in accordance with
22289 the MBX locking rules. This file is created with a mode that is specified by
22290 the &%lockfile_mode%& option.
22291
22292 If Exim fails to lock the file, there are two possible courses of action,
22293 depending on the value of the locking timeout. This is obtained from
22294 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22295
22296 If the timeout value is zero, the file is closed, Exim waits for
22297 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22298 to lock it again. This happens up to &%lock_retries%& times, after which the
22299 delivery is deferred.
22300
22301 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22302 &[flock()]& are used (with the given timeout), so there has already been some
22303 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22304 immediately. It retries up to
22305 .code
22306 (lock_retries * lock_interval) / <timeout>
22307 .endd
22308 times (rounded up).
22309 .endlist
22310
22311 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22312 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22313
22314
22315 .section "Operational details for delivery to a new file" "SECTopdir"
22316 .cindex "delivery" "to single file"
22317 .cindex "&""From""& line"
22318 When the &%directory%& option is set instead of &%file%&, each message is
22319 delivered into a newly-created file or set of files. When &(appendfile)& is
22320 activated directly from a &(redirect)& router, neither &%file%& nor
22321 &%directory%& is normally set, because the path for delivery is supplied by the
22322 router. (See for example, the &(address_file)& transport in the default
22323 configuration.) In this case, delivery is to a new file if either the path name
22324 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22325
22326 No locking is required while writing the message to a new file, so the various
22327 locking options of the transport are ignored. The &"From"& line that by default
22328 separates messages in a single file is not normally needed, nor is the escaping
22329 of message lines that start with &"From"&, and there is no need to ensure a
22330 newline at the end of each message. Consequently, the default values for
22331 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22332 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22333
22334 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22335 the files in the delivery directory by default. However, you can specify a
22336 different directory by setting &%quota_directory%&. Also, for maildir
22337 deliveries (see below) the &_maildirfolder_& convention is honoured.
22338
22339
22340 .cindex "maildir format"
22341 .cindex "mailstore format"
22342 There are three different ways in which delivery to individual files can be
22343 done, controlled by the settings of the &%maildir_format%& and
22344 &%mailstore_format%& options. Note that code to support maildir or mailstore
22345 formats is not included in the binary unless SUPPORT_MAILDIR or
22346 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22347
22348 .cindex "directory creation"
22349 In all three cases an attempt is made to create the directory and any necessary
22350 sub-directories if they do not exist, provided that the &%create_directory%&
22351 option is set (the default). The location of a created directory can be
22352 constrained by setting &%create_file%&. A created directory's mode is given by
22353 the &%directory_mode%& option. If creation fails, or if the
22354 &%create_directory%& option is not set when creation is required, delivery is
22355 deferred.
22356
22357
22358
22359 .section "Maildir delivery" "SECTmaildirdelivery"
22360 .cindex "maildir format" "description of"
22361 If the &%maildir_format%& option is true, Exim delivers each message by writing
22362 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22363 directory that is defined by the &%directory%& option (the &"delivery
22364 directory"&). If the delivery is successful, the file is renamed into the
22365 &_new_& subdirectory.
22366
22367 In the file name, <&'stime'&> is the current time of day in seconds, and
22368 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22369 Exim checks that the time-of-day clock has moved on by at least one microsecond
22370 before terminating the delivery process. This guarantees uniqueness for the
22371 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22372 opening it. If any response other than ENOENT (does not exist) is given,
22373 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22374
22375 Before Exim carries out a maildir delivery, it ensures that subdirectories
22376 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22377 do not exist, Exim tries to create them and any superior directories in their
22378 path, subject to the &%create_directory%& and &%create_file%& options. If the
22379 &%maildirfolder_create_regex%& option is set, and the regular expression it
22380 contains matches the delivery directory, Exim also ensures that a file called
22381 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22382 &_maildirfolder_& file cannot be created, delivery is deferred.
22383
22384 These features make it possible to use Exim to create all the necessary files
22385 and directories in a maildir mailbox, including subdirectories for maildir++
22386 folders. Consider this example:
22387 .code
22388 maildir_format = true
22389 directory = /var/mail/$local_part\
22390            ${if eq{$local_part_suffix}{}{}\
22391            {/.${substr_1:$local_part_suffix}}}
22392 maildirfolder_create_regex = /\.[^/]+$
22393 .endd
22394 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22395 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22396 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22397 not match this name, so Exim will not look for or create the file
22398 &_/var/mail/pimbo/maildirfolder_&, though it will create
22399 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22400
22401 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22402 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22403 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22404 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22405 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22406
22407 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22408 not inadvertently match the toplevel maildir directory, because a
22409 &_maildirfolder_& file at top level would completely break quota calculations.
22410
22411 .cindex "quota" "in maildir delivery"
22412 .cindex "maildir++"
22413 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22414 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22415 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22416 Exim assumes the directory is a maildir++ folder directory, which is one level
22417 down from the user's top level mailbox directory. This causes it to start at
22418 the parent directory instead of the current directory when calculating the
22419 amount of space used.
22420
22421 One problem with delivering into a multi-file mailbox is that it is
22422 computationally expensive to compute the size of the mailbox for quota
22423 checking. Various approaches have been taken to reduce the amount of work
22424 needed. The next two sections describe two of them. A third alternative is to
22425 use some external process for maintaining the size data, and use the expansion
22426 of the &%mailbox_size%& option as a way of importing it into Exim.
22427
22428
22429
22430
22431 .section "Using tags to record message sizes" "SECID135"
22432 If &%maildir_tag%& is set, the string is expanded for each delivery.
22433 When the maildir file is renamed into the &_new_& sub-directory, the
22434 tag is added to its name. However, if adding the tag takes the length of the
22435 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22436 the tag is dropped and the maildir file is created with no tag.
22437
22438
22439 .vindex "&$message_size$&"
22440 Tags can be used to encode the size of files in their names; see
22441 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22442 happens after the message has been written. The value of the &$message_size$&
22443 variable is set to the number of bytes actually written. If the expansion is
22444 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22445 be deferred. The expanded tag may contain any printing characters except &"/"&.
22446 Non-printing characters in the string are ignored; if the resulting string is
22447 empty, it is ignored. If it starts with an alphanumeric character, a leading
22448 colon is inserted; this default has not proven to be the path that popular
22449 maildir implementations have chosen (but changing it in Exim would break
22450 backwards compatibility).
22451
22452 For one common implementation, you might set:
22453 .code
22454 maildir_tag = ,S=${message_size}
22455 .endd
22456 but you should check the documentation of the other software to be sure.
22457
22458 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22459 as this allows Exim to extract the size from your tag, instead of having to
22460 &[stat()]& each message file.
22461
22462
22463 .section "Using a maildirsize file" "SECID136"
22464 .cindex "quota" "in maildir delivery"
22465 .cindex "maildir format" "&_maildirsize_& file"
22466 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22467 storing quota and message size information in a file called &_maildirsize_&
22468 within the toplevel maildir directory. If this file does not exist, Exim
22469 creates it, setting the quota from the &%quota%& option of the transport. If
22470 the maildir directory itself does not exist, it is created before any attempt
22471 to write a &_maildirsize_& file.
22472
22473 The &_maildirsize_& file is used to hold information about the sizes of
22474 messages in the maildir, thus speeding up quota calculations. The quota value
22475 in the file is just a cache; if the quota is changed in the transport, the new
22476 value overrides the cached value when the next message is delivered. The cache
22477 is maintained for the benefit of other programs that access the maildir and
22478 need to know the quota.
22479
22480 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22481 file is maintained (with a zero quota setting), but no quota is imposed.
22482
22483 A regular expression is available for controlling which directories in the
22484 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22485 See the description of the &%maildir_quota_directory_regex%& option above for
22486 details.
22487
22488
22489 .section "Mailstore delivery" "SECID137"
22490 .cindex "mailstore format" "description of"
22491 If the &%mailstore_format%& option is true, each message is written as two
22492 files in the given directory. A unique base name is constructed from the
22493 message id and the current delivery process, and the files that are written use
22494 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22495 contains the message's envelope, and the &_.msg_& file contains the message
22496 itself. The base name is placed in the variable &$mailstore_basename$&.
22497
22498 During delivery, the envelope is first written to a file with the suffix
22499 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22500 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22501 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22502 file before accessing either of them. An alternative approach is to wait for
22503 the absence of a &_.tmp_& file.
22504
22505 The envelope file starts with any text defined by the &%mailstore_prefix%&
22506 option, expanded and terminated by a newline if there isn't one. Then follows
22507 the sender address on one line, then all the recipient addresses, one per line.
22508 There can be more than one recipient only if the &%batch_max%& option is set
22509 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22510 appended to the file, followed by a newline if it does not end with one.
22511
22512 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22513 failure, it is ignored. Other expansion errors are treated as serious
22514 configuration errors, and delivery is deferred. The variable
22515 &$mailstore_basename$& is available for use during these expansions.
22516
22517
22518 .section "Non-special new file delivery" "SECID138"
22519 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22520 file is created directly in the named directory. For example, when delivering
22521 messages into files in batched SMTP format for later delivery to some host (see
22522 section &<<SECTbatchSMTP>>&), a setting such as
22523 .code
22524 directory = /var/bsmtp/$host
22525 .endd
22526 might be used. A message is written to a file with a temporary name, which is
22527 then renamed when the delivery is complete. The final name is obtained by
22528 expanding the contents of the &%directory_file%& option.
22529 .ecindex IIDapptra1
22530 .ecindex IIDapptra2
22531
22532
22533
22534
22535
22536
22537 . ////////////////////////////////////////////////////////////////////////////
22538 . ////////////////////////////////////////////////////////////////////////////
22539
22540 .chapter "The autoreply transport" "CHID8"
22541 .scindex IIDauttra1 "transports" "&(autoreply)&"
22542 .scindex IIDauttra2 "&(autoreply)& transport"
22543 The &(autoreply)& transport is not a true transport in that it does not cause
22544 the message to be transmitted. Instead, it generates a new mail message as an
22545 automatic reply to the incoming message. &'References:'& and
22546 &'Auto-Submitted:'& header lines are included. These are constructed according
22547 to the rules in RFCs 2822 and 3834, respectively.
22548
22549 If the router that passes the message to this transport does not have the
22550 &%unseen%& option set, the original message (for the current recipient) is not
22551 delivered anywhere. However, when the &%unseen%& option is set on the router
22552 that passes the message to this transport, routing of the address continues, so
22553 another router can set up a normal message delivery.
22554
22555
22556 The &(autoreply)& transport is usually run as the result of mail filtering, a
22557 &"vacation"& message being the standard example. However, it can also be run
22558 directly from a router like any other transport. To reduce the possibility of
22559 message cascades, messages created by the &(autoreply)& transport always have
22560 empty envelope sender addresses, like bounce messages.
22561
22562 The parameters of the message to be sent can be specified in the configuration
22563 by options described below. However, these are used only when the address
22564 passed to the transport does not contain its own reply information. When the
22565 transport is run as a consequence of a
22566 &%mail%&
22567 or &%vacation%& command in a filter file, the parameters of the message are
22568 supplied by the filter, and passed with the address. The transport's options
22569 that define the message are then ignored (so they are not usually set in this
22570 case). The message is specified entirely by the filter or by the transport; it
22571 is never built from a mixture of options. However, the &%file_optional%&,
22572 &%mode%&, and &%return_message%& options apply in all cases.
22573
22574 &(Autoreply)& is implemented as a local transport. When used as a result of a
22575 command in a user's filter file, &(autoreply)& normally runs under the uid and
22576 gid of the user, and with appropriate current and home directories (see chapter
22577 &<<CHAPenvironment>>&).
22578
22579 There is a subtle difference between routing a message to a &(pipe)& transport
22580 that generates some text to be returned to the sender, and routing it to an
22581 &(autoreply)& transport. This difference is noticeable only if more than one
22582 address from the same message is so handled. In the case of a pipe, the
22583 separate outputs from the different addresses are gathered up and returned to
22584 the sender in a single message, whereas if &(autoreply)& is used, a separate
22585 message is generated for each address that is passed to it.
22586
22587 Non-printing characters are not permitted in the header lines generated for the
22588 message that &(autoreply)& creates, with the exception of newlines that are
22589 immediately followed by white space. If any non-printing characters are found,
22590 the transport defers.
22591 Whether characters with the top bit set count as printing characters or not is
22592 controlled by the &%print_topbitchars%& global option.
22593
22594 If any of the generic options for manipulating headers (for example,
22595 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22596 of the original message that is included in the generated message when
22597 &%return_message%& is set. They do not apply to the generated message itself.
22598
22599 .vindex "&$sender_address$&"
22600 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22601 the message, indicating that there were no recipients, it does not treat this
22602 as an error. This means that autoreplies sent to &$sender_address$& when this
22603 is empty (because the incoming message is a bounce message) do not cause
22604 problems. They are just discarded.
22605
22606
22607
22608 .section "Private options for autoreply" "SECID139"
22609 .cindex "options" "&(autoreply)& transport"
22610
22611 .option bcc autoreply string&!! unset
22612 This specifies the addresses that are to receive &"blind carbon copies"& of the
22613 message when the message is specified by the transport.
22614
22615
22616 .option cc autoreply string&!! unset
22617 This specifies recipients of the message and the contents of the &'Cc:'& header
22618 when the message is specified by the transport.
22619
22620
22621 .option file autoreply string&!! unset
22622 The contents of the file are sent as the body of the message when the message
22623 is specified by the transport. If both &%file%& and &%text%& are set, the text
22624 string comes first.
22625
22626
22627 .option file_expand autoreply boolean false
22628 If this is set, the contents of the file named by the &%file%& option are
22629 subjected to string expansion as they are added to the message.
22630
22631
22632 .option file_optional autoreply boolean false
22633 If this option is true, no error is generated if the file named by the &%file%&
22634 option or passed with the address does not exist or cannot be read.
22635
22636
22637 .option from autoreply string&!! unset
22638 This specifies the contents of the &'From:'& header when the message is
22639 specified by the transport.
22640
22641
22642 .option headers autoreply string&!! unset
22643 This specifies additional RFC 2822 headers that are to be added to the message
22644 when the message is specified by the transport. Several can be given by using
22645 &"\n"& to separate them. There is no check on the format.
22646
22647
22648 .option log autoreply string&!! unset
22649 This option names a file in which a record of every message sent is logged when
22650 the message is specified by the transport.
22651
22652
22653 .option mode autoreply "octal integer" 0600
22654 If either the log file or the &"once"& file has to be created, this mode is
22655 used.
22656
22657
22658 .option never_mail autoreply "address list&!!" unset
22659 If any run of the transport creates a message with a recipient that matches any
22660 item in the list, that recipient is quietly discarded. If all recipients are
22661 discarded, no message is created. This applies both when the recipients are
22662 generated by a filter and when they are specified in the transport.
22663
22664
22665
22666 .option once autoreply string&!! unset
22667 This option names a file or DBM database in which a record of each &'To:'&
22668 recipient is kept when the message is specified by the transport. &*Note*&:
22669 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22670
22671 If &%once%& is unset, or is set to an empty string, the message is always sent.
22672 By default, if &%once%& is set to a non-empty file name, the message
22673 is not sent if a potential recipient is already listed in the database.
22674 However, if the &%once_repeat%& option specifies a time greater than zero, the
22675 message is sent if that much time has elapsed since a message was last sent to
22676 this recipient. A setting of zero time for &%once_repeat%& (the default)
22677 prevents a message from being sent a second time &-- in this case, zero means
22678 infinity.
22679
22680 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22681 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22682 greater than zero, it changes the way Exim implements the &%once%& option.
22683 Instead of using a DBM file to record every recipient it sends to, it uses a
22684 regular file, whose size will never get larger than the given value.
22685
22686 In the file, Exim keeps a linear list of recipient addresses and the times at
22687 which they were sent messages. If the file is full when a new address needs to
22688 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22689 means that a given recipient may receive multiple messages, but at
22690 unpredictable intervals that depend on the rate of turnover of addresses in the
22691 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22692
22693
22694 .option once_file_size autoreply integer 0
22695 See &%once%& above.
22696
22697
22698 .option once_repeat autoreply time&!! 0s
22699 See &%once%& above.
22700 After expansion, the value of this option must be a valid time value.
22701
22702
22703 .option reply_to autoreply string&!! unset
22704 This specifies the contents of the &'Reply-To:'& header when the message is
22705 specified by the transport.
22706
22707
22708 .option return_message autoreply boolean false
22709 If this is set, a copy of the original message is returned with the new
22710 message, subject to the maximum size set in the &%return_size_limit%& global
22711 configuration option.
22712
22713
22714 .option subject autoreply string&!! unset
22715 This specifies the contents of the &'Subject:'& header when the message is
22716 specified by the transport. It is tempting to quote the original subject in
22717 automatic responses. For example:
22718 .code
22719 subject = Re: $h_subject:
22720 .endd
22721 There is a danger in doing this, however. It may allow a third party to
22722 subscribe your users to an opt-in mailing list, provided that the list accepts
22723 bounce messages as subscription confirmations. Well-managed lists require a
22724 non-bounce message to confirm a subscription, so the danger is relatively
22725 small.
22726
22727
22728
22729 .option text autoreply string&!! unset
22730 This specifies a single string to be used as the body of the message when the
22731 message is specified by the transport. If both &%text%& and &%file%& are set,
22732 the text comes first.
22733
22734
22735 .option to autoreply string&!! unset
22736 This specifies recipients of the message and the contents of the &'To:'& header
22737 when the message is specified by the transport.
22738 .ecindex IIDauttra1
22739 .ecindex IIDauttra2
22740
22741
22742
22743
22744 . ////////////////////////////////////////////////////////////////////////////
22745 . ////////////////////////////////////////////////////////////////////////////
22746
22747 .chapter "The lmtp transport" "CHAPLMTP"
22748 .cindex "transports" "&(lmtp)&"
22749 .cindex "&(lmtp)& transport"
22750 .cindex "LMTP" "over a pipe"
22751 .cindex "LMTP" "over a socket"
22752 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22753 specified command
22754 or by interacting with a Unix domain socket.
22755 This transport is something of a cross between the &(pipe)& and &(smtp)&
22756 transports. Exim also has support for using LMTP over TCP/IP; this is
22757 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22758 to be of minority interest, the default build-time configure in &_src/EDITME_&
22759 has it commented out. You need to ensure that
22760 .code
22761 TRANSPORT_LMTP=yes
22762 .endd
22763 .cindex "options" "&(lmtp)& transport"
22764 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22765 included in the Exim binary. The private options of the &(lmtp)& transport are
22766 as follows:
22767
22768 .option batch_id lmtp string&!! unset
22769 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22770
22771
22772 .option batch_max lmtp integer 1
22773 This limits the number of addresses that can be handled in a single delivery.
22774 Most LMTP servers can handle several addresses at once, so it is normally a
22775 good idea to increase this value. See the description of local delivery
22776 batching in chapter &<<CHAPbatching>>&.
22777
22778
22779 .option command lmtp string&!! unset
22780 This option must be set if &%socket%& is not set. The string is a command which
22781 is run in a separate process. It is split up into a command name and list of
22782 arguments, each of which is separately expanded (so expansion cannot change the
22783 number of arguments). The command is run directly, not via a shell. The message
22784 is passed to the new process using the standard input and output to operate the
22785 LMTP protocol.
22786
22787 .option ignore_quota lmtp boolean false
22788 .cindex "LMTP" "ignoring quota errors"
22789 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22790 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22791 in its response to the LHLO command.
22792
22793 .option socket lmtp string&!! unset
22794 This option must be set if &%command%& is not set. The result of expansion must
22795 be the name of a Unix domain socket. The transport connects to the socket and
22796 delivers the message to it using the LMTP protocol.
22797
22798
22799 .option timeout lmtp time 5m
22800 The transport is aborted if the created process or Unix domain socket does not
22801 respond to LMTP commands or message input within this timeout. Delivery
22802 is deferred, and will be tried again later. Here is an example of a typical
22803 LMTP transport:
22804 .code
22805 lmtp:
22806   driver = lmtp
22807   command = /some/local/lmtp/delivery/program
22808   batch_max = 20
22809   user = exim
22810 .endd
22811 This delivers up to 20 addresses at a time, in a mixture of domains if
22812 necessary, running as the user &'exim'&.
22813
22814
22815
22816 . ////////////////////////////////////////////////////////////////////////////
22817 . ////////////////////////////////////////////////////////////////////////////
22818
22819 .chapter "The pipe transport" "CHAPpipetransport"
22820 .scindex IIDpiptra1 "transports" "&(pipe)&"
22821 .scindex IIDpiptra2 "&(pipe)& transport"
22822 The &(pipe)& transport is used to deliver messages via a pipe to a command
22823 running in another process. One example is the use of &(pipe)& as a
22824 pseudo-remote transport for passing messages to some other delivery mechanism
22825 (such as UUCP). Another is the use by individual users to automatically process
22826 their incoming messages. The &(pipe)& transport can be used in one of the
22827 following ways:
22828
22829 .ilist
22830 .vindex "&$local_part$&"
22831 A router routes one address to a transport in the normal way, and the
22832 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22833 contains the local part of the address (as usual), and the command that is run
22834 is specified by the &%command%& option on the transport.
22835 .next
22836 .vindex "&$pipe_addresses$&"
22837 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22838 transport can handle more than one address in a single run. In this case, when
22839 more than one address is routed to the transport, &$local_part$& is not set
22840 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22841 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22842 that are routed to the transport.
22843 .next
22844 .vindex "&$address_pipe$&"
22845 A router redirects an address directly to a pipe command (for example, from an
22846 alias or forward file). In this case, &$address_pipe$& contains the text of the
22847 pipe command, and the &%command%& option on the transport is ignored unless
22848 &%force_command%& is set. If only one address is being transported
22849 (&%batch_max%& is not greater than one, or only one address was redirected to
22850 this pipe command), &$local_part$& contains the local part that was redirected.
22851 .endlist
22852
22853
22854 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22855 deliver messages over pipes using the LMTP interactive protocol. This is
22856 implemented by the &(lmtp)& transport.
22857
22858 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22859 &_.forward_& file, the command runs under the uid and gid of that user. In
22860 other cases, the uid and gid have to be specified explicitly, either on the
22861 transport or on the router that handles the address. Current and &"home"&
22862 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22863 details of the local delivery environment and chapter &<<CHAPbatching>>&
22864 for a discussion of local delivery batching.
22865
22866
22867 .section "Concurrent delivery" "SECID140"
22868 If two messages arrive at almost the same time, and both are routed to a pipe
22869 delivery, the two pipe transports may be run concurrently. You must ensure that
22870 any pipe commands you set up are robust against this happening. If the commands
22871 write to a file, the &%exim_lock%& utility might be of use.
22872 Alternatively the &%max_parallel%& option could be used with a value
22873 of "1" to enforce serialization.
22874
22875
22876
22877
22878 .section "Returned status and data" "SECID141"
22879 .cindex "&(pipe)& transport" "returned data"
22880 If the command exits with a non-zero return code, the delivery is deemed to
22881 have failed, unless either the &%ignore_status%& option is set (in which case
22882 the return code is treated as zero), or the return code is one of those listed
22883 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22884 later"&. In this case, delivery is deferred. Details of a permanent failure are
22885 logged, but are not included in the bounce message, which merely contains
22886 &"local delivery failed"&.
22887
22888 If the command exits on a signal and the &%freeze_signal%& option is set then
22889 the message will be frozen in the queue. If that option is not set, a bounce
22890 will be sent as normal.
22891
22892 If the return code is greater than 128 and the command being run is a shell
22893 script, it normally means that the script was terminated by a signal whose
22894 value is the return code minus 128. The &%freeze_signal%& option does not
22895 apply in this case.
22896
22897 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22898 return code is set to 127. This is the value that a shell returns if it is
22899 asked to run a non-existent command. The wording for the log line suggests that
22900 a non-existent command may be the problem.
22901
22902 The &%return_output%& option can affect the result of a pipe delivery. If it is
22903 set and the command produces any output on its standard output or standard
22904 error streams, the command is considered to have failed, even if it gave a zero
22905 return code or if &%ignore_status%& is set. The output from the command is
22906 included as part of the bounce message. The &%return_fail_output%& option is
22907 similar, except that output is returned only when the command exits with a
22908 failure return code, that is, a value other than zero or a code that matches
22909 &%temp_errors%&.
22910
22911
22912
22913 .section "How the command is run" "SECThowcommandrun"
22914 .cindex "&(pipe)& transport" "path for command"
22915 The command line is (by default) broken down into a command name and arguments
22916 by the &(pipe)& transport itself. The &%allow_commands%& and
22917 &%restrict_to_path%& options can be used to restrict the commands that may be
22918 run.
22919
22920 .cindex "quoting" "in pipe command"
22921 Unquoted arguments are delimited by white space. If an argument appears in
22922 double quotes, backslash is interpreted as an escape character in the usual
22923 way. If an argument appears in single quotes, no escaping is done.
22924
22925 String expansion is applied to the command line except when it comes from a
22926 traditional &_.forward_& file (commands from a filter file are expanded). The
22927 expansion is applied to each argument in turn rather than to the whole line.
22928 For this reason, any string expansion item that contains white space must be
22929 quoted so as to be contained within a single argument. A setting such as
22930 .code
22931 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22932 .endd
22933 will not work, because the expansion item gets split between several
22934 arguments. You have to write
22935 .code
22936 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22937 .endd
22938 to ensure that it is all in one argument. The expansion is done in this way,
22939 argument by argument, so that the number of arguments cannot be changed as a
22940 result of expansion, and quotes or backslashes in inserted variables do not
22941 interact with external quoting. However, this leads to problems if you want to
22942 generate multiple arguments (or the command name plus arguments) from a single
22943 expansion. In this situation, the simplest solution is to use a shell. For
22944 example:
22945 .code
22946 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22947 .endd
22948
22949 .cindex "transport" "filter"
22950 .cindex "filter" "transport filter"
22951 .vindex "&$pipe_addresses$&"
22952 Special handling takes place when an argument consists of precisely the text
22953 &`$pipe_addresses`&. This is not a general expansion variable; the only
22954 place this string is recognized is when it appears as an argument for a pipe or
22955 transport filter command. It causes each address that is being handled to be
22956 inserted in the argument list at that point &'as a separate argument'&. This
22957 avoids any problems with spaces or shell metacharacters, and is of use when a
22958 &(pipe)& transport is handling groups of addresses in a batch.
22959
22960 If &%force_command%& is enabled on the transport, Special handling takes place
22961 for an argument that consists of precisely the text &`$address_pipe`&.  It
22962 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22963 argument is inserted in the argument list at that point
22964 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22965 the only item in the argument; in fact, if it were then &%force_command%&
22966 should behave as a no-op.  Rather, it should be used to adjust the command
22967 run while preserving the argument vector separation.
22968
22969 After splitting up into arguments and expansion, the resulting command is run
22970 in a subprocess directly from the transport, &'not'& under a shell. The
22971 message that is being delivered is supplied on the standard input, and the
22972 standard output and standard error are both connected to a single pipe that is
22973 read by Exim. The &%max_output%& option controls how much output the command
22974 may produce, and the &%return_output%& and &%return_fail_output%& options
22975 control what is done with it.
22976
22977 Not running the command under a shell (by default) lessens the security risks
22978 in cases when a command from a user's filter file is built out of data that was
22979 taken from an incoming message. If a shell is required, it can of course be
22980 explicitly specified as the command to be run. However, there are circumstances
22981 where existing commands (for example, in &_.forward_& files) expect to be run
22982 under a shell and cannot easily be modified. To allow for these cases, there is
22983 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22984 works. Instead of breaking up the command line as just described, it expands it
22985 as a single string and passes the result to &_/bin/sh_&. The
22986 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22987 with &%use_shell%&, and the whole mechanism is inherently less secure.
22988
22989
22990
22991 .section "Environment variables" "SECTpipeenv"
22992 .cindex "&(pipe)& transport" "environment for command"
22993 .cindex "environment" "&(pipe)& transport"
22994 The environment variables listed below are set up when the command is invoked.
22995 This list is a compromise for maximum compatibility with other MTAs. Note that
22996 the &%environment%& option can be used to add additional variables to this
22997 environment. The environment for the &(pipe)& transport is not subject
22998 to the &%add_environment%& and &%keep_environment%& main config options.
22999 .display
23000 &`DOMAIN            `&   the domain of the address
23001 &`HOME              `&   the home directory, if set
23002 &`HOST              `&   the host name when called from a router (see below)
23003 &`LOCAL_PART        `&   see below
23004 &`LOCAL_PART_PREFIX `&   see below
23005 &`LOCAL_PART_SUFFIX `&   see below
23006 &`LOGNAME           `&   see below
23007 &`MESSAGE_ID        `&   Exim's local ID for the message
23008 &`PATH              `&   as specified by the &%path%& option below
23009 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23010 &`RECIPIENT         `&   the complete recipient address
23011 &`SENDER            `&   the sender of the message (empty if a bounce)
23012 &`SHELL             `&   &`/bin/sh`&
23013 &`TZ                `&   the value of the &%timezone%& option, if set
23014 &`USER              `&   see below
23015 .endd
23016 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23017 router, LOCAL_PART is set to the local part of the address. When it is
23018 called as a result of a forward or alias expansion, LOCAL_PART is set to
23019 the local part of the address that was expanded. In both cases, any affixes are
23020 removed from the local part, and made available in LOCAL_PART_PREFIX and
23021 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23022 same value as LOCAL_PART for compatibility with other MTAs.
23023
23024 .cindex "HOST"
23025 HOST is set only when a &(pipe)& transport is called from a router that
23026 associates hosts with an address, typically when using &(pipe)& as a
23027 pseudo-remote transport. HOST is set to the first host name specified by
23028 the router.
23029
23030 .cindex "HOME"
23031 If the transport's generic &%home_directory%& option is set, its value is used
23032 for the HOME environment variable. Otherwise, a home directory may be set
23033 by the router's &%transport_home_directory%& option, which defaults to the
23034 user's home directory if &%check_local_user%& is set.
23035
23036
23037 .section "Private options for pipe" "SECID142"
23038 .cindex "options" "&(pipe)& transport"
23039
23040
23041
23042 .option allow_commands pipe "string list&!!" unset
23043 .cindex "&(pipe)& transport" "permitted commands"
23044 The string is expanded, and is then interpreted as a colon-separated list of
23045 permitted commands. If &%restrict_to_path%& is not set, the only commands
23046 permitted are those in the &%allow_commands%& list. They need not be absolute
23047 paths; the &%path%& option is still used for relative paths. If
23048 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23049 in the &%allow_commands%& list, or a name without any slashes that is found on
23050 the path. In other words, if neither &%allow_commands%& nor
23051 &%restrict_to_path%& is set, there is no restriction on the command, but
23052 otherwise only commands that are permitted by one or the other are allowed. For
23053 example, if
23054 .code
23055 allow_commands = /usr/bin/vacation
23056 .endd
23057 and &%restrict_to_path%& is not set, the only permitted command is
23058 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23059 &%use_shell%& is set.
23060
23061
23062 .option batch_id pipe string&!! unset
23063 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23064
23065
23066 .option batch_max pipe integer 1
23067 This limits the number of addresses that can be handled in a single delivery.
23068 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23069
23070
23071 .option check_string pipe string unset
23072 As &(pipe)& writes the message, the start of each line is tested for matching
23073 &%check_string%&, and if it does, the initial matching characters are replaced
23074 by the contents of &%escape_string%&, provided both are set. The value of
23075 &%check_string%& is a literal string, not a regular expression, and the case of
23076 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23077 of &%check_string%& and &%escape_string%& are forced to values that implement
23078 the SMTP escaping protocol. Any settings made in the configuration file are
23079 ignored.
23080
23081
23082 .option command pipe string&!! unset
23083 This option need not be set when &(pipe)& is being used to deliver to pipes
23084 obtained directly from address redirections. In other cases, the option must be
23085 set, to provide a command to be run. It need not yield an absolute path (see
23086 the &%path%& option below). The command is split up into separate arguments by
23087 Exim, and each argument is separately expanded, as described in section
23088 &<<SECThowcommandrun>>& above.
23089
23090
23091 .option environment pipe string&!! unset
23092 .cindex "&(pipe)& transport" "environment for command"
23093 .cindex "environment" "&(pipe)& transport"
23094 This option is used to add additional variables to the environment in which the
23095 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23096 a string which is expanded, and then interpreted as a colon-separated list of
23097 environment settings of the form <&'name'&>=<&'value'&>.
23098
23099
23100 .option escape_string pipe string unset
23101 See &%check_string%& above.
23102
23103
23104 .option freeze_exec_fail pipe boolean false
23105 .cindex "exec failure"
23106 .cindex "failure of exec"
23107 .cindex "&(pipe)& transport" "failure of exec"
23108 Failure to exec the command in a pipe transport is by default treated like
23109 any other failure while running the command. However, if &%freeze_exec_fail%&
23110 is set, failure to exec is treated specially, and causes the message to be
23111 frozen, whatever the setting of &%ignore_status%&.
23112
23113
23114 .option freeze_signal pipe boolean false
23115 .cindex "signal exit"
23116 .cindex "&(pipe)& transport", "signal exit"
23117 Normally if the process run by a command in a pipe transport exits on a signal,
23118 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23119 frozen in Exim's queue instead.
23120
23121
23122 .option force_command pipe boolean false
23123 .cindex "force command"
23124 .cindex "&(pipe)& transport", "force command"
23125 Normally when a router redirects an address directly to a pipe command
23126 the &%command%& option on the transport is ignored.  If &%force_command%&
23127 is set, the &%command%& option will used. This is especially
23128 useful for forcing a wrapper or additional argument to be added to the
23129 command. For example:
23130 .code
23131 command = /usr/bin/remote_exec myhost -- $address_pipe
23132 force_command
23133 .endd
23134
23135 Note that &$address_pipe$& is handled specially in &%command%& when
23136 &%force_command%& is set, expanding out to the original argument vector as
23137 separate items, similarly to a Unix shell &`"$@"`& construct.
23138
23139
23140 .option ignore_status pipe boolean false
23141 If this option is true, the status returned by the subprocess that is set up to
23142 run the command is ignored, and Exim behaves as if zero had been returned.
23143 Otherwise, a non-zero status or termination by signal causes an error return
23144 from the transport unless the status value is one of those listed in
23145 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23146
23147 &*Note*&: This option does not apply to timeouts, which do not return a status.
23148 See the &%timeout_defer%& option for how timeouts are handled.
23149
23150
23151 .option log_defer_output pipe boolean false
23152 .cindex "&(pipe)& transport" "logging output"
23153 If this option is set, and the status returned by the command is
23154 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23155 and any output was produced on stdout or stderr, the first line of it is
23156 written to the main log.
23157
23158
23159 .option log_fail_output pipe boolean false
23160 If this option is set, and the command returns any output on stdout or
23161 stderr, and also ends with a return code that is neither zero nor one of
23162 the return codes listed in &%temp_errors%& (that is, the delivery
23163 failed), the first line of output is written to the main log. This
23164 option and &%log_output%& are mutually exclusive.  Only one of them may
23165 be set.
23166
23167
23168 .option log_output pipe boolean false
23169 If this option is set and the command returns any output on stdout or
23170 stderr, the first line of output is written to the main log, whatever
23171 the return code. This option and &%log_fail_output%& are mutually
23172 exclusive. Only one of them may be set.
23173
23174
23175 .option max_output pipe integer 20K
23176 This specifies the maximum amount of output that the command may produce on its
23177 standard output and standard error file combined. If the limit is exceeded, the
23178 process running the command is killed. This is intended as a safety measure to
23179 catch runaway processes. The limit is applied independently of the settings of
23180 the options that control what is done with such output (for example,
23181 &%return_output%&). Because of buffering effects, the amount of output may
23182 exceed the limit by a small amount before Exim notices.
23183
23184
23185 .option message_prefix pipe string&!! "see below"
23186 The string specified here is expanded and output at the start of every message.
23187 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23188 .code
23189 message_prefix = \
23190   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23191   ${tod_bsdinbox}\n
23192 .endd
23193 .cindex "Cyrus"
23194 .cindex "&%tmail%&"
23195 .cindex "&""From""& line"
23196 This is required by the commonly used &_/usr/bin/vacation_& program.
23197 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23198 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23199 setting
23200 .code
23201 message_prefix =
23202 .endd
23203 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23204 &`\n`& to &`\r\n`& in &%message_prefix%&.
23205
23206
23207 .option message_suffix pipe string&!! "see below"
23208 The string specified here is expanded and output at the end of every message.
23209 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23210 The suffix can be suppressed by setting
23211 .code
23212 message_suffix =
23213 .endd
23214 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23215 &`\n`& to &`\r\n`& in &%message_suffix%&.
23216
23217
23218 .option path pipe string "see below"
23219 This option specifies the string that is set up in the PATH environment
23220 variable of the subprocess. The default is:
23221 .code
23222 /bin:/usr/bin
23223 .endd
23224 If the &%command%& option does not yield an absolute path name, the command is
23225 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23226 apply to a command specified as a transport filter.
23227
23228
23229 .option permit_coredump pipe boolean false
23230 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23231 a core-dump of a pipe command, enable this command.  This enables core-dumps
23232 during delivery and affects both the Exim binary and the pipe command run.
23233 It is recommended that this option remain off unless and until you have a need
23234 for it and that this only be enabled when needed, as the risk of excessive
23235 resource consumption can be quite high.  Note also that Exim is typically
23236 installed as a setuid binary and most operating systems will inhibit coredumps
23237 of these by default, so further OS-specific action may be required.
23238
23239
23240 .option pipe_as_creator pipe boolean false
23241 .cindex "uid (user id)" "local delivery"
23242 If the generic &%user%& option is not set and this option is true, the delivery
23243 process is run under the uid that was in force when Exim was originally called
23244 to accept the message. If the group id is not otherwise set (via the generic
23245 &%group%& option), the gid that was in force when Exim was originally called to
23246 accept the message is used.
23247
23248
23249 .option restrict_to_path pipe boolean false
23250 When this option is set, any command name not listed in &%allow_commands%& must
23251 contain no slashes. The command is searched for only in the directories listed
23252 in the &%path%& option. This option is intended for use in the case when a pipe
23253 command has been generated from a user's &_.forward_& file. This is usually
23254 handled by a &(pipe)& transport called &%address_pipe%&.
23255
23256
23257 .option return_fail_output pipe boolean false
23258 If this option is true, and the command produced any output and ended with a
23259 return code other than zero or one of the codes listed in &%temp_errors%& (that
23260 is, the delivery failed), the output is returned in the bounce message.
23261 However, if the message has a null sender (that is, it is itself a bounce
23262 message), output from the command is discarded. This option and
23263 &%return_output%& are mutually exclusive. Only one of them may be set.
23264
23265
23266
23267 .option return_output pipe boolean false
23268 If this option is true, and the command produced any output, the delivery is
23269 deemed to have failed whatever the return code from the command, and the output
23270 is returned in the bounce message. Otherwise, the output is just discarded.
23271 However, if the message has a null sender (that is, it is a bounce message),
23272 output from the command is always discarded, whatever the setting of this
23273 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23274 of them may be set.
23275
23276
23277
23278 .option temp_errors pipe "string list" "see below"
23279 .cindex "&(pipe)& transport" "temporary failure"
23280 This option contains either a colon-separated list of numbers, or a single
23281 asterisk. If &%ignore_status%& is false
23282 and &%return_output%& is not set,
23283 and the command exits with a non-zero return code, the failure is treated as
23284 temporary and the delivery is deferred if the return code matches one of the
23285 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23286 codes are treated as permanent errors. The default setting contains the codes
23287 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23288 compiled on a system that does not define these macros, it assumes values of 75
23289 and 73, respectively.
23290
23291
23292 .option timeout pipe time 1h
23293 If the command fails to complete within this time, it is killed. This normally
23294 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23295 specifies no timeout. In order to ensure that any subprocesses created by the
23296 command are also killed, Exim makes the initial process a process group leader,
23297 and kills the whole process group on a timeout. However, this can be defeated
23298 if one of the processes starts a new process group.
23299
23300 .option timeout_defer pipe boolean false
23301 A timeout in a &(pipe)& transport, either in the command that the transport
23302 runs, or in a transport filter that is associated with it, is by default
23303 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23304 is set true, both kinds of timeout become temporary errors, causing the
23305 delivery to be deferred.
23306
23307 .option umask pipe "octal integer" 022
23308 This specifies the umask setting for the subprocess that runs the command.
23309
23310
23311 .option use_bsmtp pipe boolean false
23312 .cindex "envelope sender"
23313 If this option is set true, the &(pipe)& transport writes messages in &"batch
23314 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23315 commands. If you want to include a leading HELO command with such messages,
23316 you can do so by setting the &%message_prefix%& option. See section
23317 &<<SECTbatchSMTP>>& for details of batch SMTP.
23318
23319 .option use_classresources pipe boolean false
23320 .cindex "class resources (BSD)"
23321 This option is available only when Exim is running on FreeBSD, NetBSD, or
23322 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23323 resource limits when a &(pipe)& transport is run to perform a delivery. The
23324 limits for the uid under which the pipe is to run are obtained from the login
23325 class database.
23326
23327
23328 .option use_crlf pipe boolean false
23329 .cindex "carriage return"
23330 .cindex "linefeed"
23331 This option causes lines to be terminated with the two-character CRLF sequence
23332 (carriage return, linefeed) instead of just a linefeed character. In the case
23333 of batched SMTP, the byte sequence written to the pipe is then an exact image
23334 of what would be sent down a real SMTP connection.
23335
23336 The contents of the &%message_prefix%& and &%message_suffix%& options are
23337 written verbatim, so must contain their own carriage return characters if these
23338 are needed. When &%use_bsmtp%& is not set, the default values for both
23339 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23340 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23341
23342
23343 .option use_shell pipe boolean false
23344 .vindex "&$pipe_addresses$&"
23345 If this option is set, it causes the command to be passed to &_/bin/sh_&
23346 instead of being run directly from the transport, as described in section
23347 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23348 where the command is expected to be run under a shell and cannot easily be
23349 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23350 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23351 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23352 its &%-c%& option.
23353
23354
23355
23356 .section "Using an external local delivery agent" "SECID143"
23357 .cindex "local delivery" "using an external agent"
23358 .cindex "&'procmail'&"
23359 .cindex "external local delivery"
23360 .cindex "delivery" "&'procmail'&"
23361 .cindex "delivery" "by external agent"
23362 The &(pipe)& transport can be used to pass all messages that require local
23363 delivery to a separate local delivery agent such as &%procmail%&. When doing
23364 this, care must be taken to ensure that the pipe is run under an appropriate
23365 uid and gid. In some configurations one wants this to be a uid that is trusted
23366 by the delivery agent to supply the correct sender of the message. It may be
23367 necessary to recompile or reconfigure the delivery agent so that it trusts an
23368 appropriate user. The following is an example transport and router
23369 configuration for &%procmail%&:
23370 .code
23371 # transport
23372 procmail_pipe:
23373   driver = pipe
23374   command = /usr/local/bin/procmail -d $local_part
23375   return_path_add
23376   delivery_date_add
23377   envelope_to_add
23378   check_string = "From "
23379   escape_string = ">From "
23380   umask = 077
23381   user = $local_part
23382   group = mail
23383
23384 # router
23385 procmail:
23386   driver = accept
23387   check_local_user
23388   transport = procmail_pipe
23389 .endd
23390 In this example, the pipe is run as the local user, but with the group set to
23391 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23392 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23393 user to supply a correct sender address. If you do not specify either a
23394 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23395 home directory is the user's home directory by default.
23396
23397 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23398 .code
23399 IFS=" "
23400 .endd
23401 as shown in some &%procmail%& documentation, because Exim does not by default
23402 use a shell to run pipe commands.
23403
23404 .cindex "Cyrus"
23405 The next example shows a transport and a router for a system where local
23406 deliveries are handled by the Cyrus IMAP server.
23407 .code
23408 # transport
23409 local_delivery_cyrus:
23410   driver = pipe
23411   command = /usr/cyrus/bin/deliver \
23412             -m ${substr_1:$local_part_suffix} -- $local_part
23413   user = cyrus
23414   group = mail
23415   return_output
23416   log_output
23417   message_prefix =
23418   message_suffix =
23419
23420 # router
23421 local_user_cyrus:
23422   driver = accept
23423   check_local_user
23424   local_part_suffix = .*
23425   transport = local_delivery_cyrus
23426 .endd
23427 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23428 &%return_output%& to cause any text written by Cyrus to be returned to the
23429 sender.
23430 .ecindex IIDpiptra1
23431 .ecindex IIDpiptra2
23432
23433
23434 . ////////////////////////////////////////////////////////////////////////////
23435 . ////////////////////////////////////////////////////////////////////////////
23436
23437 .chapter "The smtp transport" "CHAPsmtptrans"
23438 .scindex IIDsmttra1 "transports" "&(smtp)&"
23439 .scindex IIDsmttra2 "&(smtp)& transport"
23440 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23441 or LMTP protocol. The list of hosts to try can either be taken from the address
23442 that is being processed (having been set up by the router), or specified
23443 explicitly for the transport. Timeout and retry processing (see chapter
23444 &<<CHAPretry>>&) is applied to each IP address independently.
23445
23446
23447 .section "Multiple messages on a single connection" "SECID144"
23448 The sending of multiple messages over a single TCP/IP connection can arise in
23449 two ways:
23450
23451 .ilist
23452 If a message contains more than &%max_rcpt%& (see below) addresses that are
23453 routed to the same host, more than one copy of the message has to be sent to
23454 that host. In this situation, multiple copies may be sent in a single run of
23455 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23456 does when it has too many addresses to send in one message also depends on the
23457 value of the global &%remote_max_parallel%& option. Details are given in
23458 section &<<SECToutSMTPTCP>>&.)
23459 .next
23460 .cindex "hints database" "remembering routing"
23461 When a message has been successfully delivered over a TCP/IP connection, Exim
23462 looks in its hints database to see if there are any other messages awaiting a
23463 connection to the same host. If there are, a new delivery process is started
23464 for one of them, and the current TCP/IP connection is passed on to it. The new
23465 process may in turn send multiple copies and possibly create yet another
23466 process.
23467 .endlist
23468
23469
23470 For each copy sent over the same TCP/IP connection, a sequence counter is
23471 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23472 no further messages are sent over that connection.
23473
23474
23475
23476 .section "Use of the $host and $host_address variables" "SECID145"
23477 .vindex "&$host$&"
23478 .vindex "&$host_address$&"
23479 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23480 &$host_address$& are the name and IP address of the first host on the host list
23481 passed by the router. However, when the transport is about to connect to a
23482 specific host, and while it is connected to that host, &$host$& and
23483 &$host_address$& are set to the values for that host. These are the values
23484 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23485 &%serialize_hosts%&, and the various TLS options are expanded.
23486
23487
23488 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23489 .vindex &$tls_bits$&
23490 .vindex &$tls_cipher$&
23491 .vindex &$tls_peerdn$&
23492 .vindex &$tls_sni$&
23493 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23494 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23495 are the values that were set when the message was received.
23496 These are the values that are used for options that are expanded before any
23497 SMTP connections are made. Just before each connection is made, these four
23498 variables are emptied. If TLS is subsequently started, they are set to the
23499 appropriate values for the outgoing connection, and these are the values that
23500 are in force when any authenticators are run and when the
23501 &%authenticated_sender%& option is expanded.
23502
23503 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23504 and will be removed in a future release.
23505
23506
23507 .section "Private options for smtp" "SECID146"
23508 .cindex "options" "&(smtp)& transport"
23509 The private options of the &(smtp)& transport are as follows:
23510
23511
23512 .option address_retry_include_sender smtp boolean true
23513 .cindex "4&'xx'& responses" "retrying after"
23514 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23515 is the combination of sender and recipient that is delayed in subsequent queue
23516 runs until the retry time is reached. You can delay the recipient without
23517 reference to the sender (which is what earlier versions of Exim did), by
23518 setting &%address_retry_include_sender%& false. However, this can lead to
23519 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23520
23521 .option allow_localhost smtp boolean false
23522 .cindex "local host" "sending to"
23523 .cindex "fallback" "hosts specified on transport"
23524 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23525 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23526 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23527 the delivery anyway. This should be used only in special cases when the
23528 configuration ensures that no looping will result (for example, a differently
23529 configured Exim is listening on the port to which the message is sent).
23530
23531
23532 .option authenticated_sender smtp string&!! unset
23533 .cindex "Cyrus"
23534 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23535 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23536 overriding any existing authenticated sender value. If the string expansion is
23537 forced to fail, the option is ignored. Other expansion failures cause delivery
23538 to be deferred. If the result of expansion is an empty string, that is also
23539 ignored.
23540
23541 The expansion happens after the outgoing connection has been made and TLS
23542 started, if required. This means that the &$host$&, &$host_address$&,
23543 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23544 particular connection.
23545
23546 If the SMTP session is not authenticated, the expansion of
23547 &%authenticated_sender%& still happens (and can cause the delivery to be
23548 deferred if it fails), but no AUTH= item is added to MAIL commands
23549 unless &%authenticated_sender_force%& is true.
23550
23551 This option allows you to use the &(smtp)& transport in LMTP mode to
23552 deliver mail to Cyrus IMAP and provide the proper local part as the
23553 &"authenticated sender"&, via a setting such as:
23554 .code
23555 authenticated_sender = $local_part
23556 .endd
23557 This removes the need for IMAP subfolders to be assigned special ACLs to
23558 allow direct delivery to those subfolders.
23559
23560 Because of expected uses such as that just described for Cyrus (when no
23561 domain is involved), there is no checking on the syntax of the provided
23562 value.
23563
23564
23565 .option authenticated_sender_force smtp boolean false
23566 If this option is set true, the &%authenticated_sender%& option's value
23567 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23568 authenticated as a client.
23569
23570
23571 .option command_timeout smtp time 5m
23572 This sets a timeout for receiving a response to an SMTP command that has been
23573 sent out. It is also used when waiting for the initial banner line from the
23574 remote host. Its value must not be zero.
23575
23576
23577 .option connect_timeout smtp time 5m
23578 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23579 to a remote host. A setting of zero allows the system timeout (typically
23580 several minutes) to act. To have any effect, the value of this option must be
23581 less than the system timeout. However, it has been observed that on some
23582 systems there is no system timeout, which is why the default value for this
23583 option is 5 minutes, a value recommended by RFC 1123.
23584
23585
23586 .option connection_max_messages smtp integer 500
23587 .cindex "SMTP" "passed connection"
23588 .cindex "SMTP" "multiple deliveries"
23589 .cindex "multiple SMTP deliveries"
23590 This controls the maximum number of separate message deliveries that are sent
23591 over a single TCP/IP connection. If the value is zero, there is no limit.
23592 For testing purposes, this value can be overridden by the &%-oB%& command line
23593 option.
23594
23595
23596 .option data_timeout smtp time 5m
23597 This sets a timeout for the transmission of each block in the data portion of
23598 the message. As a result, the overall timeout for a message depends on the size
23599 of the message. Its value must not be zero. See also &%final_timeout%&.
23600
23601
23602 .option dkim_domain smtp string&!! unset
23603 .option dkim_selector smtp string&!! unset
23604 .option dkim_private_key smtp string&!! unset
23605 .option dkim_canon smtp string&!! unset
23606 .option dkim_strict smtp string&!! unset
23607 .option dkim_sign_headers smtp string&!! unset
23608 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23609
23610
23611 .option delay_after_cutoff smtp boolean true
23612 This option controls what happens when all remote IP addresses for a given
23613 domain have been inaccessible for so long that they have passed their retry
23614 cutoff times.
23615
23616 In the default state, if the next retry time has not been reached for any of
23617 them, the address is bounced without trying any deliveries. In other words,
23618 Exim delays retrying an IP address after the final cutoff time until a new
23619 retry time is reached, and can therefore bounce an address without ever trying
23620 a delivery, when machines have been down for a long time. Some people are
23621 unhappy at this prospect, so...
23622
23623 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23624 addresses are past their final cutoff time, Exim tries to deliver to those
23625 IP addresses that have not been tried since the message arrived. If there are
23626 none, of if they all fail, the address is bounced. In other words, it does not
23627 delay when a new message arrives, but immediately tries those expired IP
23628 addresses that haven't been tried since the message arrived. If there is a
23629 continuous stream of messages for the dead hosts, unsetting
23630 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23631 to them.
23632
23633
23634 .option dns_qualify_single smtp boolean true
23635 If the &%hosts%& or &%fallback_hosts%& option is being used,
23636 and the &%gethostbyname%& option is false,
23637 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23638 in chapter &<<CHAPdnslookup>>& for more details.
23639
23640
23641 .option dns_search_parents smtp boolean false
23642 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23643 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23644 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23645 details.
23646
23647
23648 .option dnssec_request_domains smtp "domain list&!!" unset
23649 .cindex "MX record" "security"
23650 .cindex "DNSSEC" "MX lookup"
23651 .cindex "security" "MX lookup"
23652 .cindex "DNS" "DNSSEC"
23653 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23654 the dnssec request bit set.
23655 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23656
23657
23658
23659 .option dnssec_require_domains smtp "domain list&!!" unset
23660 .cindex "MX record" "security"
23661 .cindex "DNSSEC" "MX lookup"
23662 .cindex "security" "MX lookup"
23663 .cindex "DNS" "DNSSEC"
23664 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23665 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23666 (AD bit) set will be ignored and logged as a host-lookup failure.
23667 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23668
23669
23670
23671 .option dscp smtp string&!! unset
23672 .cindex "DCSP" "outbound"
23673 This option causes the DSCP value associated with a socket to be set to one
23674 of a number of fixed strings or to numeric value.
23675 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23676 Common values include &`throughput`&, &`mincost`&, and on newer systems
23677 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23678
23679 The outbound packets from Exim will be marked with this value in the header
23680 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23681 that these values will have any effect, not be stripped by networking
23682 equipment, or do much of anything without cooperation with your Network
23683 Engineer and those of all network operators between the source and destination.
23684
23685
23686 .option fallback_hosts smtp "string list" unset
23687 .cindex "fallback" "hosts specified on transport"
23688 String expansion is not applied to this option. The argument must be a
23689 colon-separated list of host names or IP addresses, optionally also including
23690 port numbers, though the separator can be changed, as described in section
23691 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23692 item in a &%route_list%& setting for the &(manualroute)& router, as described
23693 in section &<<SECTformatonehostitem>>&.
23694
23695 Fallback hosts can also be specified on routers, which associate them with the
23696 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23697 &%fallback_hosts%& specified on the transport is used only if the address does
23698 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23699 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23700 However, &%hosts_randomize%& does apply to fallback host lists.
23701
23702 If Exim is unable to deliver to any of the hosts for a particular address, and
23703 the errors are not permanent rejections, the address is put on a separate
23704 transport queue with its host list replaced by the fallback hosts, unless the
23705 address was routed via MX records and the current host was in the original MX
23706 list. In that situation, the fallback host list is not used.
23707
23708 Once normal deliveries are complete, the fallback queue is delivered by
23709 re-running the same transports with the new host lists. If several failing
23710 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23711 copy of the message is sent.
23712
23713 The resolution of the host names on the fallback list is controlled by the
23714 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23715 both to cases when the host list comes with the address and when it is taken
23716 from &%hosts%&. This option provides a &"use a smart host only if delivery
23717 fails"& facility.
23718
23719
23720 .option final_timeout smtp time 10m
23721 This is the timeout that applies while waiting for the response to the final
23722 line containing just &"."& that terminates a message. Its value must not be
23723 zero.
23724
23725 .option gethostbyname smtp boolean false
23726 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23727 being used, names are looked up using &[gethostbyname()]&
23728 (or &[getipnodebyname()]& when available)
23729 instead of using the DNS. Of course, that function may in fact use the DNS, but
23730 it may also consult other sources of information such as &_/etc/hosts_&.
23731
23732 .option gnutls_compat_mode smtp boolean unset
23733 This option controls whether GnuTLS is used in compatibility mode in an Exim
23734 server. This reduces security slightly, but improves interworking with older
23735 implementations of TLS.
23736
23737 .option helo_data smtp string&!! "see below"
23738 .cindex "HELO" "argument, setting"
23739 .cindex "EHLO" "argument, setting"
23740 .cindex "LHLO argument setting"
23741 The value of this option is expanded after a connection to a another host has
23742 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23743 command that starts the outgoing SMTP or LMTP session. The default value of the
23744 option is:
23745 .code
23746 $primary_hostname
23747 .endd
23748 During the expansion, the variables &$host$& and &$host_address$& are set to
23749 the identity of the remote host, and the variables &$sending_ip_address$& and
23750 &$sending_port$& are set to the local IP address and port number that are being
23751 used. These variables can be used to generate different values for different
23752 servers or different local IP addresses. For example, if you want the string
23753 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23754 interface address, you could use this:
23755 .code
23756 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23757   {$primary_hostname}}
23758 .endd
23759 The use of &%helo_data%& applies both to sending messages and when doing
23760 callouts.
23761
23762 .option hosts smtp "string list&!!" unset
23763 Hosts are associated with an address by a router such as &(dnslookup)&, which
23764 finds the hosts by looking up the address domain in the DNS, or by
23765 &(manualroute)&, which has lists of hosts in its configuration. However,
23766 email addresses can be passed to the &(smtp)& transport by any router, and not
23767 all of them can provide an associated list of hosts.
23768
23769 The &%hosts%& option specifies a list of hosts to be used if the address being
23770 processed does not have any hosts associated with it. The hosts specified by
23771 &%hosts%& are also used, whether or not the address has its own hosts, if
23772 &%hosts_override%& is set.
23773
23774 The string is first expanded, before being interpreted as a colon-separated
23775 list of host names or IP addresses, possibly including port numbers. The
23776 separator may be changed to something other than colon, as described in section
23777 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23778 item in a &%route_list%& setting for the &(manualroute)& router, as described
23779 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23780 of the &(manualroute)& router is not available here.
23781
23782 If the expansion fails, delivery is deferred. Unless the failure was caused by
23783 the inability to complete a lookup, the error is logged to the panic log as
23784 well as the main log. Host names are looked up either by searching directly for
23785 address records in the DNS or by calling &[gethostbyname()]& (or
23786 &[getipnodebyname()]& when available), depending on the setting of the
23787 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23788 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23789 address are used.
23790
23791 During delivery, the hosts are tried in order, subject to their retry status,
23792 unless &%hosts_randomize%& is set.
23793
23794
23795 .option hosts_avoid_esmtp smtp "host list&!!" unset
23796 .cindex "ESMTP, avoiding use of"
23797 .cindex "HELO" "forcing use of"
23798 .cindex "EHLO" "avoiding use of"
23799 .cindex "PIPELINING" "avoiding the use of"
23800 This option is for use with broken hosts that announce ESMTP facilities (for
23801 example, PIPELINING) and then fail to implement them properly. When a host
23802 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23803 start of the SMTP session. This means that it cannot use any of the ESMTP
23804 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23805
23806
23807 .option hosts_avoid_pipelining smtp "host list&!!" unset
23808 .cindex "PIPELINING" "avoiding the use of"
23809 Exim will not use the SMTP PIPELINING extension when delivering to any host
23810 that matches this list, even if the server host advertises PIPELINING support.
23811
23812
23813 .option hosts_avoid_tls smtp "host list&!!" unset
23814 .cindex "TLS" "avoiding for certain hosts"
23815 Exim will not try to start a TLS session when delivering to any host that
23816 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23817
23818 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23819 .cindex "TLS" "avoiding for certain hosts"
23820 Exim will not try to start a TLS session for a verify callout,
23821 or when delivering in cutthrough mode,
23822 to any host that matches this list.
23823
23824
23825 .option hosts_max_try smtp integer 5
23826 .cindex "host" "maximum number to try"
23827 .cindex "limit" "number of hosts tried"
23828 .cindex "limit" "number of MX tried"
23829 .cindex "MX record" "maximum tried"
23830 This option limits the number of IP addresses that are tried for any one
23831 delivery in cases where there are temporary delivery errors. Section
23832 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23833
23834
23835 .option hosts_max_try_hardlimit smtp integer 50
23836 This is an additional check on the maximum number of IP addresses that Exim
23837 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23838 why it exists.
23839
23840
23841
23842 .option hosts_nopass_tls smtp "host list&!!" unset
23843 .cindex "TLS" "passing connection"
23844 .cindex "multiple SMTP deliveries"
23845 .cindex "TLS" "multiple message deliveries"
23846 For any host that matches this list, a connection on which a TLS session has
23847 been started will not be passed to a new delivery process for sending another
23848 message on the same connection. See section &<<SECTmulmessam>>& for an
23849 explanation of when this might be needed.
23850
23851
23852 .option hosts_override smtp boolean false
23853 If this option is set and the &%hosts%& option is also set, any hosts that are
23854 attached to the address are ignored, and instead the hosts specified by the
23855 &%hosts%& option are always used. This option does not apply to
23856 &%fallback_hosts%&.
23857
23858
23859 .option hosts_randomize smtp boolean false
23860 .cindex "randomized host list"
23861 .cindex "host" "list of; randomized"
23862 .cindex "fallback" "randomized hosts"
23863 If this option is set, and either the list of hosts is taken from the
23864 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23865 were not obtained from MX records (this includes fallback hosts from the
23866 router), and were not randomized by the router, the order of trying the hosts
23867 is randomized each time the transport runs. Randomizing the order of a host
23868 list can be used to do crude load sharing.
23869
23870 When &%hosts_randomize%& is true, a host list may be split into groups whose
23871 order is separately randomized. This makes it possible to set up MX-like
23872 behaviour. The boundaries between groups are indicated by an item that is just
23873 &`+`& in the host list. For example:
23874 .code
23875 hosts = host1:host2:host3:+:host4:host5
23876 .endd
23877 The order of the first three hosts and the order of the last two hosts is
23878 randomized for each use, but the first three always end up before the last two.
23879 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23880
23881 .option hosts_require_auth smtp "host list&!!" unset
23882 .cindex "authentication" "required by client"
23883 This option provides a list of servers for which authentication must succeed
23884 before Exim will try to transfer a message. If authentication fails for
23885 servers which are not in this list, Exim tries to send unauthenticated. If
23886 authentication fails for one of these servers, delivery is deferred. This
23887 temporary error is detectable in the retry rules, so it can be turned into a
23888 hard failure if required. See also &%hosts_try_auth%&, and chapter
23889 &<<CHAPSMTPAUTH>>& for details of authentication.
23890
23891
23892 .option hosts_request_ocsp smtp "host list&!!" *
23893 .cindex "TLS" "requiring for certain servers"
23894 Exim will request a Certificate Status on a
23895 TLS session for any host that matches this list.
23896 &%tls_verify_certificates%& should also be set for the transport.
23897
23898 .option hosts_require_ocsp smtp "host list&!!" unset
23899 .cindex "TLS" "requiring for certain servers"
23900 Exim will request, and check for a valid Certificate Status being given, on a
23901 TLS session for any host that matches this list.
23902 &%tls_verify_certificates%& should also be set for the transport.
23903
23904 .option hosts_require_tls smtp "host list&!!" unset
23905 .cindex "TLS" "requiring for certain servers"
23906 Exim will insist on using a TLS session when delivering to any host that
23907 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23908 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23909 incoming messages, use an appropriate ACL.
23910
23911 .option hosts_try_auth smtp "host list&!!" unset
23912 .cindex "authentication" "optional in client"
23913 This option provides a list of servers to which, provided they announce
23914 authentication support, Exim will attempt to authenticate as a client when it
23915 connects. If authentication fails, Exim will try to transfer the message
23916 unauthenticated. See also &%hosts_require_auth%&, and chapter
23917 &<<CHAPSMTPAUTH>>& for details of authentication.
23918
23919 .new
23920 .option hosts_try_chunking smtp "host list&!!" *
23921 .cindex CHUNKING "enabling, in client"
23922 .cindex BDAT "SMTP command"
23923 .cindex "RFC 3030" "CHUNKING"
23924 This option provides a list of server to which, provided they announce
23925 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
23926 BDAT will not be used in conjuction with a transport filter.
23927 .wen
23928
23929 .option hosts_try_prdr smtp "host list&!!" *
23930 .cindex "PRDR" "enabling, optional in client"
23931 This option provides a list of servers to which, provided they announce
23932 PRDR support, Exim will attempt to negotiate PRDR
23933 for multi-recipient messages.
23934 The option can usually be left as default.
23935
23936 .option interface smtp "string list&!!" unset
23937 .cindex "bind IP address"
23938 .cindex "IP address" "binding"
23939 .vindex "&$host$&"
23940 .vindex "&$host_address$&"
23941 This option specifies which interface to bind to when making an outgoing SMTP
23942 call. The value is an IP address, not an interface name such as
23943 &`eth0`&. Do not confuse this with the interface address that was used when a
23944 message was received, which is in &$received_ip_address$&, formerly known as
23945 &$interface_address$&. The name was changed to minimize confusion with the
23946 outgoing interface address. There is no variable that contains an outgoing
23947 interface address because, unless it is set by this option, its value is
23948 unknown.
23949
23950 During the expansion of the &%interface%& option the variables &$host$& and
23951 &$host_address$& refer to the host to which a connection is about to be made
23952 during the expansion of the string. Forced expansion failure, or an empty
23953 string result causes the option to be ignored. Otherwise, after expansion, the
23954 string must be a list of IP addresses, colon-separated by default, but the
23955 separator can be changed in the usual way. For example:
23956 .code
23957 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23958 .endd
23959 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23960 connection. If none of them are the correct type, the option is ignored. If
23961 &%interface%& is not set, or is ignored, the system's IP functions choose which
23962 interface to use if the host has more than one.
23963
23964
23965 .option keepalive smtp boolean true
23966 .cindex "keepalive" "on outgoing connection"
23967 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23968 connections. When set, it causes the kernel to probe idle connections
23969 periodically, by sending packets with &"old"& sequence numbers. The other end
23970 of the connection should send a acknowledgment if the connection is still okay
23971 or a reset if the connection has been aborted. The reason for doing this is
23972 that it has the beneficial effect of freeing up certain types of connection
23973 that can get stuck when the remote host is disconnected without tidying up the
23974 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23975 unreachable hosts.
23976
23977
23978 .option lmtp_ignore_quota smtp boolean false
23979 .cindex "LMTP" "ignoring quota errors"
23980 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23981 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23982 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23983
23984 .option max_rcpt smtp integer 100
23985 .cindex "RCPT" "maximum number of outgoing"
23986 This option limits the number of RCPT commands that are sent in a single
23987 SMTP message transaction. Each set of addresses is treated independently, and
23988 so can cause parallel connections to the same host if &%remote_max_parallel%&
23989 permits this.
23990
23991
23992 .option multi_domain smtp boolean&!! true
23993 .vindex "&$domain$&"
23994 When this option is set, the &(smtp)& transport can handle a number of
23995 addresses containing a mixture of different domains provided they all resolve
23996 to the same list of hosts. Turning the option off restricts the transport to
23997 handling only one domain at a time. This is useful if you want to use
23998 &$domain$& in an expansion for the transport, because it is set only when there
23999 is a single domain involved in a remote delivery.
24000
24001 It is expanded per-address and can depend on any of
24002 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24003 &$host$&, &$host_address$& and &$host_port$&.
24004
24005 .option port smtp string&!! "see below"
24006 .cindex "port" "sending TCP/IP"
24007 .cindex "TCP/IP" "setting outgoing port"
24008 This option specifies the TCP/IP port on the server to which Exim connects.
24009 &*Note:*& Do not confuse this with the port that was used when a message was
24010 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24011 The name was changed to minimize confusion with the outgoing port. There is no
24012 variable that contains an outgoing port.
24013
24014 If the value of this option begins with a digit it is taken as a port number;
24015 otherwise it is looked up using &[getservbyname()]&. The default value is
24016 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24017 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24018 is deferred.
24019
24020
24021
24022 .option protocol smtp string smtp
24023 .cindex "LMTP" "over TCP/IP"
24024 .cindex "ssmtp protocol" "outbound"
24025 .cindex "TLS" "SSL-on-connect outbound"
24026 .vindex "&$port$&"
24027 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24028 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24029 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24030 deliveries into closed message stores. Exim also has support for running LMTP
24031 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24032
24033 If this option is set to &"smtps"&, the default value for the &%port%& option
24034 changes to &"smtps"&, and the transport initiates TLS immediately after
24035 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24036 The Internet standards bodies strongly discourage use of this mode.
24037
24038
24039 .option retry_include_ip_address smtp boolean&!! true
24040 Exim normally includes both the host name and the IP address in the key it
24041 constructs for indexing retry data after a temporary delivery failure. This
24042 means that when one of several IP addresses for a host is failing, it gets
24043 tried periodically (controlled by the retry rules), but use of the other IP
24044 addresses is not affected.
24045
24046 However, in some dialup environments hosts are assigned a different IP address
24047 each time they connect. In this situation the use of the IP address as part of
24048 the retry key leads to undesirable behaviour. Setting this option false causes
24049 Exim to use only the host name.
24050 Since it is expanded it can be made to depend on the host or domain.
24051
24052
24053 .option serialize_hosts smtp "host list&!!" unset
24054 .cindex "serializing connections"
24055 .cindex "host" "serializing connections"
24056 Because Exim operates in a distributed manner, if several messages for the same
24057 host arrive at around the same time, more than one simultaneous connection to
24058 the remote host can occur. This is not usually a problem except when there is a
24059 slow link between the hosts. In that situation it may be helpful to restrict
24060 Exim to one connection at a time. This can be done by setting
24061 &%serialize_hosts%& to match the relevant hosts.
24062
24063 .cindex "hints database" "serializing deliveries to a host"
24064 Exim implements serialization by means of a hints database in which a record is
24065 written whenever a process connects to one of the restricted hosts. The record
24066 is deleted when the connection is completed. Obviously there is scope for
24067 records to get left lying around if there is a system or program crash. To
24068 guard against this, Exim ignores any records that are more than six hours old.
24069
24070 If you set up this kind of serialization, you should also arrange to delete the
24071 relevant hints database whenever your system reboots. The names of the files
24072 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24073 may be one or two files, depending on the type of DBM in use. The same files
24074 are used for ETRN serialization.
24075
24076 See also the &%max_parallel%& generic transport option.
24077
24078
24079 .option size_addition smtp integer 1024
24080 .cindex "SMTP" "SIZE"
24081 .cindex "message" "size issue for transport filter"
24082 .cindex "size" "of message"
24083 .cindex "transport" "filter"
24084 .cindex "filter" "transport filter"
24085 If a remote SMTP server indicates that it supports the SIZE option of the
24086 MAIL command, Exim uses this to pass over the message size at the start of
24087 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24088 sends, to allow for headers and other text that may be added during delivery by
24089 configuration options or in a transport filter. It may be necessary to increase
24090 this if a lot of text is added to messages.
24091
24092 Alternatively, if the value of &%size_addition%& is set negative, it disables
24093 the use of the SIZE option altogether.
24094
24095
24096 .option socks_proxy smtp string&!! unset
24097 .cindex proxy SOCKS
24098 This option enables use of SOCKS proxies for connections made by the
24099 transport.  For details see &<<SECTproxySOCKS>>&.
24100
24101
24102 .option tls_certificate smtp string&!! unset
24103 .cindex "TLS" "client certificate, location of"
24104 .cindex "certificate" "client, location of"
24105 .vindex "&$host$&"
24106 .vindex "&$host_address$&"
24107 The value of this option must be the absolute path to a file which contains the
24108 client's certificate, for possible use when sending a message over an encrypted
24109 connection. The values of &$host$& and &$host_address$& are set to the name and
24110 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24111 details of TLS.
24112
24113 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24114 certificate when sending messages as a client. The global option of the same
24115 name specifies the certificate for Exim as a server; it is not automatically
24116 assumed that the same certificate should be used when Exim is operating as a
24117 client.
24118
24119
24120 .option tls_crl smtp string&!! unset
24121 .cindex "TLS" "client certificate revocation list"
24122 .cindex "certificate" "revocation list for client"
24123 This option specifies a certificate revocation list. The expanded value must
24124 be the name of a file that contains a CRL in PEM format.
24125
24126
24127 .option tls_dh_min_bits smtp integer 1024
24128 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24129 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24130 key agreement is negotiated, the server will provide a large prime number
24131 for use.  This option establishes the minimum acceptable size of that number.
24132 If the parameter offered by the server is too small, then the TLS handshake
24133 will fail.
24134
24135 Only supported when using GnuTLS.
24136
24137
24138 .option tls_privatekey smtp string&!! unset
24139 .cindex "TLS" "client private key, location of"
24140 .vindex "&$host$&"
24141 .vindex "&$host_address$&"
24142 The value of this option must be the absolute path to a file which contains the
24143 client's private key. This is used when sending a message over an encrypted
24144 connection using a client certificate. The values of &$host$& and
24145 &$host_address$& are set to the name and address of the server during the
24146 expansion. If this option is unset, or the expansion is forced to fail, or the
24147 result is an empty string, the private key is assumed to be in the same file as
24148 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24149
24150
24151 .option tls_require_ciphers smtp string&!! unset
24152 .cindex "TLS" "requiring specific ciphers"
24153 .cindex "cipher" "requiring specific"
24154 .vindex "&$host$&"
24155 .vindex "&$host_address$&"
24156 The value of this option must be a list of permitted cipher suites, for use
24157 when setting up an outgoing encrypted connection. (There is a global option of
24158 the same name for controlling incoming connections.) The values of &$host$& and
24159 &$host_address$& are set to the name and address of the server during the
24160 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24161 is used in different ways by OpenSSL and GnuTLS (see sections
24162 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24163 ciphers is a preference order.
24164
24165
24166
24167 .option tls_sni smtp string&!! unset
24168 .cindex "TLS" "Server Name Indication"
24169 .vindex "&$tls_sni$&"
24170 If this option is set then it sets the $tls_out_sni variable and causes any
24171 TLS session to pass this value as the Server Name Indication extension to
24172 the remote side, which can be used by the remote side to select an appropriate
24173 certificate and private key for the session.
24174
24175 See &<<SECTtlssni>>& for more information.
24176
24177 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24178 TLS extensions.
24179
24180
24181
24182
24183 .option tls_tempfail_tryclear smtp boolean true
24184 .cindex "4&'xx'& responses" "to STARTTLS"
24185 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24186 setting up a TLS session, this option determines whether or not Exim should try
24187 to deliver the message unencrypted. If it is set false, delivery to the
24188 current host is deferred; if there are other hosts, they are tried. If this
24189 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24190 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24191 TLS negotiation fails, Exim closes the current connection (because it is in an
24192 unknown state), opens a new one to the same host, and then tries the delivery
24193 in clear.
24194
24195
24196 .option tls_try_verify_hosts smtp "host list&!!" *
24197 .cindex "TLS" "server certificate verification"
24198 .cindex "certificate" "verification of server"
24199 This option gives a list of hosts for which, on encrypted connections,
24200 certificate verification will be tried but need not succeed.
24201 The &%tls_verify_certificates%& option must also be set.
24202 Note that unless the host is in this list
24203 TLS connections will be denied to hosts using self-signed certificates
24204 when &%tls_verify_certificates%& is matched.
24205 The &$tls_out_certificate_verified$& variable is set when
24206 certificate verification succeeds.
24207
24208
24209 .option tls_verify_cert_hostnames smtp "host list&!!" *
24210 .cindex "TLS" "server certificate hostname verification"
24211 .cindex "certificate" "verification of server"
24212 This option give a list of hosts for which,
24213 while verifying the server certificate,
24214 checks will be included on the host name
24215 (note that this will generally be the result of a DNS MX lookup)
24216 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24217 limited to being the initial component of a 3-or-more component FQDN.
24218
24219 There is no equivalent checking on client certificates.
24220
24221
24222 .option tls_verify_certificates smtp string&!! system
24223 .cindex "TLS" "server certificate verification"
24224 .cindex "certificate" "verification of server"
24225 .vindex "&$host$&"
24226 .vindex "&$host_address$&"
24227 The value of this option must be either the
24228 word "system"
24229 or the absolute path to
24230 a file or directory containing permitted certificates for servers,
24231 for use when setting up an encrypted connection.
24232
24233 The "system" value for the option will use a location compiled into the SSL library.
24234 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24235 is taken as empty and an explicit location
24236 must be specified.
24237
24238 The use of a directory for the option value is not available for GnuTLS versions
24239 preceding 3.3.6 and a single file must be used.
24240
24241 With OpenSSL the certificates specified
24242 explicitly
24243 either by file or directory
24244 are added to those given by the system default location.
24245
24246 The values of &$host$& and
24247 &$host_address$& are set to the name and address of the server during the
24248 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24249
24250 For back-compatibility,
24251 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24252 (a single-colon empty list counts as being set)
24253 and certificate verification fails the TLS connection is closed.
24254
24255
24256 .option tls_verify_hosts smtp "host list&!!" unset
24257 .cindex "TLS" "server certificate verification"
24258 .cindex "certificate" "verification of server"
24259 This option gives a list of hosts for which, on encrypted connections,
24260 certificate verification must succeed.
24261 The &%tls_verify_certificates%& option must also be set.
24262 If both this option and &%tls_try_verify_hosts%& are unset
24263 operation is as if this option selected all hosts.
24264
24265
24266
24267
24268 .section "How the limits for the number of hosts to try are used" &&&
24269          "SECTvalhosmax"
24270 .cindex "host" "maximum number to try"
24271 .cindex "limit" "hosts; maximum number tried"
24272 There are two options that are concerned with the number of hosts that are
24273 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24274 &%hosts_max_try_hardlimit%&.
24275
24276
24277 The &%hosts_max_try%& option limits the number of hosts that are tried
24278 for a single delivery. However, despite the term &"host"& in its name, the
24279 option actually applies to each IP address independently. In other words, a
24280 multihomed host is treated as several independent hosts, just as it is for
24281 retrying.
24282
24283 Many of the larger ISPs have multiple MX records which often point to
24284 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24285 created as a result of routing one of these domains.
24286
24287 Trying every single IP address on such a long list does not seem sensible; if
24288 several at the top of the list fail, it is reasonable to assume there is some
24289 problem that is likely to affect all of them. Roughly speaking, the value of
24290 &%hosts_max_try%& is the maximum number that are tried before deferring the
24291 delivery. However, the logic cannot be quite that simple.
24292
24293 Firstly, IP addresses that are skipped because their retry times have not
24294 arrived do not count, and in addition, addresses that are past their retry
24295 limits are also not counted, even when they are tried. This means that when
24296 some IP addresses are past their retry limits, more than the value of
24297 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24298 that all IP addresses are considered before timing out an email address (but
24299 see below for an exception).
24300
24301 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24302 list to see if there is a subsequent host with a different (higher valued) MX.
24303 If there is, that host is considered next, and the current IP address is used
24304 but not counted. This behaviour helps in the case of a domain with a retry rule
24305 that hardly ever delays any hosts, as is now explained:
24306
24307 Consider the case of a long list of hosts with one MX value, and a few with a
24308 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24309 hosts at the top of the list are tried at first. With the default retry rule,
24310 which specifies increasing retry times, the higher MX hosts are eventually
24311 tried when those at the top of the list are skipped because they have not
24312 reached their retry times.
24313
24314 However, it is common practice to put a fixed short retry time on domains for
24315 large ISPs, on the grounds that their servers are rarely down for very long.
24316 Unfortunately, these are exactly the domains that tend to resolve to long lists
24317 of hosts. The short retry time means that the lowest MX hosts are tried every
24318 time. The attempts may be in a different order because of random sorting, but
24319 without the special MX check, the higher MX hosts would never be tried until
24320 all the lower MX hosts had timed out (which might be several days), because
24321 there are always some lower MX hosts that have reached their retry times. With
24322 the special check, Exim considers at least one IP address from each MX value at
24323 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24324 reached.
24325
24326 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24327 particular, Exim normally eventually tries all the IP addresses before timing
24328 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24329 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24330 been set up with hundreds of IP addresses for some domains. It can
24331 take a very long time indeed for an address to time out in these cases.
24332
24333 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24334 Exim never tries more than this number of IP addresses; if it hits this limit
24335 and they are all timed out, the email address is bounced, even though not all
24336 possible IP addresses have been tried.
24337 .ecindex IIDsmttra1
24338 .ecindex IIDsmttra2
24339
24340
24341
24342
24343
24344 . ////////////////////////////////////////////////////////////////////////////
24345 . ////////////////////////////////////////////////////////////////////////////
24346
24347 .chapter "Address rewriting" "CHAPrewrite"
24348 .scindex IIDaddrew "rewriting" "addresses"
24349 There are some circumstances in which Exim automatically rewrites domains in
24350 addresses. The two most common are when an address is given without a domain
24351 (referred to as an &"unqualified address"&) or when an address contains an
24352 abbreviated domain that is expanded by DNS lookup.
24353
24354 Unqualified envelope addresses are accepted only for locally submitted
24355 messages, or for messages that are received from hosts matching
24356 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24357 appropriate. Unqualified addresses in header lines are qualified if they are in
24358 locally submitted messages, or messages from hosts that are permitted to send
24359 unqualified envelope addresses. Otherwise, unqualified addresses in header
24360 lines are neither qualified nor rewritten.
24361
24362 One situation in which Exim does &'not'& automatically rewrite a domain is
24363 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24364 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24365 do this. The new RFCs do not contain this suggestion.
24366
24367
24368 .section "Explicitly configured address rewriting" "SECID147"
24369 This chapter describes the rewriting rules that can be used in the
24370 main rewrite section of the configuration file, and also in the generic
24371 &%headers_rewrite%& option that can be set on any transport.
24372
24373 Some people believe that configured address rewriting is a Mortal Sin.
24374 Others believe that life is not possible without it. Exim provides the
24375 facility; you do not have to use it.
24376
24377 The main rewriting rules that appear in the &"rewrite"& section of the
24378 configuration file are applied to addresses in incoming messages, both envelope
24379 addresses and addresses in header lines. Each rule specifies the types of
24380 address to which it applies.
24381
24382 Whether or not addresses in header lines are rewritten depends on the origin of
24383 the headers and the type of rewriting. Global rewriting, that is, rewriting
24384 rules from the rewrite section of the configuration file, is applied only to
24385 those headers that were received with the message. Header lines that are added
24386 by ACLs or by a system filter or by individual routers or transports (which
24387 are specific to individual recipient addresses) are not rewritten by the global
24388 rules.
24389
24390 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24391 applies all headers except those added by routers and transports. That is, as
24392 well as the headers that were received with the message, it also applies to
24393 headers that were added by an ACL or a system filter.
24394
24395
24396 In general, rewriting addresses from your own system or domain has some
24397 legitimacy. Rewriting other addresses should be done only with great care and
24398 in special circumstances. The author of Exim believes that rewriting should be
24399 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24400 Although it can sometimes be used as a routing tool, this is very strongly
24401 discouraged.
24402
24403 There are two commonly encountered circumstances where rewriting is used, as
24404 illustrated by these examples:
24405
24406 .ilist
24407 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24408 exchange mail with each other behind a firewall, but there is only a single
24409 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24410 &'hitch.fict.example'& when sending mail off-site.
24411 .next
24412 A host rewrites the local parts of its own users so that, for example,
24413 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24414 .endlist
24415
24416
24417
24418 .section "When does rewriting happen?" "SECID148"
24419 .cindex "rewriting" "timing of"
24420 .cindex "&ACL;" "rewriting addresses in"
24421 Configured address rewriting can take place at several different stages of a
24422 message's processing.
24423
24424 .vindex "&$sender_address$&"
24425 At the start of an ACL for MAIL, the sender address may have been rewritten
24426 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24427 ordinary rewrite rules have yet been applied. If, however, the sender address
24428 is verified in the ACL, it is rewritten before verification, and remains
24429 rewritten thereafter. The subsequent value of &$sender_address$& is the
24430 rewritten address. This also applies if sender verification happens in a
24431 RCPT ACL. Otherwise, when the sender address is not verified, it is
24432 rewritten as soon as a message's header lines have been received.
24433
24434 .vindex "&$domain$&"
24435 .vindex "&$local_part$&"
24436 Similarly, at the start of an ACL for RCPT, the current recipient's address
24437 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24438 rewrite rules have yet been applied to it. However, the behaviour is different
24439 from the sender address when a recipient is verified. The address is rewritten
24440 for the verification, but the rewriting is not remembered at this stage. The
24441 value of &$local_part$& and &$domain$& after verification are always the same
24442 as they were before (that is, they contain the unrewritten &-- except for
24443 SMTP-time rewriting &-- address).
24444
24445 As soon as a message's header lines have been received, all the envelope
24446 recipient addresses are permanently rewritten, and rewriting is also applied to
24447 the addresses in the header lines (if configured). This happens before adding
24448 any header lines that were specified in MAIL or RCPT ACLs, and
24449 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24450 before the DATA ACL and &[local_scan()]& functions are run.
24451
24452 When an address is being routed, either for delivery or for verification,
24453 rewriting is applied immediately to child addresses that are generated by
24454 redirection, unless &%no_rewrite%& is set on the router.
24455
24456 .cindex "envelope sender" "rewriting at transport time"
24457 .cindex "rewriting" "at transport time"
24458 .cindex "header lines" "rewriting at transport time"
24459 At transport time, additional rewriting of addresses in header lines can be
24460 specified by setting the generic &%headers_rewrite%& option on a transport.
24461 This option contains rules that are identical in form to those in the rewrite
24462 section of the configuration file. They are applied to the original message
24463 header lines and any that were added by ACLs or a system filter. They are not
24464 applied to header lines that are added by routers or the transport.
24465
24466 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24467 transport option. However, it is not possible to rewrite envelope recipients at
24468 transport time.
24469
24470
24471
24472
24473 .section "Testing the rewriting rules that apply on input" "SECID149"
24474 .cindex "rewriting" "testing"
24475 .cindex "testing" "rewriting"
24476 Exim's input rewriting configuration appears in a part of the run time
24477 configuration file headed by &"begin rewrite"&. It can be tested by the
24478 &%-brw%& command line option. This takes an address (which can be a full RFC
24479 2822 address) as its argument. The output is a list of how the address would be
24480 transformed by the rewriting rules for each of the different places it might
24481 appear in an incoming message, that is, for each different header and for the
24482 envelope sender and recipient fields. For example,
24483 .code
24484 exim -brw ph10@exim.workshop.example
24485 .endd
24486 might produce the output
24487 .code
24488 sender: Philip.Hazel@exim.workshop.example
24489 from: Philip.Hazel@exim.workshop.example
24490 to: ph10@exim.workshop.example
24491 cc: ph10@exim.workshop.example
24492 bcc: ph10@exim.workshop.example
24493 reply-to: Philip.Hazel@exim.workshop.example
24494 env-from: Philip.Hazel@exim.workshop.example
24495 env-to: ph10@exim.workshop.example
24496 .endd
24497 which shows that rewriting has been set up for that address when used in any of
24498 the source fields, but not when it appears as a recipient address. At the
24499 present time, there is no equivalent way of testing rewriting rules that are
24500 set for a particular transport.
24501
24502
24503 .section "Rewriting rules" "SECID150"
24504 .cindex "rewriting" "rules"
24505 The rewrite section of the configuration file consists of lines of rewriting
24506 rules in the form
24507 .display
24508 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24509 .endd
24510 Rewriting rules that are specified for the &%headers_rewrite%& generic
24511 transport option are given as a colon-separated list. Each item in the list
24512 takes the same form as a line in the main rewriting configuration (except that
24513 any colons must be doubled, of course).
24514
24515 The formats of source patterns and replacement strings are described below.
24516 Each is terminated by white space, unless enclosed in double quotes, in which
24517 case normal quoting conventions apply inside the quotes. The flags are single
24518 characters which may appear in any order. Spaces and tabs between them are
24519 ignored.
24520
24521 For each address that could potentially be rewritten, the rules are scanned in
24522 order, and replacements for the address from earlier rules can themselves be
24523 replaced by later rules (but see the &"q"& and &"R"& flags).
24524
24525 The order in which addresses are rewritten is undefined, may change between
24526 releases, and must not be relied on, with one exception: when a message is
24527 received, the envelope sender is always rewritten first, before any header
24528 lines are rewritten. For example, the replacement string for a rewrite of an
24529 address in &'To:'& must not assume that the message's address in &'From:'& has
24530 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24531 that the envelope sender has already been rewritten.
24532
24533 .vindex "&$domain$&"
24534 .vindex "&$local_part$&"
24535 The variables &$local_part$& and &$domain$& can be used in the replacement
24536 string to refer to the address that is being rewritten. Note that lookup-driven
24537 rewriting can be done by a rule of the form
24538 .code
24539 *@*   ${lookup ...
24540 .endd
24541 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24542 refer to the address that is being rewritten.
24543
24544
24545 .section "Rewriting patterns" "SECID151"
24546 .cindex "rewriting" "patterns"
24547 .cindex "address list" "in a rewriting pattern"
24548 The source pattern in a rewriting rule is any item which may appear in an
24549 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24550 single-item address list, which means that it is expanded before being tested
24551 against the address. As always, if you use a regular expression as a pattern,
24552 you must take care to escape dollar and backslash characters, or use the &`\N`&
24553 facility to suppress string expansion within the regular expression.
24554
24555 Domains in patterns should be given in lower case. Local parts in patterns are
24556 case-sensitive. If you want to do case-insensitive matching of local parts, you
24557 can use a regular expression that starts with &`^(?i)`&.
24558
24559 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24560 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24561 depending on the type of match which occurred. These can be used in the
24562 replacement string to insert portions of the incoming address. &$0$& always
24563 refers to the complete incoming address. When a regular expression is used, the
24564 numerical variables are set from its capturing subexpressions. For other types
24565 of pattern they are set as follows:
24566
24567 .ilist
24568 If a local part or domain starts with an asterisk, the numerical variables
24569 refer to the character strings matched by asterisks, with &$1$& associated with
24570 the first asterisk, and &$2$& with the second, if present. For example, if the
24571 pattern
24572 .code
24573 *queen@*.fict.example
24574 .endd
24575 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24576 .code
24577 $0 = hearts-queen@wonderland.fict.example
24578 $1 = hearts-
24579 $2 = wonderland
24580 .endd
24581 Note that if the local part does not start with an asterisk, but the domain
24582 does, it is &$1$& that contains the wild part of the domain.
24583
24584 .next
24585 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24586 of the domain are placed in the next available numerical variables. Suppose,
24587 for example, that the address &'foo@bar.baz.example'& is processed by a
24588 rewriting rule of the form
24589 .display
24590 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24591 .endd
24592 and the key in the file that matches the domain is &`*.baz.example`&. Then
24593 .code
24594 $1 = foo
24595 $2 = bar
24596 $3 = baz.example
24597 .endd
24598 If the address &'foo@baz.example'& is looked up, this matches the same
24599 wildcard file entry, and in this case &$2$& is set to the empty string, but
24600 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24601 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24602 whole domain. For non-partial domain lookups, no numerical variables are set.
24603 .endlist
24604
24605
24606 .section "Rewriting replacements" "SECID152"
24607 .cindex "rewriting" "replacements"
24608 If the replacement string for a rule is a single asterisk, addresses that
24609 match the pattern and the flags are &'not'& rewritten, and no subsequent
24610 rewriting rules are scanned. For example,
24611 .code
24612 hatta@lookingglass.fict.example  *  f
24613 .endd
24614 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24615 &'From:'& headers.
24616
24617 .vindex "&$domain$&"
24618 .vindex "&$local_part$&"
24619 If the replacement string is not a single asterisk, it is expanded, and must
24620 yield a fully qualified address. Within the expansion, the variables
24621 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24622 Any letters they contain retain their original case &-- they are not lower
24623 cased. The numerical variables are set up according to the type of pattern that
24624 matched the address, as described above. If the expansion is forced to fail by
24625 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24626 current rule is abandoned, but subsequent rules may take effect. Any other
24627 expansion failure causes the entire rewriting operation to be abandoned, and an
24628 entry written to the panic log.
24629
24630
24631
24632 .section "Rewriting flags" "SECID153"
24633 There are three different kinds of flag that may appear on rewriting rules:
24634
24635 .ilist
24636 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24637 c, f, h, r, s, t.
24638 .next
24639 A flag that specifies rewriting at SMTP time: S.
24640 .next
24641 Flags that control the rewriting process: Q, q, R, w.
24642 .endlist
24643
24644 For rules that are part of the &%headers_rewrite%& generic transport option,
24645 E, F, T, and S are not permitted.
24646
24647
24648
24649 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24650          "SECID154"
24651 .cindex "rewriting" "flags"
24652 If none of the following flag letters, nor the &"S"& flag (see section
24653 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24654 and to both the sender and recipient fields of the envelope, whereas a
24655 transport-time rewriting rule just applies to all headers. Otherwise, the
24656 rewriting rule is skipped unless the relevant addresses are being processed.
24657 .display
24658 &`E`&       rewrite all envelope fields
24659 &`F`&       rewrite the envelope From field
24660 &`T`&       rewrite the envelope To field
24661 &`b`&       rewrite the &'Bcc:'& header
24662 &`c`&       rewrite the &'Cc:'& header
24663 &`f`&       rewrite the &'From:'& header
24664 &`h`&       rewrite all headers
24665 &`r`&       rewrite the &'Reply-To:'& header
24666 &`s`&       rewrite the &'Sender:'& header
24667 &`t`&       rewrite the &'To:'& header
24668 .endd
24669 "All headers" means all of the headers listed above that can be selected
24670 individually, plus their &'Resent-'& versions. It does not include
24671 other headers such as &'Subject:'& etc.
24672
24673 You should be particularly careful about rewriting &'Sender:'& headers, and
24674 restrict this to special known cases in your own domains.
24675
24676
24677 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24678 .cindex "SMTP" "rewriting malformed addresses"
24679 .cindex "RCPT" "rewriting argument of"
24680 .cindex "MAIL" "rewriting argument of"
24681 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24682 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24683 before any other processing; even before syntax checking. The pattern is
24684 required to be a regular expression, and it is matched against the whole of the
24685 data for the command, including any surrounding angle brackets.
24686
24687 .vindex "&$domain$&"
24688 .vindex "&$local_part$&"
24689 This form of rewrite rule allows for the handling of addresses that are not
24690 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24691 input). Because the input is not required to be a syntactically valid address,
24692 the variables &$local_part$& and &$domain$& are not available during the
24693 expansion of the replacement string. The result of rewriting replaces the
24694 original address in the MAIL or RCPT command.
24695
24696
24697 .section "Flags controlling the rewriting process" "SECID155"
24698 There are four flags which control the way the rewriting process works. These
24699 take effect only when a rule is invoked, that is, when the address is of the
24700 correct type (matches the flags) and matches the pattern:
24701
24702 .ilist
24703 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24704 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24705 absence of &"Q"& the rewritten address must always include a domain.
24706 .next
24707 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24708 even if no rewriting actually takes place because of a &"fail"& in the
24709 expansion. The &"q"& flag is not effective if the address is of the wrong type
24710 (does not match the flags) or does not match the pattern.
24711 .next
24712 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24713 address, up to ten times. It can be combined with the &"q"& flag, to stop
24714 rewriting once it fails to match (after at least one successful rewrite).
24715 .next
24716 .cindex "rewriting" "whole addresses"
24717 When an address in a header is rewritten, the rewriting normally applies only
24718 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24719 left unchanged. For example, rewriting might change
24720 .code
24721 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24722 .endd
24723 into
24724 .code
24725 From: Ford Prefect <prefectf@hitch.fict.example>
24726 .endd
24727 .cindex "RFC 2047"
24728 Sometimes there is a need to replace the whole address item, and this can be
24729 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24730 causes an address in a header line to be rewritten, the entire address is
24731 replaced, not just the working part. The replacement must be a complete RFC
24732 2822 address, including the angle brackets if necessary. If text outside angle
24733 brackets contains a character whose value is greater than 126 or less than 32
24734 (except for tab), the text is encoded according to RFC 2047. The character set
24735 is taken from &%headers_charset%&, which gets its default at build time.
24736
24737 When the &"w"& flag is set on a rule that causes an envelope address to be
24738 rewritten, all but the working part of the replacement address is discarded.
24739 .endlist
24740
24741
24742 .section "Rewriting examples" "SECID156"
24743 Here is an example of the two common rewriting paradigms:
24744 .code
24745 *@*.hitch.fict.example  $1@hitch.fict.example
24746 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24747                      {$value}fail}@hitch.fict.example bctfrF
24748 .endd
24749 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24750 the string expansion to fail if the lookup does not succeed. In this context it
24751 has the effect of leaving the original address unchanged, but Exim goes on to
24752 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24753 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24754 explicitly, which would cause the rewritten address to be the same as before,
24755 at the cost of a small bit of processing. Not supplying either of these is an
24756 error, since the rewritten address would then contain no local part.
24757
24758 The first example above replaces the domain with a superior, more general
24759 domain. This may not be desirable for certain local parts. If the rule
24760 .code
24761 root@*.hitch.fict.example  *
24762 .endd
24763 were inserted before the first rule, rewriting would be suppressed for the
24764 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24765
24766 Rewriting can be made conditional on a number of tests, by making use of
24767 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24768 messages that originate outside the local host:
24769 .code
24770 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24771                          {$1@hitch.fict.example}fail}"
24772 .endd
24773 The replacement string is quoted in this example because it contains white
24774 space.
24775
24776 .cindex "rewriting" "bang paths"
24777 .cindex "bang paths" "rewriting"
24778 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24779 an address it treats it as an unqualified local part which it qualifies with
24780 the local qualification domain (if the source of the message is local or if the
24781 remote host is permitted to send unqualified addresses). Rewriting can
24782 sometimes be used to handle simple bang paths with a fixed number of
24783 components. For example, the rule
24784 .code
24785 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24786 .endd
24787 rewrites a two-component bang path &'host.name!user'& as the domain address
24788 &'user@host.name'&. However, there is a security implication in using this as
24789 a global rewriting rule for envelope addresses. It can provide a backdoor
24790 method for using your system as a relay, because the incoming addresses appear
24791 to be local. If the bang path addresses are received via SMTP, it is safer to
24792 use the &"S"& flag to rewrite them as they are received, so that relay checking
24793 can be done on the rewritten addresses.
24794 .ecindex IIDaddrew
24795
24796
24797
24798
24799
24800 . ////////////////////////////////////////////////////////////////////////////
24801 . ////////////////////////////////////////////////////////////////////////////
24802
24803 .chapter "Retry configuration" "CHAPretry"
24804 .scindex IIDretconf1 "retry" "configuration, description of"
24805 .scindex IIDregconf2 "configuration file" "retry section"
24806 The &"retry"& section of the runtime configuration file contains a list of
24807 retry rules that control how often Exim tries to deliver messages that cannot
24808 be delivered at the first attempt. If there are no retry rules (the section is
24809 empty or not present), there are no retries. In this situation, temporary
24810 errors are treated as permanent. The default configuration contains a single,
24811 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24812 line option can be used to test which retry rule will be used for a given
24813 address, domain and error.
24814
24815 The most common cause of retries is temporary failure to deliver to a remote
24816 host because the host is down, or inaccessible because of a network problem.
24817 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24818 address) basis, not on a per-message basis. Thus, if one message has recently
24819 been delayed, delivery of a new message to the same host is not immediately
24820 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24821 log selector is set, the message
24822 .cindex "retry" "time not reached"
24823 &"retry time not reached"& is written to the main log whenever a delivery is
24824 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24825 the handling of errors during remote deliveries.
24826
24827 Retry processing applies to routing as well as to delivering, except as covered
24828 in the next paragraph. The retry rules do not distinguish between these
24829 actions. It is not possible, for example, to specify different behaviour for
24830 failures to route the domain &'snark.fict.example'& and failures to deliver to
24831 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24832 added complication, so did not implement it. However, although they share the
24833 same retry rule, the actual retry times for routing and transporting a given
24834 domain are maintained independently.
24835
24836 When a delivery is not part of a queue run (typically an immediate delivery on
24837 receipt of a message), the routers are always run, and local deliveries are
24838 always attempted, even if retry times are set for them. This makes for better
24839 behaviour if one particular message is causing problems (for example, causing
24840 quota overflow, or provoking an error in a filter file). If such a delivery
24841 suffers a temporary failure, the retry data is updated as normal, and
24842 subsequent delivery attempts from queue runs occur only when the retry time for
24843 the local address is reached.
24844
24845 .section "Changing retry rules" "SECID157"
24846 If you change the retry rules in your configuration, you should consider
24847 whether or not to delete the retry data that is stored in Exim's spool area in
24848 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24849 always safe; that is why they are called &"hints"&.
24850
24851 The hints retry data contains suggested retry times based on the previous
24852 rules. In the case of a long-running problem with a remote host, it might
24853 record the fact that the host has timed out. If your new rules increase the
24854 timeout time for such a host, you should definitely remove the old retry data
24855 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24856 messages that it should now be retaining.
24857
24858
24859
24860 .section "Format of retry rules" "SECID158"
24861 .cindex "retry" "rules"
24862 Each retry rule occupies one line and consists of three or four parts,
24863 separated by white space: a pattern, an error name, an optional list of sender
24864 addresses, and a list of retry parameters. The pattern and sender lists must be
24865 enclosed in double quotes if they contain white space. The rules are searched
24866 in order until one is found where the pattern, error name, and sender list (if
24867 present) match the failing host or address, the error that occurred, and the
24868 message's sender, respectively.
24869
24870
24871 The pattern is any single item that may appear in an address list (see section
24872 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24873 which means that it is expanded before being tested against the address that
24874 has been delayed. A negated address list item is permitted. Address
24875 list processing treats a plain domain name as if it were preceded by &"*@"&,
24876 which makes it possible for many retry rules to start with just a domain. For
24877 example,
24878 .code
24879 lookingglass.fict.example        *  F,24h,30m;
24880 .endd
24881 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24882 whereas
24883 .code
24884 alice@lookingglass.fict.example  *  F,24h,30m;
24885 .endd
24886 applies only to temporary failures involving the local part &%alice%&.
24887 In practice, almost all rules start with a domain name pattern without a local
24888 part.
24889
24890 .cindex "regular expressions" "in retry rules"
24891 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24892 must match a complete address, not just a domain, because that is how regular
24893 expressions work in address lists.
24894 .display
24895 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24896 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24897 .endd
24898
24899
24900 .section "Choosing which retry rule to use for address errors" "SECID159"
24901 When Exim is looking for a retry rule after a routing attempt has failed (for
24902 example, after a DNS timeout), each line in the retry configuration is tested
24903 against the complete address only if &%retry_use_local_part%& is set for the
24904 router. Otherwise, only the domain is used, except when matching against a
24905 regular expression, when the local part of the address is replaced with &"*"&.
24906 A domain on its own can match a domain pattern, or a pattern that starts with
24907 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24908 &%check_local_user%& is true, and false for other routers.
24909
24910 Similarly, when Exim is looking for a retry rule after a local delivery has
24911 failed (for example, after a mailbox full error), each line in the retry
24912 configuration is tested against the complete address only if
24913 &%retry_use_local_part%& is set for the transport (it defaults true for all
24914 local transports).
24915
24916 .cindex "4&'xx'& responses" "retry rules for"
24917 However, when Exim is looking for a retry rule after a remote delivery attempt
24918 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24919 whole address is always used as the key when searching the retry rules. The
24920 rule that is found is used to create a retry time for the combination of the
24921 failing address and the message's sender. It is the combination of sender and
24922 recipient that is delayed in subsequent queue runs until its retry time is
24923 reached. You can delay the recipient without regard to the sender by setting
24924 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24925 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24926 commands.
24927
24928
24929
24930 .section "Choosing which retry rule to use for host and message errors" &&&
24931          "SECID160"
24932 For a temporary error that is not related to an individual address (for
24933 example, a connection timeout), each line in the retry configuration is checked
24934 twice. First, the name of the remote host is used as a domain name (preceded by
24935 &"*@"& when matching a regular expression). If this does not match the line,
24936 the domain from the email address is tried in a similar fashion. For example,
24937 suppose the MX records for &'a.b.c.example'& are
24938 .code
24939 a.b.c.example  MX  5  x.y.z.example
24940                MX  6  p.q.r.example
24941                MX  7  m.n.o.example
24942 .endd
24943 and the retry rules are
24944 .code
24945 p.q.r.example    *      F,24h,30m;
24946 a.b.c.example    *      F,4d,45m;
24947 .endd
24948 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24949 first rule matches neither the host nor the domain, so Exim looks at the second
24950 rule. This does not match the host, but it does match the domain, so it is used
24951 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24952 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24953 first retry rule is used, because it matches the host.
24954
24955 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24956 first rule to determine retry times, but for all the other hosts for the domain
24957 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24958 routing to &'a.b.c.example'& suffers a temporary failure.
24959
24960 &*Note*&: The host name is used when matching the patterns, not its IP address.
24961 However, if a message is routed directly to an IP address without the use of a
24962 host name, for example, if a &(manualroute)& router contains a setting such as:
24963 .code
24964 route_list = *.a.example  192.168.34.23
24965 .endd
24966 then the &"host name"& that is used when searching for a retry rule is the
24967 textual form of the IP address.
24968
24969 .section "Retry rules for specific errors" "SECID161"
24970 .cindex "retry" "specific errors; specifying"
24971 The second field in a retry rule is the name of a particular error, or an
24972 asterisk, which matches any error. The errors that can be tested for are:
24973
24974 .vlist
24975 .vitem &%auth_failed%&
24976 Authentication failed when trying to send to a host in the
24977 &%hosts_require_auth%& list in an &(smtp)& transport.
24978
24979 .vitem &%data_4xx%&
24980 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24981 after the command, or after sending the message's data.
24982
24983 .vitem &%mail_4xx%&
24984 A 4&'xx'& error was received for an outgoing MAIL command.
24985
24986 .vitem &%rcpt_4xx%&
24987 A 4&'xx'& error was received for an outgoing RCPT command.
24988 .endlist
24989
24990 For the three 4&'xx'& errors, either the first or both of the x's can be given
24991 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24992 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24993 and have retries every ten minutes with a one-hour timeout, you could set up a
24994 retry rule of this form:
24995 .code
24996 the.domain.name  rcpt_452   F,1h,10m
24997 .endd
24998 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24999 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25000
25001 .vlist
25002 .vitem &%lost_connection%&
25003 A server unexpectedly closed the SMTP connection. There may, of course,
25004 legitimate reasons for this (host died, network died), but if it repeats a lot
25005 for the same host, it indicates something odd.
25006
25007 .vitem &%lookup%&
25008 A DNS lookup for a host failed.
25009 Note that a &%dnslookup%& router will need to have matched
25010 its &%fail_defer_domains%& option for this retry type to be usable.
25011 Also note that a &%manualroute%& router will probably need
25012 its &%host_find_failed%& option set to &%defer%&.
25013
25014 .vitem &%refused_MX%&
25015 A connection to a host obtained from an MX record was refused.
25016
25017 .vitem &%refused_A%&
25018 A connection to a host not obtained from an MX record was refused.
25019
25020 .vitem &%refused%&
25021 A connection was refused.
25022
25023 .vitem &%timeout_connect_MX%&
25024 A connection attempt to a host obtained from an MX record timed out.
25025
25026 .vitem &%timeout_connect_A%&
25027 A connection attempt to a host not obtained from an MX record timed out.
25028
25029 .vitem &%timeout_connect%&
25030 A connection attempt timed out.
25031
25032 .vitem &%timeout_MX%&
25033 There was a timeout while connecting or during an SMTP session with a host
25034 obtained from an MX record.
25035
25036 .vitem &%timeout_A%&
25037 There was a timeout while connecting or during an SMTP session with a host not
25038 obtained from an MX record.
25039
25040 .vitem &%timeout%&
25041 There was a timeout while connecting or during an SMTP session.
25042
25043 .vitem &%tls_required%&
25044 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25045 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25046 to STARTTLS, or there was a problem setting up the TLS connection.
25047
25048 .vitem &%quota%&
25049 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25050 transport.
25051
25052 .vitem &%quota_%&<&'time'&>
25053 .cindex "quota" "error testing in retry rule"
25054 .cindex "retry" "quota error testing"
25055 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25056 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25057 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25058 for four days.
25059 .endlist
25060
25061 .cindex "mailbox" "time of last read"
25062 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25063 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25064 it should be based on the last time that the user accessed the mailbox.
25065 However, it is not always possible to determine this. Exim uses the following
25066 heuristic rules:
25067
25068 .ilist
25069 If the mailbox is a single file, the time of last access (the &"atime"&) is
25070 used. As no new messages are being delivered (because the mailbox is over
25071 quota), Exim does not access the file, so this is the time of last user access.
25072 .next
25073 .cindex "maildir format" "time of last read"
25074 For a maildir delivery, the time of last modification of the &_new_&
25075 subdirectory is used. As the mailbox is over quota, no new files are created in
25076 the &_new_& subdirectory, because no new messages are being delivered. Any
25077 change to the &_new_& subdirectory is therefore assumed to be the result of an
25078 MUA moving a new message to the &_cur_& directory when it is first read. The
25079 time that is used is therefore the last time that the user read a new message.
25080 .next
25081 For other kinds of multi-file mailbox, the time of last access cannot be
25082 obtained, so a retry rule that uses this type of error field is never matched.
25083 .endlist
25084
25085 The quota errors apply both to system-enforced quotas and to Exim's own quota
25086 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25087 when a local delivery is deferred because a partition is full (the ENOSPC
25088 error).
25089
25090
25091
25092 .section "Retry rules for specified senders" "SECID162"
25093 .cindex "retry" "rules; sender-specific"
25094 You can specify retry rules that apply only when the failing message has a
25095 specific sender. In particular, this can be used to define retry rules that
25096 apply only to bounce messages. The third item in a retry rule can be of this
25097 form:
25098 .display
25099 &`senders=`&<&'address list'&>
25100 .endd
25101 The retry timings themselves are then the fourth item. For example:
25102 .code
25103 *   rcpt_4xx   senders=:   F,1h,30m
25104 .endd
25105 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25106 host. If the address list contains white space, it must be enclosed in quotes.
25107 For example:
25108 .code
25109 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25110 .endd
25111 &*Warning*&: This facility can be unhelpful if it is used for host errors
25112 (which do not depend on the recipient). The reason is that the sender is used
25113 only to match the retry rule. Once the rule has been found for a host error,
25114 its contents are used to set a retry time for the host, and this will apply to
25115 all messages, not just those with specific senders.
25116
25117 When testing retry rules using &%-brt%&, you can supply a sender using the
25118 &%-f%& command line option, like this:
25119 .code
25120 exim -f "" -brt user@dom.ain
25121 .endd
25122 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25123 list is never matched.
25124
25125
25126
25127
25128
25129 .section "Retry parameters" "SECID163"
25130 .cindex "retry" "parameters in rules"
25131 The third (or fourth, if a senders list is present) field in a retry rule is a
25132 sequence of retry parameter sets, separated by semicolons. Each set consists of
25133 .display
25134 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25135 .endd
25136 The letter identifies the algorithm for computing a new retry time; the cutoff
25137 time is the time beyond which this algorithm no longer applies, and the
25138 arguments vary the algorithm's action. The cutoff time is measured from the
25139 time that the first failure for the domain (combined with the local part if
25140 relevant) was detected, not from the time the message was received.
25141
25142 .cindex "retry" "algorithms"
25143 .cindex "retry" "fixed intervals"
25144 .cindex "retry" "increasing intervals"
25145 .cindex "retry" "random intervals"
25146 The available algorithms are:
25147
25148 .ilist
25149 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25150 the interval.
25151 .next
25152 &'G'&: retry at geometrically increasing intervals. The first argument
25153 specifies a starting value for the interval, and the second a multiplier, which
25154 is used to increase the size of the interval at each retry.
25155 .next
25156 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25157 retry, the previous interval is multiplied by the factor in order to get a
25158 maximum for the next interval. The minimum interval is the first argument of
25159 the parameter, and an actual interval is chosen randomly between them. Such a
25160 rule has been found to be helpful in cluster configurations when all the
25161 members of the cluster restart at once, and may therefore synchronize their
25162 queue processing times.
25163 .endlist
25164
25165 When computing the next retry time, the algorithm definitions are scanned in
25166 order until one whose cutoff time has not yet passed is reached. This is then
25167 used to compute a new retry time that is later than the current time. In the
25168 case of fixed interval retries, this simply means adding the interval to the
25169 current time. For geometrically increasing intervals, retry intervals are
25170 computed from the rule's parameters until one that is greater than the previous
25171 interval is found. The main configuration variable
25172 .cindex "limit" "retry interval"
25173 .cindex "retry" "interval, maximum"
25174 .oindex "&%retry_interval_max%&"
25175 &%retry_interval_max%& limits the maximum interval between retries. It
25176 cannot be set greater than &`24h`&, which is its default value.
25177
25178 A single remote domain may have a number of hosts associated with it, and each
25179 host may have more than one IP address. Retry algorithms are selected on the
25180 basis of the domain name, but are applied to each IP address independently. If,
25181 for example, a host has two IP addresses and one is unusable, Exim will
25182 generate retry times for it and will not try to use it until its next retry
25183 time comes. Thus the good IP address is likely to be tried first most of the
25184 time.
25185
25186 .cindex "hints database" "use for retrying"
25187 Retry times are hints rather than promises. Exim does not make any attempt to
25188 run deliveries exactly at the computed times. Instead, a queue runner process
25189 starts delivery processes for delayed messages periodically, and these attempt
25190 new deliveries only for those addresses that have passed their next retry time.
25191 If a new message arrives for a deferred address, an immediate delivery attempt
25192 occurs only if the address has passed its retry time. In the absence of new
25193 messages, the minimum time between retries is the interval between queue runner
25194 processes. There is not much point in setting retry times of five minutes if
25195 your queue runners happen only once an hour, unless there are a significant
25196 number of incoming messages (which might be the case on a system that is
25197 sending everything to a smart host, for example).
25198
25199 The data in the retry hints database can be inspected by using the
25200 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25201 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25202 &'exinext'& utility script can be used to find out what the next retry times
25203 are for the hosts associated with a particular mail domain, and also for local
25204 deliveries that have been deferred.
25205
25206
25207 .section "Retry rule examples" "SECID164"
25208 Here are some example retry rules:
25209 .code
25210 alice@wonderland.fict.example quota_5d  F,7d,3h
25211 wonderland.fict.example       quota_5d
25212 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25213 lookingglass.fict.example     *         F,24h,30m;
25214 *                 refused_A   F,2h,20m;
25215 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25216 .endd
25217 The first rule sets up special handling for mail to
25218 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25219 mailbox has not been read for at least 5 days. Retries continue every three
25220 hours for 7 days. The second rule handles over-quota errors for all other local
25221 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25222 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25223 fail are bounced immediately if the mailbox has not been read for at least 5
25224 days.
25225
25226 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25227 happen every 15 minutes for an hour, then with geometrically increasing
25228 intervals until two days have passed since a delivery first failed. After the
25229 first hour there is a delay of one hour, then two hours, then four hours, and
25230 so on (this is a rather extreme example).
25231
25232 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25233 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25234 all other domains, with special action for connection refusal from hosts that
25235 were not obtained from an MX record.
25236
25237 The final rule in a retry configuration should always have asterisks in the
25238 first two fields so as to provide a general catch-all for any addresses that do
25239 not have their own special handling. This example tries every 15 minutes for 2
25240 hours, then with intervals starting at one hour and increasing by a factor of
25241 1.5 up to 16 hours, then every 8 hours up to 5 days.
25242
25243
25244
25245 .section "Timeout of retry data" "SECID165"
25246 .cindex "timeout" "of retry data"
25247 .oindex "&%retry_data_expire%&"
25248 .cindex "hints database" "data expiry"
25249 .cindex "retry" "timeout of data"
25250 Exim timestamps the data that it writes to its retry hints database. When it
25251 consults the data during a delivery it ignores any that is older than the value
25252 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25253 been tried for 7 days, Exim will try to deliver to it immediately a message
25254 arrives, and if that fails, it will calculate a retry time as if it were
25255 failing for the first time.
25256
25257 This improves the behaviour for messages routed to rarely-used hosts such as MX
25258 backups. If such a host was down at one time, and happens to be down again when
25259 Exim tries a month later, using the old retry data would imply that it had been
25260 down all the time, which is not a justified assumption.
25261
25262 If a host really is permanently dead, this behaviour causes a burst of retries
25263 every now and again, but only if messages routed to it are rare. If there is a
25264 message at least once every 7 days the retry data never expires.
25265
25266
25267
25268
25269 .section "Long-term failures" "SECID166"
25270 .cindex "delivery failure, long-term"
25271 .cindex "retry" "after long-term failure"
25272 Special processing happens when an email address has been failing for so long
25273 that the cutoff time for the last algorithm is reached. For example, using the
25274 default retry rule:
25275 .code
25276 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25277 .endd
25278 the cutoff time is four days. Reaching the retry cutoff is independent of how
25279 long any specific message has been failing; it is the length of continuous
25280 failure for the recipient address that counts.
25281
25282 When the cutoff time is reached for a local delivery, or for all the IP
25283 addresses associated with a remote delivery, a subsequent delivery failure
25284 causes Exim to give up on the address, and a bounce message is generated.
25285 In order to cater for new messages that use the failing address, a next retry
25286 time is still computed from the final algorithm, and is used as follows:
25287
25288 For local deliveries, one delivery attempt is always made for any subsequent
25289 messages. If this delivery fails, the address fails immediately. The
25290 post-cutoff retry time is not used.
25291
25292 If the delivery is remote, there are two possibilities, controlled by the
25293 .oindex "&%delay_after_cutoff%&"
25294 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25295 default. Until the post-cutoff retry time for one of the IP addresses is
25296 reached, the failing email address is bounced immediately, without a delivery
25297 attempt taking place. After that time, one new delivery attempt is made to
25298 those IP addresses that are past their retry times, and if that still fails,
25299 the address is bounced and new retry times are computed.
25300
25301 In other words, when all the hosts for a given email address have been failing
25302 for a long time, Exim bounces rather then defers until one of the hosts' retry
25303 times is reached. Then it tries once, and bounces if that attempt fails. This
25304 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25305 to a broken destination, but if the host does recover, Exim will eventually
25306 notice.
25307
25308 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25309 addresses are past their final cutoff time, Exim tries to deliver to those IP
25310 addresses that have not been tried since the message arrived. If there are
25311 no suitable IP addresses, or if they all fail, the address is bounced. In other
25312 words, it does not delay when a new message arrives, but tries the expired
25313 addresses immediately, unless they have been tried since the message arrived.
25314 If there is a continuous stream of messages for the failing domains, setting
25315 &%delay_after_cutoff%& false means that there will be many more attempts to
25316 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25317 true.
25318
25319 .section "Deliveries that work intermittently" "SECID167"
25320 .cindex "retry" "intermittently working deliveries"
25321 Some additional logic is needed to cope with cases where a host is
25322 intermittently available, or when a message has some attribute that prevents
25323 its delivery when others to the same address get through. In this situation,
25324 because some messages are successfully delivered, the &"retry clock"& for the
25325 host or address keeps getting reset by the successful deliveries, and so
25326 failing messages remain on the queue for ever because the cutoff time is never
25327 reached.
25328
25329 Two exceptional actions are applied to prevent this happening. The first
25330 applies to errors that are related to a message rather than a remote host.
25331 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25332 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25333 commands, and quota failures. For this type of error, if a message's arrival
25334 time is earlier than the &"first failed"& time for the error, the earlier time
25335 is used when scanning the retry rules to decide when to try next and when to
25336 time out the address.
25337
25338 The exceptional second action applies in all cases. If a message has been on
25339 the queue for longer than the cutoff time of any applicable retry rule for a
25340 given address, a delivery is attempted for that address, even if it is not yet
25341 time, and if this delivery fails, the address is timed out. A new retry time is
25342 not computed in this case, so that other messages for the same address are
25343 considered immediately.
25344 .ecindex IIDretconf1
25345 .ecindex IIDregconf2
25346
25347
25348
25349
25350
25351
25352 . ////////////////////////////////////////////////////////////////////////////
25353 . ////////////////////////////////////////////////////////////////////////////
25354
25355 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25356 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25357 .scindex IIDauthconf2 "authentication"
25358 The &"authenticators"& section of Exim's run time configuration is concerned
25359 with SMTP authentication. This facility is an extension to the SMTP protocol,
25360 described in RFC 2554, which allows a client SMTP host to authenticate itself
25361 to a server. This is a common way for a server to recognize clients that are
25362 permitted to use it as a relay. SMTP authentication is not of relevance to the
25363 transfer of mail between servers that have no managerial connection with each
25364 other.
25365
25366 .cindex "AUTH" "description of"
25367 Very briefly, the way SMTP authentication works is as follows:
25368
25369 .ilist
25370 The server advertises a number of authentication &'mechanisms'& in response to
25371 the client's EHLO command.
25372 .next
25373 The client issues an AUTH command, naming a specific mechanism. The command
25374 may, optionally, contain some authentication data.
25375 .next
25376 The server may issue one or more &'challenges'&, to which the client must send
25377 appropriate responses. In simple authentication mechanisms, the challenges are
25378 just prompts for user names and passwords. The server does not have to issue
25379 any challenges &-- in some mechanisms the relevant data may all be transmitted
25380 with the AUTH command.
25381 .next
25382 The server either accepts or denies authentication.
25383 .next
25384 If authentication succeeds, the client may optionally make use of the AUTH
25385 option on the MAIL command to pass an authenticated sender in subsequent
25386 mail transactions. Authentication lasts for the remainder of the SMTP
25387 connection.
25388 .next
25389 If authentication fails, the client may give up, or it may try a different
25390 authentication mechanism, or it may try transferring mail over the
25391 unauthenticated connection.
25392 .endlist
25393
25394 If you are setting up a client, and want to know which authentication
25395 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25396 SMTP port) on the server, and issue an EHLO command. The response to this
25397 includes the list of supported mechanisms. For example:
25398 .display
25399 &`$ `&&*&`telnet server.example 25`&*&
25400 &`Trying 192.168.34.25...`&
25401 &`Connected to server.example.`&
25402 &`Escape character is &#x0027;^]&#x0027;.`&
25403 &`220 server.example ESMTP Exim 4.20 ...`&
25404 &*&`ehlo client.example`&*&
25405 &`250-server.example Hello client.example [10.8.4.5]`&
25406 &`250-SIZE 52428800`&
25407 &`250-PIPELINING`&
25408 &`250-AUTH PLAIN`&
25409 &`250 HELP`&
25410 .endd
25411 The second-last line of this example output shows that the server supports
25412 authentication using the PLAIN mechanism. In Exim, the different authentication
25413 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25414 routers and transports, which authenticators are included in the binary is
25415 controlled by build-time definitions. The following are currently available,
25416 included by setting
25417 .code
25418 AUTH_CRAM_MD5=yes
25419 AUTH_CYRUS_SASL=yes
25420 AUTH_DOVECOT=yes
25421 AUTH_GSASL=yes
25422 AUTH_HEIMDAL_GSSAPI=yes
25423 AUTH_PLAINTEXT=yes
25424 AUTH_SPA=yes
25425 AUTH_TLS=yes
25426 .endd
25427 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25428 authentication mechanism (RFC 2195), and the second provides an interface to
25429 the Cyrus SASL authentication library.
25430 The third is an interface to Dovecot's authentication system, delegating the
25431 work via a socket interface.
25432 The fourth provides an interface to the GNU SASL authentication library, which
25433 provides mechanisms but typically not data sources.
25434 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25435 supporting setting a server keytab.
25436 The sixth can be configured to support
25437 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25438 not formally documented, but used by several MUAs. The seventh authenticator
25439 supports Microsoft's &'Secure Password Authentication'& mechanism.
25440 The eighth is an Exim authenticator but not an SMTP one;
25441 instead it can use information from a TLS negotiation.
25442
25443 The authenticators are configured using the same syntax as other drivers (see
25444 section &<<SECTfordricon>>&). If no authenticators are required, no
25445 authentication section need be present in the configuration file. Each
25446 authenticator can in principle have both server and client functions. When Exim
25447 is receiving SMTP mail, it is acting as a server; when it is sending out
25448 messages over SMTP, it is acting as a client. Authenticator configuration
25449 options are provided for use in both these circumstances.
25450
25451 To make it clear which options apply to which situation, the prefixes
25452 &%server_%& and &%client_%& are used on option names that are specific to
25453 either the server or the client function, respectively. Server and client
25454 functions are disabled if none of their options are set. If an authenticator is
25455 to be used for both server and client functions, a single definition, using
25456 both sets of options, is required. For example:
25457 .code
25458 cram:
25459   driver = cram_md5
25460   public_name = CRAM-MD5
25461   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25462   client_name = ph10
25463   client_secret = secret2
25464 .endd
25465 The &%server_%& option is used when Exim is acting as a server, and the
25466 &%client_%& options when it is acting as a client.
25467
25468 Descriptions of the individual authenticators are given in subsequent chapters.
25469 The remainder of this chapter covers the generic options for the
25470 authenticators, followed by general discussion of the way authentication works
25471 in Exim.
25472
25473 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25474 per-mechanism basis.  Please read carefully to determine which variables hold
25475 account labels such as usercodes and which hold passwords or other
25476 authenticating data.
25477
25478 Note that some mechanisms support two different identifiers for accounts: the
25479 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25480 and &'authz'& are commonly encountered.  The American spelling is standard here.
25481 Conceptually, authentication data such as passwords are tied to the identifier
25482 used to authenticate; servers may have rules to permit one user to act as a
25483 second user, so that after login the session is treated as though that second
25484 user had logged in.  That second user is the &'authorization id'&.  A robust
25485 configuration might confirm that the &'authz'& field is empty or matches the
25486 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25487 as verified data, the &'authz'& as an unverified request which the server might
25488 choose to honour.
25489
25490 A &'realm'& is a text string, typically a domain name, presented by a server
25491 to a client to help it select an account and credentials to use.  In some
25492 mechanisms, the client and server provably agree on the realm, but clients
25493 typically can not treat the realm as secure data to be blindly trusted.
25494
25495
25496
25497 .section "Generic options for authenticators" "SECID168"
25498 .cindex "authentication" "generic options"
25499 .cindex "options" "generic; for authenticators"
25500
25501 .option client_condition authenticators string&!! unset
25502 When Exim is authenticating as a client, it skips any authenticator whose
25503 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25504 used, for example, to skip plain text authenticators when the connection is not
25505 encrypted by a setting such as:
25506 .code
25507 client_condition = ${if !eq{$tls_out_cipher}{}}
25508 .endd
25509
25510
25511 .option client_set_id authenticators string&!! unset
25512 When client authentication succeeds, this condition is expanded; the
25513 result is used in the log lines for outbound messages.
25514 Typically it will be the user name used for authentication.
25515
25516
25517 .option driver authenticators string unset
25518 This option must always be set. It specifies which of the available
25519 authenticators is to be used.
25520
25521
25522 .option public_name authenticators string unset
25523 This option specifies the name of the authentication mechanism that the driver
25524 implements, and by which it is known to the outside world. These names should
25525 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25526 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25527 defaults to the driver's instance name.
25528
25529
25530 .option server_advertise_condition authenticators string&!! unset
25531 When a server is about to advertise an authentication mechanism, the condition
25532 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25533 mechanism is not advertised.
25534 If the expansion fails, the mechanism is not advertised. If the failure was not
25535 forced, and was not caused by a lookup defer, the incident is logged.
25536 See section &<<SECTauthexiser>>& below for further discussion.
25537
25538
25539 .option server_condition authenticators string&!! unset
25540 This option must be set for a &%plaintext%& server authenticator, where it
25541 is used directly to control authentication. See section &<<SECTplainserver>>&
25542 for details.
25543
25544 For the &(gsasl)& authenticator, this option is required for various
25545 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25546
25547 For the other authenticators, &%server_condition%& can be used as an additional
25548 authentication or authorization mechanism that is applied after the other
25549 authenticator conditions succeed. If it is set, it is expanded when the
25550 authenticator would otherwise return a success code. If the expansion is forced
25551 to fail, authentication fails. Any other expansion failure causes a temporary
25552 error code to be returned. If the result of a successful expansion is an empty
25553 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25554 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25555 other result, a temporary error code is returned, with the expanded string as
25556 the error text.
25557
25558
25559 .option server_debug_print authenticators string&!! unset
25560 If this option is set and authentication debugging is enabled (see the &%-d%&
25561 command line option), the string is expanded and included in the debugging
25562 output when the authenticator is run as a server. This can help with checking
25563 out the values of variables.
25564 If expansion of the string fails, the error message is written to the debugging
25565 output, and Exim carries on processing.
25566
25567
25568 .option server_set_id authenticators string&!! unset
25569 .vindex "&$authenticated_id$&"
25570 When an Exim server successfully authenticates a client, this string is
25571 expanded using data from the authentication, and preserved for any incoming
25572 messages in the variable &$authenticated_id$&. It is also included in the log
25573 lines for incoming messages. For example, a user/password authenticator
25574 configuration might preserve the user name that was used to authenticate, and
25575 refer to it subsequently during delivery of the message.
25576 If expansion fails, the option is ignored.
25577
25578
25579 .option server_mail_auth_condition authenticators string&!! unset
25580 This option allows a server to discard authenticated sender addresses supplied
25581 as part of MAIL commands in SMTP connections that are authenticated by the
25582 driver on which &%server_mail_auth_condition%& is set. The option is not used
25583 as part of the authentication process; instead its (unexpanded) value is
25584 remembered for later use.
25585 How it is used is described in the following section.
25586
25587
25588
25589
25590
25591 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25592 .cindex "authentication" "sender; authenticated"
25593 .cindex "AUTH" "on MAIL command"
25594 When a client supplied an AUTH= item on a MAIL command, Exim applies
25595 the following checks before accepting it as the authenticated sender of the
25596 message:
25597
25598 .ilist
25599 If the connection is not using extended SMTP (that is, HELO was used rather
25600 than EHLO), the use of AUTH= is a syntax error.
25601 .next
25602 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25603 .next
25604 .vindex "&$authenticated_sender$&"
25605 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25606 running, the value of &$authenticated_sender$& is set to the value obtained
25607 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25608 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25609 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25610 given for the MAIL command.
25611 .next
25612 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25613 is accepted and placed in &$authenticated_sender$& only if the client has
25614 authenticated.
25615 .next
25616 If the AUTH= value was accepted by either of the two previous rules, and
25617 the client has authenticated, and the authenticator has a setting for the
25618 &%server_mail_auth_condition%&, the condition is checked at this point. The
25619 valued that was saved from the authenticator is expanded. If the expansion
25620 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25621 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25622 the value of &$authenticated_sender$& is retained and passed on with the
25623 message.
25624 .endlist
25625
25626
25627 When &$authenticated_sender$& is set for a message, it is passed on to other
25628 hosts to which Exim authenticates as a client. Do not confuse this value with
25629 &$authenticated_id$&, which is a string obtained from the authentication
25630 process, and which is not usually a complete email address.
25631
25632 .vindex "&$sender_address$&"
25633 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25634 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25635 therefore make use of &$authenticated_sender$&. The converse is not true: the
25636 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25637 ACL is run.
25638
25639
25640
25641 .section "Authentication on an Exim server" "SECTauthexiser"
25642 .cindex "authentication" "on an Exim server"
25643 When Exim receives an EHLO command, it advertises the public names of those
25644 authenticators that are configured as servers, subject to the following
25645 conditions:
25646
25647 .ilist
25648 The client host must match &%auth_advertise_hosts%& (default *).
25649 .next
25650 It the &%server_advertise_condition%& option is set, its expansion must not
25651 yield the empty string, &"0"&, &"no"&, or &"false"&.
25652 .endlist
25653
25654 The order in which the authenticators are defined controls the order in which
25655 the mechanisms are advertised.
25656
25657 Some mail clients (for example, some versions of Netscape) require the user to
25658 provide a name and password for authentication whenever AUTH is advertised,
25659 even though authentication may not in fact be needed (for example, Exim may be
25660 set up to allow unconditional relaying from the client by an IP address check).
25661 You can make such clients more friendly by not advertising AUTH to them.
25662 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25663 that runs for RCPT) to relay without authentication, you should set
25664 .code
25665 auth_advertise_hosts = ! 10.9.8.0/24
25666 .endd
25667 so that no authentication mechanisms are advertised to them.
25668
25669 The &%server_advertise_condition%& controls the advertisement of individual
25670 authentication mechanisms. For example, it can be used to restrict the
25671 advertisement of a particular mechanism to encrypted connections, by a setting
25672 such as:
25673 .code
25674 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25675 .endd
25676 .vindex "&$tls_in_cipher$&"
25677 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25678 yields &"yes"&, which allows the advertisement to happen.
25679
25680 When an Exim server receives an AUTH command from a client, it rejects it
25681 immediately if AUTH was not advertised in response to an earlier EHLO
25682 command. This is the case if
25683
25684 .ilist
25685 The client host does not match &%auth_advertise_hosts%&; or
25686 .next
25687 No authenticators are configured with server options; or
25688 .next
25689 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25690 server authenticators.
25691 .endlist
25692
25693
25694 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25695 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25696 AUTH is accepted from any client host.
25697
25698 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25699 server authentication mechanism that was advertised in response to EHLO and
25700 that matches the one named in the AUTH command. If it finds one, it runs
25701 the appropriate authentication protocol, and authentication either succeeds or
25702 fails. If there is no matching advertised mechanism, the AUTH command is
25703 rejected with a 504 error.
25704
25705 .vindex "&$received_protocol$&"
25706 .vindex "&$sender_host_authenticated$&"
25707 When a message is received from an authenticated host, the value of
25708 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25709 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25710 public name) of the authenticator driver that successfully authenticated the
25711 client from which the message was received. This variable is empty if there was
25712 no successful authentication.
25713
25714
25715
25716
25717 .section "Testing server authentication" "SECID169"
25718 .cindex "authentication" "testing a server"
25719 .cindex "AUTH" "testing a server"
25720 .cindex "base64 encoding" "creating authentication test data"
25721 Exim's &%-bh%& option can be useful for testing server authentication
25722 configurations. The data for the AUTH command has to be sent using base64
25723 encoding. A quick way to produce such data for testing is the following Perl
25724 script:
25725 .code
25726 use MIME::Base64;
25727 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25728 .endd
25729 .cindex "binary zero" "in authentication data"
25730 This interprets its argument as a Perl string, and then encodes it. The
25731 interpretation as a Perl string allows binary zeros, which are required for
25732 some kinds of authentication, to be included in the data. For example, a
25733 command line to run this script on such data might be
25734 .code
25735 encode '\0user\0password'
25736 .endd
25737 Note the use of single quotes to prevent the shell interpreting the
25738 backslashes, so that they can be interpreted by Perl to specify characters
25739 whose code value is zero.
25740
25741 &*Warning 1*&: If either of the user or password strings starts with an octal
25742 digit, you must use three zeros instead of one after the leading backslash. If
25743 you do not, the octal digit that starts your string will be incorrectly
25744 interpreted as part of the code for the first character.
25745
25746 &*Warning 2*&: If there are characters in the strings that Perl interprets
25747 specially, you must use a Perl escape to prevent them being misinterpreted. For
25748 example, a command such as
25749 .code
25750 encode '\0user@domain.com\0pas$$word'
25751 .endd
25752 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25753
25754 If you have the &%mimencode%& command installed, another way to do produce
25755 base64-encoded strings is to run the command
25756 .code
25757 echo -e -n `\0user\0password' | mimencode
25758 .endd
25759 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25760 in the argument, and the &%-n%& option specifies no newline at the end of its
25761 output. However, not all versions of &%echo%& recognize these options, so you
25762 should check your version before relying on this suggestion.
25763
25764
25765
25766 .section "Authentication by an Exim client" "SECID170"
25767 .cindex "authentication" "on an Exim client"
25768 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25769 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25770 announces support for authentication, and the host matches an entry in either
25771 of these options, Exim (as a client) tries to authenticate as follows:
25772
25773 .ilist
25774 For each authenticator that is configured as a client, in the order in which
25775 they are defined in the configuration, it searches the authentication
25776 mechanisms announced by the server for one whose name matches the public name
25777 of the authenticator.
25778 .next
25779 .vindex "&$host$&"
25780 .vindex "&$host_address$&"
25781 When it finds one that matches, it runs the authenticator's client code. The
25782 variables &$host$& and &$host_address$& are available for any string expansions
25783 that the client might do. They are set to the server's name and IP address. If
25784 any expansion is forced to fail, the authentication attempt is abandoned, and
25785 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25786 delivery to be deferred.
25787 .next
25788 If the result of the authentication attempt is a temporary error or a timeout,
25789 Exim abandons trying to send the message to the host for the moment. It will
25790 try again later. If there are any backup hosts available, they are tried in the
25791 usual way.
25792 .next
25793 If the response to authentication is a permanent error (5&'xx'& code), Exim
25794 carries on searching the list of authenticators and tries another one if
25795 possible. If all authentication attempts give permanent errors, or if there are
25796 no attempts because no mechanisms match (or option expansions force failure),
25797 what happens depends on whether the host matches &%hosts_require_auth%& or
25798 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25799 delivery is deferred. The error can be detected in the retry rules, and thereby
25800 turned into a permanent error if you wish. In the second case, Exim tries to
25801 deliver the message unauthenticated.
25802 .endlist
25803
25804 .cindex "AUTH" "on MAIL command"
25805 When Exim has authenticated itself to a remote server, it adds the AUTH
25806 parameter to the MAIL commands it sends, if it has an authenticated sender for
25807 the message. If the message came from a remote host, the authenticated sender
25808 is the one that was receiving on an incoming MAIL command, provided that the
25809 incoming connection was authenticated and the &%server_mail_auth%& condition
25810 allowed the authenticated sender to be retained. If a local process calls Exim
25811 to send a message, the sender address that is built from the login name and
25812 &%qualify_domain%& is treated as authenticated. However, if the
25813 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25814 the authenticated sender that was received with the message.
25815 .ecindex IIDauthconf1
25816 .ecindex IIDauthconf2
25817
25818
25819
25820
25821
25822
25823 . ////////////////////////////////////////////////////////////////////////////
25824 . ////////////////////////////////////////////////////////////////////////////
25825
25826 .chapter "The plaintext authenticator" "CHAPplaintext"
25827 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25828 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25829 The &(plaintext)& authenticator can be configured to support the PLAIN and
25830 LOGIN authentication mechanisms, both of which transfer authentication data as
25831 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25832 security risk; you are strongly advised to insist on the use of SMTP encryption
25833 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25834 use unencrypted plain text, you should not use the same passwords for SMTP
25835 connections as you do for login accounts.
25836
25837 .section "Plaintext options" "SECID171"
25838 .cindex "options" "&(plaintext)& authenticator (server)"
25839 When configured as a server, &(plaintext)& uses the following options:
25840
25841 .option server_condition authenticators string&!! unset
25842 This is actually a global authentication option, but it must be set in order to
25843 configure the &(plaintext)& driver as a server. Its use is described below.
25844
25845 .option server_prompts plaintext string&!! unset
25846 The contents of this option, after expansion, must be a colon-separated list of
25847 prompt strings. If expansion fails, a temporary authentication rejection is
25848 given.
25849
25850 .section "Using plaintext in a server" "SECTplainserver"
25851 .cindex "AUTH" "in &(plaintext)& authenticator"
25852 .cindex "binary zero" "in &(plaintext)& authenticator"
25853 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25854         "in &(plaintext)& authenticator"
25855 .vindex "&$auth1$&, &$auth2$&, etc"
25856 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25857
25858 When running as a server, &(plaintext)& performs the authentication test by
25859 expanding a string. The data sent by the client with the AUTH command, or in
25860 response to subsequent prompts, is base64 encoded, and so may contain any byte
25861 values when decoded. If any data is supplied with the command, it is treated as
25862 a list of strings, separated by NULs (binary zeros), the first three of which
25863 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25864 (neither LOGIN nor PLAIN uses more than three strings).
25865
25866 For compatibility with previous releases of Exim, the values are also placed in
25867 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25868 variables for this purpose is now deprecated, as it can lead to confusion in
25869 string expansions that also use them for other things.
25870
25871 If there are more strings in &%server_prompts%& than the number of strings
25872 supplied with the AUTH command, the remaining prompts are used to obtain more
25873 data. Each response from the client may be a list of NUL-separated strings.
25874
25875 .vindex "&$authenticated_id$&"
25876 Once a sufficient number of data strings have been received,
25877 &%server_condition%& is expanded. If the expansion is forced to fail,
25878 authentication fails. Any other expansion failure causes a temporary error code
25879 to be returned. If the result of a successful expansion is an empty string,
25880 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25881 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25882 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25883 For any other result, a temporary error code is returned, with the expanded
25884 string as the error text
25885
25886 &*Warning*&: If you use a lookup in the expansion to find the user's
25887 password, be sure to make the authentication fail if the user is unknown.
25888 There are good and bad examples at the end of the next section.
25889
25890
25891
25892 .section "The PLAIN authentication mechanism" "SECID172"
25893 .cindex "PLAIN authentication mechanism"
25894 .cindex "authentication" "PLAIN mechanism"
25895 .cindex "binary zero" "in &(plaintext)& authenticator"
25896 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25897 sent as one item of data (that is, one combined string containing two NUL
25898 separators). The data is sent either as part of the AUTH command, or
25899 subsequently in response to an empty prompt from the server.
25900
25901 The second and third strings are a user name and a corresponding password.
25902 Using a single fixed user name and password as an example, this could be
25903 configured as follows:
25904 .code
25905 fixed_plain:
25906   driver = plaintext
25907   public_name = PLAIN
25908   server_prompts = :
25909   server_condition = \
25910     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25911   server_set_id = $auth2
25912 .endd
25913 Note that the default result strings from &%if%& (&"true"& or an empty string)
25914 are exactly what we want here, so they need not be specified. Obviously, if the
25915 password contains expansion-significant characters such as dollar, backslash,
25916 or closing brace, they have to be escaped.
25917
25918 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25919 the end of a string list are ignored). If all the data comes as part of the
25920 AUTH command, as is commonly the case, the prompt is not used. This
25921 authenticator is advertised in the response to EHLO as
25922 .code
25923 250-AUTH PLAIN
25924 .endd
25925 and a client host can authenticate itself by sending the command
25926 .code
25927 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25928 .endd
25929 As this contains three strings (more than the number of prompts), no further
25930 data is required from the client. Alternatively, the client may just send
25931 .code
25932 AUTH PLAIN
25933 .endd
25934 to initiate authentication, in which case the server replies with an empty
25935 prompt. The client must respond with the combined data string.
25936
25937 The data string is base64 encoded, as required by the RFC. This example,
25938 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25939 represents a zero byte. This is split up into three strings, the first of which
25940 is empty. The &%server_condition%& option in the authenticator checks that the
25941 second two are &`username`& and &`mysecret`& respectively.
25942
25943 Having just one fixed user name and password, as in this example, is not very
25944 realistic, though for a small organization with only a handful of
25945 authenticating clients it could make sense.
25946
25947 A more sophisticated instance of this authenticator could use the user name in
25948 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25949 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25950 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25951 This is an incorrect example:
25952 .code
25953 server_condition = \
25954   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25955 .endd
25956 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25957 which it then compares to the supplied password (&$auth3$&). Why is this example
25958 incorrect? It works fine for existing users, but consider what happens if a
25959 non-existent user name is given. The lookup fails, but as no success/failure
25960 strings are given for the lookup, it yields an empty string. Thus, to defeat
25961 the authentication, all a client has to do is to supply a non-existent user
25962 name and an empty password. The correct way of writing this test is:
25963 .code
25964 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25965   {${if eq{$value}{$auth3}}} {false}}
25966 .endd
25967 In this case, if the lookup succeeds, the result is checked; if the lookup
25968 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25969 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25970 always fails if its second argument is empty. However, the second way of
25971 writing the test makes the logic clearer.
25972
25973
25974 .section "The LOGIN authentication mechanism" "SECID173"
25975 .cindex "LOGIN authentication mechanism"
25976 .cindex "authentication" "LOGIN mechanism"
25977 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25978 in a number of programs. No data is sent with the AUTH command. Instead, a
25979 user name and password are supplied separately, in response to prompts. The
25980 plaintext authenticator can be configured to support this as in this example:
25981 .code
25982 fixed_login:
25983   driver = plaintext
25984   public_name = LOGIN
25985   server_prompts = User Name : Password
25986   server_condition = \
25987     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25988   server_set_id = $auth1
25989 .endd
25990 Because of the way plaintext operates, this authenticator accepts data supplied
25991 with the AUTH command (in contravention of the specification of LOGIN), but
25992 if the client does not supply it (as is the case for LOGIN clients), the prompt
25993 strings are used to obtain two data items.
25994
25995 Some clients are very particular about the precise text of the prompts. For
25996 example, Outlook Express is reported to recognize only &"Username:"& and
25997 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25998 strings. It uses the &%ldapauth%& expansion condition to check the user
25999 name and password by binding to an LDAP server:
26000 .code
26001 login:
26002   driver = plaintext
26003   public_name = LOGIN
26004   server_prompts = Username:: : Password::
26005   server_condition = ${if and{{ \
26006     !eq{}{$auth1} }{ \
26007     ldapauth{\
26008       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26009       pass=${quote:$auth2} \
26010       ldap://ldap.example.org/} }} }
26011   server_set_id = uid=$auth1,ou=people,o=example.org
26012 .endd
26013 We have to check that the username is not empty before using it, because LDAP
26014 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26015 operator to correctly quote the DN for authentication. However, the basic
26016 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26017 correct one to use for the password, because quoting is needed only to make
26018 the password conform to the Exim syntax. At the LDAP level, the password is an
26019 uninterpreted string.
26020
26021
26022 .section "Support for different kinds of authentication" "SECID174"
26023 A number of string expansion features are provided for the purpose of
26024 interfacing to different ways of user authentication. These include checking
26025 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26026 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26027 &<<SECTexpcond>>&.
26028
26029
26030
26031
26032 .section "Using plaintext in a client" "SECID175"
26033 .cindex "options" "&(plaintext)& authenticator (client)"
26034 The &(plaintext)& authenticator has two client options:
26035
26036 .option client_ignore_invalid_base64 plaintext boolean false
26037 If the client receives a server prompt that is not a valid base64 string,
26038 authentication is abandoned by default. However, if this option is set true,
26039 the error in the challenge is ignored and the client sends the response as
26040 usual.
26041
26042 .option client_send plaintext string&!! unset
26043 The string is a colon-separated list of authentication data strings. Each
26044 string is independently expanded before being sent to the server. The first
26045 string is sent with the AUTH command; any more strings are sent in response
26046 to prompts from the server. Before each string is expanded, the value of the
26047 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26048 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26049 way. Thus, the prompt that is received in response to sending the first string
26050 (with the AUTH command) can be used in the expansion of the second string, and
26051 so on. If an invalid base64 string is received when
26052 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26053 &$auth$&<&'n'&> variable.
26054
26055 &*Note*&: You cannot use expansion to create multiple strings, because
26056 splitting takes priority and happens first.
26057
26058 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26059 the data, further processing is applied to each string before it is sent. If
26060 there are any single circumflex characters in the string, they are converted to
26061 NULs. Should an actual circumflex be required as data, it must be doubled in
26062 the string.
26063
26064 This is an example of a client configuration that implements the PLAIN
26065 authentication mechanism with a fixed user name and password:
26066 .code
26067 fixed_plain:
26068   driver = plaintext
26069   public_name = PLAIN
26070   client_send = ^username^mysecret
26071 .endd
26072 The lack of colons means that the entire text is sent with the AUTH
26073 command, with the circumflex characters converted to NULs. A similar example
26074 that uses the LOGIN mechanism is:
26075 .code
26076 fixed_login:
26077   driver = plaintext
26078   public_name = LOGIN
26079   client_send = : username : mysecret
26080 .endd
26081 The initial colon means that the first string is empty, so no data is sent with
26082 the AUTH command itself. The remaining strings are sent in response to
26083 prompts.
26084 .ecindex IIDplaiauth1
26085 .ecindex IIDplaiauth2
26086
26087
26088
26089
26090 . ////////////////////////////////////////////////////////////////////////////
26091 . ////////////////////////////////////////////////////////////////////////////
26092
26093 .chapter "The cram_md5 authenticator" "CHID9"
26094 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26095 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26096 .cindex "CRAM-MD5 authentication mechanism"
26097 .cindex "authentication" "CRAM-MD5 mechanism"
26098 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26099 sends a challenge string to the client, and the response consists of a user
26100 name and the CRAM-MD5 digest of the challenge string combined with a secret
26101 string (password) which is known to both server and client. Thus, the secret
26102 is not sent over the network as plain text, which makes this authenticator more
26103 secure than &(plaintext)&. However, the downside is that the secret has to be
26104 available in plain text at either end.
26105
26106
26107 .section "Using cram_md5 as a server" "SECID176"
26108 .cindex "options" "&(cram_md5)& authenticator (server)"
26109 This authenticator has one server option, which must be set to configure the
26110 authenticator as a server:
26111
26112 .option server_secret cram_md5 string&!! unset
26113 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26114 When the server receives the client's response, the user name is placed in
26115 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26116 obtain the password for that user. The server then computes the CRAM-MD5 digest
26117 that the client should have sent, and checks that it received the correct
26118 string. If the expansion of &%server_secret%& is forced to fail, authentication
26119 fails. If the expansion fails for some other reason, a temporary error code is
26120 returned to the client.
26121
26122 For compatibility with previous releases of Exim, the user name is also placed
26123 in &$1$&. However, the use of this variables for this purpose is now
26124 deprecated, as it can lead to confusion in string expansions that also use
26125 numeric variables for other things.
26126
26127 For example, the following authenticator checks that the user name given by the
26128 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26129 user name, authentication fails.
26130 .code
26131 fixed_cram:
26132   driver = cram_md5
26133   public_name = CRAM-MD5
26134   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26135   server_set_id = $auth1
26136 .endd
26137 .vindex "&$authenticated_id$&"
26138 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26139 name in &$authenticated_id$&. A more typical configuration might look up the
26140 secret string in a file, using the user name as the key. For example:
26141 .code
26142 lookup_cram:
26143   driver = cram_md5
26144   public_name = CRAM-MD5
26145   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26146                   {$value}fail}
26147   server_set_id = $auth1
26148 .endd
26149 Note that this expansion explicitly forces failure if the lookup fails
26150 because &$auth1$& contains an unknown user name.
26151
26152 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26153 using the relevant libraries, you need to know the realm to specify in the
26154 lookup and then ask for the &"userPassword"& attribute for that user in that
26155 realm, with:
26156 .code
26157 cyrusless_crammd5:
26158   driver = cram_md5
26159   public_name = CRAM-MD5
26160   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26161                   dbmjz{/etc/sasldb2}{$value}fail}
26162   server_set_id = $auth1
26163 .endd
26164
26165 .section "Using cram_md5 as a client" "SECID177"
26166 .cindex "options" "&(cram_md5)& authenticator (client)"
26167 When used as a client, the &(cram_md5)& authenticator has two options:
26168
26169
26170
26171 .option client_name cram_md5 string&!! "the primary host name"
26172 This string is expanded, and the result used as the user name data when
26173 computing the response to the server's challenge.
26174
26175
26176 .option client_secret cram_md5 string&!! unset
26177 This option must be set for the authenticator to work as a client. Its value is
26178 expanded and the result used as the secret string when computing the response.
26179
26180
26181 .vindex "&$host$&"
26182 .vindex "&$host_address$&"
26183 Different user names and secrets can be used for different servers by referring
26184 to &$host$& or &$host_address$& in the options. Forced failure of either
26185 expansion string is treated as an indication that this authenticator is not
26186 prepared to handle this case. Exim moves on to the next configured client
26187 authenticator. Any other expansion failure causes Exim to give up trying to
26188 send the message to the current server.
26189
26190 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26191 strings, is:
26192 .code
26193 fixed_cram:
26194   driver = cram_md5
26195   public_name = CRAM-MD5
26196   client_name = ph10
26197   client_secret = secret
26198 .endd
26199 .ecindex IIDcramauth1
26200 .ecindex IIDcramauth2
26201
26202
26203
26204 . ////////////////////////////////////////////////////////////////////////////
26205 . ////////////////////////////////////////////////////////////////////////////
26206
26207 .chapter "The cyrus_sasl authenticator" "CHID10"
26208 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26209 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26210 .cindex "Cyrus" "SASL library"
26211 .cindex "Kerberos"
26212 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26213 Digital Ltd (&url(http://www.aldigital.co.uk)).
26214
26215 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26216 library implementation of the RFC 2222 (&"Simple Authentication and Security
26217 Layer"&). This library supports a number of authentication mechanisms,
26218 including PLAIN and LOGIN, but also several others that Exim does not support
26219 directly. In particular, there is support for Kerberos authentication.
26220
26221 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26222 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26223 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26224 name of the driver to determine which mechanism to support.
26225
26226 Where access to some kind of secret file is required, for example in GSSAPI
26227 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26228 user, and that the Cyrus SASL library has no way of escalating privileges
26229 by default. You may also find you need to set environment variables,
26230 depending on the driver you are using.
26231
26232 The application name provided by Exim is &"exim"&, so various SASL options may
26233 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26234 Kerberos, note that because of limitations in the GSSAPI interface,
26235 changing the server keytab might need to be communicated down to the Kerberos
26236 layer independently. The mechanism for doing so is dependent upon the Kerberos
26237 implementation.
26238
26239 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26240 may be set to point to an alternative keytab file. Exim will pass this
26241 variable through from its own inherited environment when started as root or the
26242 Exim user. The keytab file needs to be readable by the Exim user.
26243 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26244 environment variable.  In practice, for those releases, the Cyrus authenticator
26245 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26246 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26247
26248
26249 .section "Using cyrus_sasl as a server" "SECID178"
26250 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26251 (on a successful authentication) into &$auth1$&. For compatibility with
26252 previous releases of Exim, the username is also placed in &$1$&. However, the
26253 use of this variable for this purpose is now deprecated, as it can lead to
26254 confusion in string expansions that also use numeric variables for other
26255 things.
26256
26257
26258 .option server_hostname cyrus_sasl string&!! "see below"
26259 This option selects the hostname that is used when communicating with the
26260 library. The default value is &`$primary_hostname`&. It is up to the underlying
26261 SASL plug-in what it does with this data.
26262
26263
26264 .option server_mech cyrus_sasl string "see below"
26265 This option selects the authentication mechanism this driver should use. The
26266 default is the value of the generic &%public_name%& option. This option allows
26267 you to use a different underlying mechanism from the advertised name. For
26268 example:
26269 .code
26270 sasl:
26271   driver = cyrus_sasl
26272   public_name = X-ANYTHING
26273   server_mech = CRAM-MD5
26274   server_set_id = $auth1
26275 .endd
26276
26277 .option server_realm cyrus_sasl string&!! unset
26278 This specifies the SASL realm that the server claims to be in.
26279
26280
26281 .option server_service cyrus_sasl string &`smtp`&
26282 This is the SASL service that the server claims to implement.
26283
26284
26285 For straightforward cases, you do not need to set any of the authenticator's
26286 private options. All you need to do is to specify an appropriate mechanism as
26287 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26288 PLAIN, you could have two authenticators as follows:
26289 .code
26290 sasl_cram_md5:
26291   driver = cyrus_sasl
26292   public_name = CRAM-MD5
26293   server_set_id = $auth1
26294
26295 sasl_plain:
26296   driver = cyrus_sasl
26297   public_name = PLAIN
26298   server_set_id = $auth2
26299 .endd
26300 Cyrus SASL does implement the LOGIN authentication method, even though it is
26301 not a standard method. It is disabled by default in the source distribution,
26302 but it is present in many binary distributions.
26303 .ecindex IIDcyrauth1
26304 .ecindex IIDcyrauth2
26305
26306
26307
26308
26309 . ////////////////////////////////////////////////////////////////////////////
26310 . ////////////////////////////////////////////////////////////////////////////
26311 .chapter "The dovecot authenticator" "CHAPdovecot"
26312 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26313 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26314 This authenticator is an interface to the authentication facility of the
26315 Dovecot POP/IMAP server, which can support a number of authentication methods.
26316 Note that Dovecot must be configured to use auth-client not auth-userdb.
26317 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26318 to use the same mechanisms for SMTP authentication. This is a server
26319 authenticator only. There is only one option:
26320
26321 .option server_socket dovecot string unset
26322
26323 This option must specify the socket that is the interface to Dovecot
26324 authentication. The &%public_name%& option must specify an authentication
26325 mechanism that Dovecot is configured to support. You can have several
26326 authenticators for different mechanisms. For example:
26327 .code
26328 dovecot_plain:
26329   driver = dovecot
26330   public_name = PLAIN
26331   server_socket = /var/run/dovecot/auth-client
26332   server_set_id = $auth1
26333
26334 dovecot_ntlm:
26335   driver = dovecot
26336   public_name = NTLM
26337   server_socket = /var/run/dovecot/auth-client
26338   server_set_id = $auth1
26339 .endd
26340 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26341 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26342 option is passed in the Dovecot authentication command. If, for a TLS
26343 connection, a client certificate has been verified, the &"valid-client-cert"&
26344 option is passed. When authentication succeeds, the identity of the user
26345 who authenticated is placed in &$auth1$&.
26346 .ecindex IIDdcotauth1
26347 .ecindex IIDdcotauth2
26348
26349
26350 . ////////////////////////////////////////////////////////////////////////////
26351 . ////////////////////////////////////////////////////////////////////////////
26352 .chapter "The gsasl authenticator" "CHAPgsasl"
26353 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26354 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26355 .cindex "authentication" "GNU SASL"
26356 .cindex "authentication" "SASL"
26357 .cindex "authentication" "EXTERNAL"
26358 .cindex "authentication" "ANONYMOUS"
26359 .cindex "authentication" "PLAIN"
26360 .cindex "authentication" "LOGIN"
26361 .cindex "authentication" "DIGEST-MD5"
26362 .cindex "authentication" "CRAM-MD5"
26363 .cindex "authentication" "SCRAM-SHA-1"
26364 The &(gsasl)& authenticator provides server integration for the GNU SASL
26365 library and the mechanisms it provides.  This is new as of the 4.80 release
26366 and there are a few areas where the library does not let Exim smoothly
26367 scale to handle future authentication mechanisms, so no guarantee can be
26368 made that any particular new authentication mechanism will be supported
26369 without code changes in Exim.
26370
26371
26372 .option server_channelbinding gsasl boolean false
26373 Some authentication mechanisms are able to use external context at both ends
26374 of the session to bind the authentication to that context, and fail the
26375 authentication process if that context differs.  Specifically, some TLS
26376 ciphersuites can provide identifying information about the cryptographic
26377 context.
26378
26379 This means that certificate identity and verification becomes a non-issue,
26380 as a man-in-the-middle attack will cause the correct client and server to
26381 see different identifiers and authentication will fail.
26382
26383 This is currently only supported when using the GnuTLS library.  This is
26384 only usable by mechanisms which support "channel binding"; at time of
26385 writing, that's the SCRAM family.
26386
26387 This defaults off to ensure smooth upgrade across Exim releases, in case
26388 this option causes some clients to start failing.  Some future release
26389 of Exim may switch the default to be true.
26390
26391
26392 .option server_hostname gsasl string&!! "see below"
26393 This option selects the hostname that is used when communicating with the
26394 library. The default value is &`$primary_hostname`&.
26395 Some mechanisms will use this data.
26396
26397
26398 .option server_mech gsasl string "see below"
26399 This option selects the authentication mechanism this driver should use. The
26400 default is the value of the generic &%public_name%& option. This option allows
26401 you to use a different underlying mechanism from the advertised name. For
26402 example:
26403 .code
26404 sasl:
26405   driver = gsasl
26406   public_name = X-ANYTHING
26407   server_mech = CRAM-MD5
26408   server_set_id = $auth1
26409 .endd
26410
26411
26412 .option server_password gsasl string&!! unset
26413 Various mechanisms need access to the cleartext password on the server, so
26414 that proof-of-possession can be demonstrated on the wire, without sending
26415 the password itself.
26416
26417 The data available for lookup varies per mechanism.
26418 In all cases, &$auth1$& is set to the &'authentication id'&.
26419 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26420 if available, else the empty string.
26421 The &$auth3$& variable will always be the &'realm'& if available,
26422 else the empty string.
26423
26424 A forced failure will cause authentication to defer.
26425
26426 If using this option, it may make sense to set the &%server_condition%&
26427 option to be simply "true".
26428
26429
26430 .option server_realm gsasl string&!! unset
26431 This specifies the SASL realm that the server claims to be in.
26432 Some mechanisms will use this data.
26433
26434
26435 .option server_scram_iter gsasl string&!! unset
26436 This option provides data for the SCRAM family of mechanisms.
26437 &$auth1$& is not available at evaluation time.
26438 (This may change, as we receive feedback on use)
26439
26440
26441 .option server_scram_salt gsasl string&!! unset
26442 This option provides data for the SCRAM family of mechanisms.
26443 &$auth1$& is not available at evaluation time.
26444 (This may change, as we receive feedback on use)
26445
26446
26447 .option server_service gsasl string &`smtp`&
26448 This is the SASL service that the server claims to implement.
26449 Some mechanisms will use this data.
26450
26451
26452 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26453 .vindex "&$auth1$&, &$auth2$&, etc"
26454 These may be set when evaluating specific options, as detailed above.
26455 They will also be set when evaluating &%server_condition%&.
26456
26457 Unless otherwise stated below, the &(gsasl)& integration will use the following
26458 meanings for these variables:
26459
26460 .ilist
26461 .vindex "&$auth1$&"
26462 &$auth1$&: the &'authentication id'&
26463 .next
26464 .vindex "&$auth2$&"
26465 &$auth2$&: the &'authorization id'&
26466 .next
26467 .vindex "&$auth3$&"
26468 &$auth3$&: the &'realm'&
26469 .endlist
26470
26471 On a per-mechanism basis:
26472
26473 .ilist
26474 .cindex "authentication" "EXTERNAL"
26475 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26476 the &%server_condition%& option must be present.
26477 .next
26478 .cindex "authentication" "ANONYMOUS"
26479 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26480 the &%server_condition%& option must be present.
26481 .next
26482 .cindex "authentication" "GSSAPI"
26483 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26484 &$auth2$& will be set to the &'authorization id'&,
26485 the &%server_condition%& option must be present.
26486 .endlist
26487
26488 An &'anonymous token'& is something passed along as an unauthenticated
26489 identifier; this is analogous to FTP anonymous authentication passing an
26490 email address, or software-identifier@, as the "password".
26491
26492
26493 An example showing the password having the realm specified in the callback
26494 and demonstrating a Cyrus SASL to GSASL migration approach is:
26495 .code
26496 gsasl_cyrusless_crammd5:
26497   driver = gsasl
26498   public_name = CRAM-MD5
26499   server_realm = imap.example.org
26500   server_password = ${lookup{$auth1:$auth3:userPassword}\
26501                     dbmjz{/etc/sasldb2}{$value}fail}
26502   server_set_id = ${quote:$auth1}
26503   server_condition = yes
26504 .endd
26505
26506
26507 . ////////////////////////////////////////////////////////////////////////////
26508 . ////////////////////////////////////////////////////////////////////////////
26509
26510 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26511 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26512 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26513 .cindex "authentication" "GSSAPI"
26514 .cindex "authentication" "Kerberos"
26515 The &(heimdal_gssapi)& authenticator provides server integration for the
26516 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26517 reliably.
26518
26519 .option server_hostname heimdal_gssapi string&!! "see below"
26520 This option selects the hostname that is used, with &%server_service%&,
26521 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26522 identifier.  The default value is &`$primary_hostname`&.
26523
26524 .option server_keytab heimdal_gssapi string&!! unset
26525 If set, then Heimdal will not use the system default keytab (typically
26526 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26527 The value should be a pathname, with no &"file:"& prefix.
26528
26529 .option server_service heimdal_gssapi string&!! "smtp"
26530 This option specifies the service identifier used, in conjunction with
26531 &%server_hostname%&, for building the identifier for finding credentials
26532 from the keytab.
26533
26534
26535 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26536 Beware that these variables will typically include a realm, thus will appear
26537 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26538 not verified, so a malicious client can set it to anything.
26539
26540 The &$auth1$& field should be safely trustable as a value from the Key
26541 Distribution Center.  Note that these are not quite email addresses.
26542 Each identifier is for a role, and so the left-hand-side may include a
26543 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26544
26545 .vindex "&$auth1$&, &$auth2$&, etc"
26546 .ilist
26547 .vindex "&$auth1$&"
26548 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26549 .next
26550 .vindex "&$auth2$&"
26551 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26552 authentication.  If that was empty, this will also be set to the
26553 GSS Display Name.
26554 .endlist
26555
26556
26557 . ////////////////////////////////////////////////////////////////////////////
26558 . ////////////////////////////////////////////////////////////////////////////
26559
26560 .chapter "The spa authenticator" "CHAPspa"
26561 .scindex IIDspaauth1 "&(spa)& authenticator"
26562 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26563 .cindex "authentication" "Microsoft Secure Password"
26564 .cindex "authentication" "NTLM"
26565 .cindex "Microsoft Secure Password Authentication"
26566 .cindex "NTLM authentication"
26567 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26568 Password Authentication'& mechanism,
26569 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26570 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26571 taken from the Samba project (&url(http://www.samba.org)). The code for the
26572 server side was subsequently contributed by Tom Kistner. The mechanism works as
26573 follows:
26574
26575 .ilist
26576 After the AUTH command has been accepted, the client sends an SPA
26577 authentication request based on the user name and optional domain.
26578 .next
26579 The server sends back a challenge.
26580 .next
26581 The client builds a challenge response which makes use of the user's password
26582 and sends it to the server, which then accepts or rejects it.
26583 .endlist
26584
26585 Encryption is used to protect the password in transit.
26586
26587
26588
26589 .section "Using spa as a server" "SECID179"
26590 .cindex "options" "&(spa)& authenticator (server)"
26591 The &(spa)& authenticator has just one server option:
26592
26593 .option server_password spa string&!! unset
26594 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26595 This option is expanded, and the result must be the cleartext password for the
26596 authenticating user, whose name is at this point in &$auth1$&. For
26597 compatibility with previous releases of Exim, the user name is also placed in
26598 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26599 it can lead to confusion in string expansions that also use numeric variables
26600 for other things. For example:
26601 .code
26602 spa:
26603   driver = spa
26604   public_name = NTLM
26605   server_password = \
26606     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26607 .endd
26608 If the expansion is forced to fail, authentication fails. Any other expansion
26609 failure causes a temporary error code to be returned.
26610
26611
26612
26613
26614
26615 .section "Using spa as a client" "SECID180"
26616 .cindex "options" "&(spa)& authenticator (client)"
26617 The &(spa)& authenticator has the following client options:
26618
26619
26620
26621 .option client_domain spa string&!! unset
26622 This option specifies an optional domain for the authentication.
26623
26624
26625 .option client_password spa string&!! unset
26626 This option specifies the user's password, and must be set.
26627
26628
26629 .option client_username spa string&!! unset
26630 This option specifies the user name, and must be set. Here is an example of a
26631 configuration of this authenticator for use with the mail servers at
26632 &'msn.com'&:
26633 .code
26634 msn:
26635   driver = spa
26636   public_name = MSN
26637   client_username = msn/msn_username
26638   client_password = msn_plaintext_password
26639   client_domain = DOMAIN_OR_UNSET
26640 .endd
26641 .ecindex IIDspaauth1
26642 .ecindex IIDspaauth2
26643
26644
26645
26646
26647
26648 . ////////////////////////////////////////////////////////////////////////////
26649 . ////////////////////////////////////////////////////////////////////////////
26650
26651 .chapter "The tls authenticator" "CHAPtlsauth"
26652 .scindex IIDtlsauth1 "&(tls)& authenticator"
26653 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26654 .cindex "authentication" "Client Certificate"
26655 .cindex "authentication" "X509"
26656 .cindex "Certificate-based authentication"
26657 The &(tls)& authenticator provides server support for
26658 authentication based on client certificates.
26659
26660 It is not an SMTP authentication mechanism and is not
26661 advertised by the server as part of the SMTP EHLO response.
26662 It is an Exim authenticator in the sense that it affects
26663 the protocol element of the log line, can be tested for
26664 by the &%authenticated%& ACL condition, and can set
26665 the &$authenticated_id$& variable.
26666
26667 The client must present a verifiable certificate,
26668 for which it must have been requested via the
26669 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26670 (see &<<CHAPTLS>>&).
26671
26672 If an authenticator of this type is configured it is
26673 run before any SMTP-level communication is done,
26674 and can authenticate the connection.
26675 If it does, SMTP authentication is not offered.
26676
26677 A maximum of one authenticator of this type may be present.
26678
26679
26680 .cindex "options" "&(tls)& authenticator (server)"
26681 The &(tls)& authenticator has three server options:
26682
26683 .option server_param1 tls string&!! unset
26684 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26685 This option is expanded after the TLS negotiation and
26686 the result is placed in &$auth1$&.
26687 If the expansion is forced to fail, authentication fails. Any other expansion
26688 failure causes a temporary error code to be returned.
26689
26690 .option server_param2 tls string&!! unset
26691 .option server_param3 tls string&!! unset
26692 As above, for &$auth2$& and &$auth3$&.
26693
26694 &%server_param1%& may also be spelled &%server_param%&.
26695
26696
26697 Example:
26698 .code
26699 tls:
26700   driver = tls
26701   server_param1 =     ${certextract {subj_altname,mail,>:} \
26702                                     {$tls_in_peercert}}
26703   server_condition =  ${if forany {$auth1} \
26704                             {!= {0} \
26705                                 {${lookup ldap{ldap:///\
26706                          mailname=${quote_ldap_dn:${lc:$item}},\
26707                          ou=users,LDAP_DC?mailid} {$value}{0} \
26708                        }    }   } }
26709   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26710 .endd
26711 This accepts a client certificate that is verifiable against any
26712 of your configured trust-anchors
26713 which usually means the full set of public CAs)
26714 and which has a SAN with a good account name.
26715 Note that the client cert is on the wire in-clear, including the SAN,
26716 whereas a plaintext SMTP AUTH done inside TLS is not.
26717
26718 . An alternative might use
26719 . .code
26720 .   server_param1 = ${sha256:$tls_in_peercert}
26721 . .endd
26722 . to require one of a set of specific certs that define a given account
26723 . (the verification is still required, but mostly irrelevant).
26724 . This would help for per-device use.
26725 .
26726 . However, for the future we really need support for checking a
26727 . user cert in LDAP - which probably wants a base-64 DER.
26728
26729 .ecindex IIDtlsauth1
26730 .ecindex IIDtlsauth2
26731
26732
26733 Note that because authentication is traditionally an SMTP operation,
26734 the &%authenticated%& ACL condition cannot be used in
26735 a connect- or helo-ACL.
26736
26737
26738
26739 . ////////////////////////////////////////////////////////////////////////////
26740 . ////////////////////////////////////////////////////////////////////////////
26741
26742 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26743          "Encrypted SMTP connections"
26744 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26745 .scindex IIDencsmtp2 "SMTP" "encryption"
26746 .cindex "TLS" "on SMTP connection"
26747 .cindex "OpenSSL"
26748 .cindex "GnuTLS"
26749 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26750 Sockets Layer), is implemented by making use of the OpenSSL library or the
26751 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26752 cryptographic code in the Exim distribution itself for implementing TLS. In
26753 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26754 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26755 You also need to understand the basic concepts of encryption at a managerial
26756 level, and in particular, the way that public keys, private keys, and
26757 certificates are used.
26758
26759 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26760 connection is established, the client issues a STARTTLS command. If the
26761 server accepts this, the client and the server negotiate an encryption
26762 mechanism. If the negotiation succeeds, the data that subsequently passes
26763 between them is encrypted.
26764
26765 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26766 and if so, what cipher suite is in use, whether the client supplied a
26767 certificate, and whether or not that certificate was verified. This makes it
26768 possible for an Exim server to deny or accept certain commands based on the
26769 encryption state.
26770
26771 &*Warning*&: Certain types of firewall and certain anti-virus products can
26772 disrupt TLS connections. You need to turn off SMTP scanning for these products
26773 in order to get TLS to work.
26774
26775
26776
26777 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26778          "SECID284"
26779 .cindex "ssmtp protocol"
26780 .cindex "smtps protocol"
26781 .cindex "SMTP" "ssmtp protocol"
26782 .cindex "SMTP" "smtps protocol"
26783 Early implementations of encrypted SMTP used a different TCP port from normal
26784 SMTP, and expected an encryption negotiation to start immediately, instead of
26785 waiting for a STARTTLS command from the client using the standard SMTP
26786 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26787 allocated for this purpose.
26788
26789 This approach was abandoned when encrypted SMTP was standardized, but there are
26790 still some legacy clients that use it. Exim supports these clients by means of
26791 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26792 numbers; the most common use is expected to be:
26793 .code
26794 tls_on_connect_ports = 465
26795 .endd
26796 The port numbers specified by this option apply to all SMTP connections, both
26797 via the daemon and via &'inetd'&. You still need to specify all the ports that
26798 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26799 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26800 an extra port &-- rather, it specifies different behaviour on a port that is
26801 defined elsewhere.
26802
26803 There is also a &%-tls-on-connect%& command line option. This overrides
26804 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26805
26806
26807
26808
26809
26810
26811 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26812 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26813 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26814 followed later, when the first versions of GnuTLS were released. To build Exim
26815 to use GnuTLS, you need to set
26816 .code
26817 USE_GNUTLS=yes
26818 .endd
26819 in Local/Makefile, in addition to
26820 .code
26821 SUPPORT_TLS=yes
26822 .endd
26823 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26824 include files and libraries for GnuTLS can be found.
26825
26826 There are some differences in usage when using GnuTLS instead of OpenSSL:
26827
26828 .ilist
26829 The &%tls_verify_certificates%& option
26830 cannot be the path of a directory
26831 for GnuTLS versions before 3.3.6
26832 (for later versions, or OpenSSL, it can be either).
26833 .next
26834 The default value for &%tls_dhparam%& differs for historical reasons.
26835 .next
26836 .vindex "&$tls_in_peerdn$&"
26837 .vindex "&$tls_out_peerdn$&"
26838 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26839 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26840 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26841 .next
26842 OpenSSL identifies cipher suites using hyphens as separators, for example:
26843 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26844 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26845 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26846 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26847 to handle its own older variants) when processing lists of cipher suites in the
26848 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26849 option).
26850 .next
26851 The &%tls_require_ciphers%& options operate differently, as described in the
26852 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26853 .next
26854 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26855 When using OpenSSL, this option is ignored.
26856 (If an API is found to let OpenSSL be configured in this way,
26857 let the Exim Maintainers know and we'll likely use it).
26858 .next
26859 Some other recently added features may only be available in one or the other.
26860 This should be documented with the feature.  If the documentation does not
26861 explicitly state that the feature is infeasible in the other TLS
26862 implementation, then patches are welcome.
26863 .endlist
26864
26865
26866 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26867 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26868 an explicit path; if the latter, then the text about generation still applies,
26869 but not the chosen filename.
26870 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26871 See the documentation of &%tls_dhparam%& for more information.
26872
26873 GnuTLS uses D-H parameters that may take a substantial amount of time
26874 to compute. It is unreasonable to re-compute them for every TLS session.
26875 Therefore, Exim keeps this data in a file in its spool directory, called
26876 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26877 of bits requested.
26878 The file is owned by the Exim user and is readable only by
26879 its owner. Every Exim process that start up GnuTLS reads the D-H
26880 parameters from this file. If the file does not exist, the first Exim process
26881 that needs it computes the data and writes it to a temporary file which is
26882 renamed once it is complete. It does not matter if several Exim processes do
26883 this simultaneously (apart from wasting a few resources). Once a file is in
26884 place, new Exim processes immediately start using it.
26885
26886 For maximum security, the parameters that are stored in this file should be
26887 recalculated periodically, the frequency depending on your paranoia level.
26888 If you are avoiding using the fixed D-H primes published in RFCs, then you
26889 are concerned about some advanced attacks and will wish to do this; if you do
26890 not regenerate then you might as well stick to the standard primes.
26891
26892 Arranging this is easy in principle; just delete the file when you want new
26893 values to be computed. However, there may be a problem. The calculation of new
26894 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26895 If the system is not very active, &_/dev/random_& may delay returning data
26896 until enough randomness (entropy) is available. This may cause Exim to hang for
26897 a substantial amount of time, causing timeouts on incoming connections.
26898
26899 The solution is to generate the parameters externally to Exim. They are stored
26900 in &_gnutls-params-N_& in PEM format, which means that they can be
26901 generated externally using the &(certtool)& command that is part of GnuTLS.
26902
26903 To replace the parameters with new ones, instead of deleting the file
26904 and letting Exim re-create it, you can generate new parameters using
26905 &(certtool)& and, when this has been done, replace Exim's cache file by
26906 renaming. The relevant commands are something like this:
26907 .code
26908 # ls
26909 [ look for file; assume gnutls-params-2236 is the most recent ]
26910 # rm -f new-params
26911 # touch new-params
26912 # chown exim:exim new-params
26913 # chmod 0600 new-params
26914 # certtool --generate-dh-params --bits 2236 >>new-params
26915 # openssl dhparam -noout -text -in new-params | head
26916 [ check the first line, make sure it's not more than 2236;
26917   if it is, then go back to the start ("rm") and repeat
26918   until the size generated is at most the size requested ]
26919 # chmod 0400 new-params
26920 # mv new-params gnutls-params-2236
26921 .endd
26922 If Exim never has to generate the parameters itself, the possibility of
26923 stalling is removed.
26924
26925 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26926 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26927 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26928 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26929 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26930 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26931 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26932 which applies to all D-H usage, client or server.  If the value returned by
26933 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26934 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26935 limit, which is still much higher than Exim historically used.
26936
26937 The filename and bits used will change as the GnuTLS maintainers change the
26938 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26939 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26940 2432 bits, while NSS is limited to 2236 bits.
26941
26942 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26943 increase the chance of the generated prime actually being within acceptable
26944 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26945 procedure above.  There is no sane procedure available to Exim to double-check
26946 the size of the generated prime, so it might still be too large.
26947
26948
26949 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26950 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26951 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26952 There is a function in the OpenSSL library that can be passed a list of cipher
26953 suites before the cipher negotiation takes place. This specifies which ciphers
26954 are acceptable. The list is colon separated and may contain names like
26955 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26956 directly to this function call.
26957 Many systems will install the OpenSSL manual-pages, so you may have
26958 &'ciphers(1)'& available to you.
26959 The following quotation from the OpenSSL
26960 documentation specifies what forms of item are allowed in the cipher string:
26961
26962 .ilist
26963 It can consist of a single cipher suite such as RC4-SHA.
26964 .next
26965 It can represent a list of cipher suites containing a certain algorithm,
26966 or cipher suites of a certain type. For example SHA1 represents all
26967 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26968 SSL v3 algorithms.
26969 .next
26970 Lists of cipher suites can be combined in a single cipher string using
26971 the + character. This is used as a logical and operation. For example
26972 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26973 algorithms.
26974 .endlist
26975
26976 Each cipher string can be optionally preceded by one of the characters &`!`&,
26977 &`-`& or &`+`&.
26978 .ilist
26979 If &`!`& is used, the ciphers are permanently deleted from the list. The
26980 ciphers deleted can never reappear in the list even if they are explicitly
26981 stated.
26982 .next
26983 If &`-`& is used, the ciphers are deleted from the list, but some or all
26984 of the ciphers can be added again by later options.
26985 .next
26986 If &`+`& is used, the ciphers are moved to the end of the list. This
26987 option does not add any new ciphers; it just moves matching existing ones.
26988 .endlist
26989
26990 If none of these characters is present, the string is interpreted as
26991 a list of ciphers to be appended to the current preference list. If the list
26992 includes any ciphers already present they will be ignored: that is, they will
26993 not be moved to the end of the list.
26994 .endlist
26995
26996 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26997 string:
26998 .code
26999 # note single-quotes to get ! past any shell history expansion
27000 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27001 .endd
27002
27003 This example will let the library defaults be permitted on the MX port, where
27004 there's probably no identity verification anyway, but ups the ante on the
27005 submission ports where the administrator might have some influence on the
27006 choice of clients used:
27007 .code
27008 # OpenSSL variant; see man ciphers(1)
27009 tls_require_ciphers = ${if =={$received_port}{25}\
27010                            {DEFAULT}\
27011                            {HIGH:!MD5:!SHA1}}
27012 .endd
27013
27014
27015
27016 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27017          "SECTreqciphgnu"
27018 .cindex "GnuTLS" "specifying parameters for"
27019 .cindex "TLS" "specifying ciphers (GnuTLS)"
27020 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27021 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27022 .cindex "TLS" "specifying protocols (GnuTLS)"
27023 .cindex "TLS" "specifying priority string (GnuTLS)"
27024 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27025 The GnuTLS library allows the caller to provide a "priority string", documented
27026 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27027 ciphersuite specification in OpenSSL.
27028
27029 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27030 and controls both protocols and ciphers.
27031
27032 The &%tls_require_ciphers%& option is available both as an global option,
27033 controlling how Exim behaves as a server, and also as an option of the
27034 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27035 the value is string expanded.  The resulting string is not an Exim list and
27036 the string is given to the GnuTLS library, so that Exim does not need to be
27037 aware of future feature enhancements of GnuTLS.
27038
27039 Documentation of the strings accepted may be found in the GnuTLS manual, under
27040 "Priority strings".  This is online as
27041 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27042 but beware that this relates to GnuTLS 3, which may be newer than the version
27043 installed on your system.  If you are using GnuTLS 3,
27044 then the example code
27045 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27046 on that site can be used to test a given string.
27047
27048 For example:
27049 .code
27050 # Disable older versions of protocols
27051 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27052 .endd
27053
27054 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27055 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27056 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27057
27058 This example will let the library defaults be permitted on the MX port, where
27059 there's probably no identity verification anyway, and lowers security further
27060 by increasing compatibility; but this ups the ante on the submission ports
27061 where the administrator might have some influence on the choice of clients
27062 used:
27063 .code
27064 # GnuTLS variant
27065 tls_require_ciphers = ${if =={$received_port}{25}\
27066                            {NORMAL:%COMPAT}\
27067                            {SECURE128}}
27068 .endd
27069
27070
27071 .section "Configuring an Exim server to use TLS" "SECID182"
27072 .cindex "TLS" "configuring an Exim server"
27073 When Exim has been built with TLS support, it advertises the availability of
27074 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27075 but not to any others. The default value of this option is unset, which means
27076 that STARTTLS is not advertised at all. This default is chosen because you
27077 need to set some other options in order to make TLS available, and also it is
27078 sensible for systems that want to use TLS only as a client.
27079
27080 If a client issues a STARTTLS command and there is some configuration
27081 problem in the server, the command is rejected with a 454 error. If the client
27082 persists in trying to issue SMTP commands, all except QUIT are rejected
27083 with the error
27084 .code
27085 554 Security failure
27086 .endd
27087 If a STARTTLS command is issued within an existing TLS session, it is
27088 rejected with a 554 error code.
27089
27090 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27091 must be set to match some hosts. The default is * which matches all hosts.
27092
27093 .new
27094 If this is all you do, TLS encryption will be enabled but not authentication -
27095 meaning that the peer has no assurance it is actually you he is talking to.
27096 You gain protection from a passive sniffer listening on the wire but not
27097 from someone able to intercept the communication.
27098 .wen
27099
27100 Further protection requires some further configuration at the server end.
27101
27102 It is rumoured that all existing clients that support TLS/SSL use RSA
27103 encryption. To make this work you need to set, in the server,
27104 .code
27105 tls_certificate = /some/file/name
27106 tls_privatekey = /some/file/name
27107 .endd
27108 These options are, in fact, expanded strings, so you can make them depend on
27109 the identity of the client that is connected if you wish. The first file
27110 contains the server's X509 certificate, and the second contains the private key
27111 that goes with it. These files need to be
27112 PEM format and readable by the Exim user, and must
27113 always be given as full path names.
27114 The key must not be password-protected.
27115 They can be the same file if both the
27116 certificate and the key are contained within it. If &%tls_privatekey%& is not
27117 set, or if its expansion is forced to fail or results in an empty string, this
27118 is assumed to be the case. The certificate file may also contain intermediate
27119 certificates that need to be sent to the client to enable it to authenticate
27120 the server's certificate.
27121
27122 If you do not understand about certificates and keys, please try to find a
27123 source of this background information, which is not Exim-specific. (There are a
27124 few comments below in section &<<SECTcerandall>>&.)
27125
27126 &*Note*&: These options do not apply when Exim is operating as a client &--
27127 they apply only in the case of a server. If you need to use a certificate in an
27128 Exim client, you must set the options of the same names in an &(smtp)&
27129 transport.
27130
27131 With just these options, an Exim server will be able to use TLS. It does not
27132 require the client to have a certificate (but see below for how to insist on
27133 this). There is one other option that may be needed in other situations. If
27134 .code
27135 tls_dhparam = /some/file/name
27136 .endd
27137 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27138 with the parameters contained in the file.
27139 Set this to &`none`& to disable use of DH entirely, by making no prime
27140 available:
27141 .code
27142 tls_dhparam = none
27143 .endd
27144 This may also be set to a string identifying a standard prime to be used for
27145 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27146 used is &`ike23`&.  There are a few standard primes available, see the
27147 documentation for &%tls_dhparam%& for the complete list.
27148
27149 See the command
27150 .code
27151 openssl dhparam
27152 .endd
27153 for a way of generating file data.
27154
27155 The strings supplied for these three options are expanded every time a client
27156 host connects. It is therefore possible to use different certificates and keys
27157 for different hosts, if you so wish, by making use of the client's IP address
27158 in &$sender_host_address$& to control the expansion. If a string expansion is
27159 forced to fail, Exim behaves as if the option is not set.
27160
27161 .cindex "cipher" "logging"
27162 .cindex "log" "TLS cipher"
27163 .vindex "&$tls_in_cipher$&"
27164 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27165 an incoming TLS connection. It is included in the &'Received:'& header of an
27166 incoming message (by default &-- you can, of course, change this), and it is
27167 also included in the log line that records a message's arrival, keyed by
27168 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27169 condition can be used to test for specific cipher suites in ACLs.
27170
27171 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27172 can check the name of the cipher suite and vary their actions accordingly. The
27173 cipher suite names vary, depending on which TLS library is being used. For
27174 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27175 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27176 documentation for more details.
27177
27178 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27179 (again depending on the &%tls_cipher%& log selector).
27180
27181
27182 .section "Requesting and verifying client certificates" "SECID183"
27183 .cindex "certificate" "verification of client"
27184 .cindex "TLS" "client certificate verification"
27185 If you want an Exim server to request a certificate when negotiating a TLS
27186 session with a client, you must set either &%tls_verify_hosts%& or
27187 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27188 apply to all TLS connections. For any host that matches one of these options,
27189 Exim requests a certificate as part of the setup of the TLS session. The
27190 contents of the certificate are verified by comparing it with a list of
27191 expected certificates.
27192 These may be the system default set (depending on library version),
27193 an explicit file or,
27194 depending on library version, a directory, identified by
27195 &%tls_verify_certificates%&.
27196
27197 A file can contain multiple certificates, concatenated end to end. If a
27198 directory is used
27199 (OpenSSL only),
27200 each certificate must be in a separate file, with a name (or a symbolic link)
27201 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27202 certificate. You can compute the relevant hash by running the command
27203 .code
27204 openssl x509 -hash -noout -in /cert/file
27205 .endd
27206 where &_/cert/file_& contains a single certificate.
27207
27208 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27209 what happens if the client does not supply a certificate, or if the certificate
27210 does not match any of the certificates in the collection named by
27211 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27212 attempt to set up a TLS session is aborted, and the incoming connection is
27213 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27214 session continues. ACLs that run for subsequent SMTP commands can detect the
27215 fact that no certificate was verified, and vary their actions accordingly. For
27216 example, you can insist on a certificate before accepting a message for
27217 relaying, but not when the message is destined for local delivery.
27218
27219 .vindex "&$tls_in_peerdn$&"
27220 When a client supplies a certificate (whether it verifies or not), the value of
27221 the Distinguished Name of the certificate is made available in the variable
27222 &$tls_in_peerdn$& during subsequent processing of the message.
27223
27224 .cindex "log" "distinguished name"
27225 Because it is often a long text string, it is not included in the log line or
27226 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27227 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27228 &%received_header_text%& to change the &'Received:'& header. When no
27229 certificate is supplied, &$tls_in_peerdn$& is empty.
27230
27231
27232 .section "Revoked certificates" "SECID184"
27233 .cindex "TLS" "revoked certificates"
27234 .cindex "revocation list"
27235 .cindex "certificate" "revocation list"
27236 .cindex "OCSP" "stapling"
27237 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27238 certificates are revoked. If you have such a list, you can pass it to an Exim
27239 server using the global option called &%tls_crl%& and to an Exim client using
27240 an identically named option for the &(smtp)& transport. In each case, the value
27241 of the option is expanded and must then be the name of a file that contains a
27242 CRL in PEM format.
27243 The downside is that clients have to periodically re-download a potentially huge
27244 file from every certificate authority they know of.
27245
27246 The way with most moving parts at query time is Online Certificate
27247 Status Protocol (OCSP), where the client verifies the certificate
27248 against an OCSP server run by the CA.  This lets the CA track all
27249 usage of the certs.  It requires running software with access to the
27250 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27251 is based on HTTP and can be proxied accordingly.
27252
27253 The only widespread OCSP server implementation (known to this writer)
27254 comes as part of OpenSSL and aborts on an invalid request, such as
27255 connecting to the port and then disconnecting.  This requires
27256 re-entering the passphrase each time some random client does this.
27257
27258 The third way is OCSP Stapling; in this, the server using a certificate
27259 issued by the CA periodically requests an OCSP proof of validity from
27260 the OCSP server, then serves it up inline as part of the TLS
27261 negotiation.   This approach adds no extra round trips, does not let the
27262 CA track users, scales well with number of certs issued by the CA and is
27263 resilient to temporary OCSP server failures, as long as the server
27264 starts retrying to fetch an OCSP proof some time before its current
27265 proof expires.  The downside is that it requires server support.
27266
27267 Unless Exim is built with the support disabled,
27268 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27269 support for OCSP stapling is included.
27270
27271 There is a global option called &%tls_ocsp_file%&.
27272 The file specified therein is expected to be in DER format, and contain
27273 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27274 option will be re-expanded for SNI, if the &%tls_certificate%& option
27275 contains &`tls_in_sni`&, as per other TLS options.
27276
27277 Exim does not at this time implement any support for fetching a new OCSP
27278 proof.  The burden is on the administrator to handle this, outside of
27279 Exim.  The file specified should be replaced atomically, so that the
27280 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27281 on each connection, so a new file will be handled transparently on the
27282 next connection.
27283
27284 When built with OpenSSL Exim will check for a valid next update timestamp
27285 in the OCSP proof; if not present, or if the proof has expired, it will be
27286 ignored.
27287
27288 For the client to be able to verify the stapled OCSP the server must
27289 also supply, in its stapled information, any intermediate
27290 certificates for the chain leading to the OCSP proof from the signer
27291 of the server certificate.  There may be zero or one such. These
27292 intermediate certificates should be added to the server OCSP stapling
27293 file named by &%tls_ocsp_file%&.
27294
27295 Note that the proof only covers the terminal server certificate,
27296 not any of the chain from CA to it.
27297
27298 There is no current way to staple a proof for a client certificate.
27299
27300 .code
27301   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27302   OCSP server is supplied.  The server URL may be included in the
27303   server certificate, if the CA is helpful.
27304
27305   One failure mode seen was the OCSP Signer cert expiring before the end
27306   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27307   noted this as invalid overall, but the re-fetch script did not.
27308 .endd
27309
27310
27311
27312
27313 .section "Configuring an Exim client to use TLS" "SECID185"
27314 .cindex "cipher" "logging"
27315 .cindex "log" "TLS cipher"
27316 .cindex "log" "distinguished name"
27317 .cindex "TLS" "configuring an Exim client"
27318 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27319 deliveries as well as to incoming, the latter one causing logging of the
27320 server certificate's DN. The remaining client configuration for TLS is all
27321 within the &(smtp)& transport.
27322
27323 It is not necessary to set any options to have TLS work in the &(smtp)&
27324 transport. If Exim is built with TLS support, and TLS is advertised by a
27325 server, the &(smtp)& transport always tries to start a TLS session. However,
27326 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27327 transport) to a list of server hosts for which TLS should not be used.
27328
27329 If you do not want Exim to attempt to send messages unencrypted when an attempt
27330 to set up an encrypted connection fails in any way, you can set
27331 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27332 those hosts, delivery is always deferred if an encrypted connection cannot be
27333 set up. If there are any other hosts for the address, they are tried in the
27334 usual way.
27335
27336 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27337 the message unencrypted. It always does this if the response to STARTTLS is
27338 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27339 session after a success response code, what happens is controlled by the
27340 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27341 delivery to this host is deferred, and other hosts (if available) are tried. If
27342 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27343 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27344 negotiation fails, Exim closes the current connection (because it is in an
27345 unknown state), opens a new one to the same host, and then tries the delivery
27346 unencrypted.
27347
27348 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27349 transport provide the client with a certificate, which is passed to the server
27350 if it requests it. If the server is Exim, it will request a certificate only if
27351 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27352
27353 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27354 specifies a collection of expected server certificates.
27355 These may be the system default set (depending on library version),
27356 a file or,
27357 depending on library version, a directory,
27358 must name a file or,
27359 for OpenSSL only (not GnuTLS), a directory.
27360 The client verifies the server's certificate
27361 against this collection, taking into account any revoked certificates that are
27362 in the list defined by &%tls_crl%&.
27363 Failure to verify fails the TLS connection unless either of the
27364 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27365
27366 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27367 certificate verification to the listed servers.  Verification either must
27368 or need not succeed respectively.
27369
27370 The &(smtp)& transport has two OCSP-related options:
27371 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27372 is requested and required for the connection to proceed.  The default
27373 value is empty.
27374 &%hosts_request_ocsp%&; a host-list for which (additionally)
27375 a Certificate Status is requested (but not necessarily verified).  The default
27376 value is "*" meaning that requests are made unless configured
27377 otherwise.
27378
27379 The host(s) should also be in &%hosts_require_tls%&, and
27380 &%tls_verify_certificates%& configured for the transport,
27381 for OCSP to be relevant.
27382
27383 If
27384 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27385 list of permitted cipher suites. If either of these checks fails, delivery to
27386 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27387 alternative hosts, if any.
27388
27389  &*Note*&:
27390 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27391 is operating as a client. Exim does not assume that a server certificate (set
27392 by the global options of the same name) should also be used when operating as a
27393 client.
27394
27395 .vindex "&$host$&"
27396 .vindex "&$host_address$&"
27397 All the TLS options in the &(smtp)& transport are expanded before use, with
27398 &$host$& and &$host_address$& containing the name and address of the server to
27399 which the client is connected. Forced failure of an expansion causes Exim to
27400 behave as if the relevant option were unset.
27401
27402 .vindex &$tls_out_bits$&
27403 .vindex &$tls_out_cipher$&
27404 .vindex &$tls_out_peerdn$&
27405 .vindex &$tls_out_sni$&
27406 Before an SMTP connection is established, the
27407 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27408 variables are emptied. (Until the first connection, they contain the values
27409 that were set when the message was received.) If STARTTLS is subsequently
27410 successfully obeyed, these variables are set to the relevant values for the
27411 outgoing connection.
27412
27413
27414
27415 .section "Use of TLS Server Name Indication" "SECTtlssni"
27416 .cindex "TLS" "Server Name Indication"
27417 .vindex "&$tls_in_sni$&"
27418 .oindex "&%tls_in_sni%&"
27419 With TLS1.0 or above, there is an extension mechanism by which extra
27420 information can be included at various points in the protocol.  One of these
27421 extensions, documented in RFC 6066 (and before that RFC 4366) is
27422 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27423 client in the initial handshake, so that the server can examine the servername
27424 within and possibly choose to use different certificates and keys (and more)
27425 for this session.
27426
27427 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27428 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27429 address.
27430
27431 With SMTP to MX, there are the same problems here as in choosing the identity
27432 against which to validate a certificate: you can't rely on insecure DNS to
27433 provide the identity which you then cryptographically verify.  So this will
27434 be of limited use in that environment.
27435
27436 With SMTP to Submission, there is a well-defined hostname which clients are
27437 connecting to and can validate certificates against.  Thus clients &*can*&
27438 choose to include this information in the TLS negotiation.  If this becomes
27439 wide-spread, then hosters can choose to present different certificates to
27440 different clients.  Or even negotiate different cipher suites.
27441
27442 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27443 if not empty, will be sent on a TLS session as part of the handshake.  There's
27444 nothing more to it.  Choosing a sensible value not derived insecurely is the
27445 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27446 for the lifetime of the client connection (including during authentication).
27447
27448 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27449 received from a client.
27450 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27451
27452 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27453 option (prior to expansion) then the following options will be re-expanded
27454 during TLS session handshake, to permit alternative values to be chosen:
27455
27456 .ilist
27457 .vindex "&%tls_certificate%&"
27458 &%tls_certificate%&
27459 .next
27460 .vindex "&%tls_crl%&"
27461 &%tls_crl%&
27462 .next
27463 .vindex "&%tls_privatekey%&"
27464 &%tls_privatekey%&
27465 .next
27466 .vindex "&%tls_verify_certificates%&"
27467 &%tls_verify_certificates%&
27468 .next
27469 .vindex "&%tls_ocsp_file%&"
27470 &%tls_ocsp_file%&
27471 .endlist
27472
27473 Great care should be taken to deal with matters of case, various injection
27474 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27475 can always be referenced; it is important to remember that &$tls_sni$& is
27476 arbitrary unverified data provided prior to authentication.
27477
27478 The Exim developers are proceeding cautiously and so far no other TLS options
27479 are re-expanded.
27480
27481 When Exim is built against OpenSSL, OpenSSL must have been built with support
27482 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27483 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27484 see &`-servername`& in the output, then OpenSSL has support.
27485
27486 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27487 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27488 built, then you have SNI support).
27489
27490
27491
27492 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27493          "SECTmulmessam"
27494 .cindex "multiple SMTP deliveries with TLS"
27495 .cindex "TLS" "multiple message deliveries"
27496 Exim sends multiple messages down the same TCP/IP connection by starting up
27497 an entirely new delivery process for each message, passing the socket from
27498 one process to the next. This implementation does not fit well with the use
27499 of TLS, because there is quite a lot of state information associated with a TLS
27500 connection, not just a socket identification. Passing all the state information
27501 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27502 session before passing the socket to a new process. The new process may then
27503 try to start a new TLS session, and if successful, may try to re-authenticate
27504 if AUTH is in use, before sending the next message.
27505
27506 The RFC is not clear as to whether or not an SMTP session continues in clear
27507 after TLS has been shut down, or whether TLS may be restarted again later, as
27508 just described. However, if the server is Exim, this shutdown and
27509 reinitialization works. It is not known which (if any) other servers operate
27510 successfully if the client closes a TLS session and continues with unencrypted
27511 SMTP, but there are certainly some that do not work. For such servers, Exim
27512 should not pass the socket to another process, because the failure of the
27513 subsequent attempt to use it would cause Exim to record a temporary host error,
27514 and delay other deliveries to that host.
27515
27516 To test for this case, Exim sends an EHLO command to the server after
27517 closing down the TLS session. If this fails in any way, the connection is
27518 closed instead of being passed to a new delivery process, but no retry
27519 information is recorded.
27520
27521 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27522 &(smtp)& transport to match those hosts for which Exim should not pass
27523 connections to new processes if TLS has been used.
27524
27525
27526
27527
27528 .section "Certificates and all that" "SECTcerandall"
27529 .cindex "certificate" "references to discussion"
27530 In order to understand fully how TLS works, you need to know about
27531 certificates, certificate signing, and certificate authorities. This is not the
27532 place to give a tutorial, especially as I do not know very much about it
27533 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27534 to Apache, currently at
27535 .display
27536 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27537 .endd
27538 Other parts of the &'modssl'& documentation are also helpful, and have
27539 links to further files.
27540 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27541 0-201-61598-3), contains both introductory and more in-depth descriptions.
27542 Some sample programs taken from the book are available from
27543 .display
27544 &url(http://www.rtfm.com/openssl-examples/)
27545 .endd
27546
27547
27548 .section "Certificate chains" "SECID186"
27549 The file named by &%tls_certificate%& may contain more than one
27550 certificate. This is useful in the case where the certificate that is being
27551 sent is validated by an intermediate certificate which the other end does
27552 not have. Multiple certificates must be in the correct order in the file.
27553 First the host's certificate itself, then the first intermediate
27554 certificate to validate the issuer of the host certificate, then the next
27555 intermediate certificate to validate the issuer of the first intermediate
27556 certificate, and so on, until finally (optionally) the root certificate.
27557 The root certificate must already be trusted by the recipient for
27558 validation to succeed, of course, but if it's not preinstalled, sending the
27559 root certificate along with the rest makes it available for the user to
27560 install if the receiving end is a client MUA that can interact with a user.
27561
27562 Note that certificates using MD5 are unlikely to work on today's Internet;
27563 even if your libraries allow loading them for use in Exim when acting as a
27564 server, increasingly clients will not accept such certificates.  The error
27565 diagnostics in such a case can be frustratingly vague.
27566
27567
27568
27569 .section "Self-signed certificates" "SECID187"
27570 .cindex "certificate" "self-signed"
27571 You can create a self-signed certificate using the &'req'& command provided
27572 with OpenSSL, like this:
27573 . ==== Do not shorten the duration here without reading and considering
27574 . ==== the text below.  Please leave it at 9999 days.
27575 .code
27576 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27577             -days 9999 -nodes
27578 .endd
27579 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27580 delimited and so can be identified independently. The &%-days%& option
27581 specifies a period for which the certificate is valid. The &%-nodes%& option is
27582 important: if you do not set it, the key is encrypted with a passphrase
27583 that you are prompted for, and any use that is made of the key causes more
27584 prompting for the passphrase. This is not helpful if you are going to use
27585 this certificate and key in an MTA, where prompting is not possible.
27586
27587 . ==== I expect to still be working 26 years from now.  The less technical
27588 . ==== debt I create, in terms of storing up trouble for my later years, the
27589 . ==== happier I will be then.  We really have reached the point where we
27590 . ==== should start, at the very least, provoking thought and making folks
27591 . ==== pause before proceeding, instead of leaving all the fixes until two
27592 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27593 . ==== -pdp, 2012
27594 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27595 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27596 the above command might produce a date in the past.  Think carefully about
27597 the lifetime of the systems you're deploying, and either reduce the duration
27598 of the certificate or reconsider your platform deployment.  (At time of
27599 writing, reducing the duration is the most likely choice, but the inexorable
27600 progression of time takes us steadily towards an era where this will not
27601 be a sensible resolution).
27602
27603 A self-signed certificate made in this way is sufficient for testing, and
27604 may be adequate for all your requirements if you are mainly interested in
27605 encrypting transfers, and not in secure identification.
27606
27607 However, many clients require that the certificate presented by the server be a
27608 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27609 certificate. In this situation, the self-signed certificate described above
27610 must be installed on the client host as a trusted root &'certification
27611 authority'& (CA), and the certificate used by Exim must be a user certificate
27612 signed with that self-signed certificate.
27613
27614 For information on creating self-signed CA certificates and using them to sign
27615 user certificates, see the &'General implementation overview'& chapter of the
27616 Open-source PKI book, available online at
27617 &url(http://ospkibook.sourceforge.net/).
27618 .ecindex IIDencsmtp1
27619 .ecindex IIDencsmtp2
27620
27621
27622
27623 . ////////////////////////////////////////////////////////////////////////////
27624 . ////////////////////////////////////////////////////////////////////////////
27625
27626 .chapter "Access control lists" "CHAPACL"
27627 .scindex IIDacl "&ACL;" "description"
27628 .cindex "control of incoming mail"
27629 .cindex "message" "controlling incoming"
27630 .cindex "policy control" "access control lists"
27631 Access Control Lists (ACLs) are defined in a separate section of the run time
27632 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27633 name, terminated by a colon. Here is a complete ACL section that contains just
27634 one very small ACL:
27635 .code
27636 begin acl
27637 small_acl:
27638   accept   hosts = one.host.only
27639 .endd
27640 You can have as many lists as you like in the ACL section, and the order in
27641 which they appear does not matter. The lists are self-terminating.
27642
27643 The majority of ACLs are used to control Exim's behaviour when it receives
27644 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27645 when a local process submits a message using SMTP by specifying the &%-bs%&
27646 option. The most common use is for controlling which recipients are accepted
27647 in incoming messages. In addition, you can define an ACL that is used to check
27648 local non-SMTP messages. The default configuration file contains an example of
27649 a realistic ACL for checking RCPT commands. This is discussed in chapter
27650 &<<CHAPdefconfil>>&.
27651
27652
27653 .section "Testing ACLs" "SECID188"
27654 The &%-bh%& command line option provides a way of testing your ACL
27655 configuration locally by running a fake SMTP session with which you interact.
27656
27657
27658 .section "Specifying when ACLs are used" "SECID189"
27659 .cindex "&ACL;" "options for specifying"
27660 In order to cause an ACL to be used, you have to name it in one of the relevant
27661 options in the main part of the configuration. These options are:
27662 .cindex "AUTH" "ACL for"
27663 .cindex "DATA" "ACLs for"
27664 .cindex "ETRN" "ACL for"
27665 .cindex "EXPN" "ACL for"
27666 .cindex "HELO" "ACL for"
27667 .cindex "EHLO" "ACL for"
27668 .cindex "DKIM" "ACL for"
27669 .cindex "MAIL" "ACL for"
27670 .cindex "QUIT, ACL for"
27671 .cindex "RCPT" "ACL for"
27672 .cindex "STARTTLS, ACL for"
27673 .cindex "VRFY" "ACL for"
27674 .cindex "SMTP" "connection, ACL for"
27675 .cindex "non-SMTP messages" "ACLs for"
27676 .cindex "MIME content scanning" "ACL for"
27677 .cindex "PRDR" "ACL for"
27678
27679 .table2 140pt
27680 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27681 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27682 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27683 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27684 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27685 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27686 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27687 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27688 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27689 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27690 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27691 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27692 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27693 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27694 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27695 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27696 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27697 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27698 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27699 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27700 .endtable
27701
27702 For example, if you set
27703 .code
27704 acl_smtp_rcpt = small_acl
27705 .endd
27706 the little ACL defined above is used whenever Exim receives a RCPT command
27707 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27708 done when RCPT commands arrive. A rejection of RCPT should cause the
27709 sending MTA to give up on the recipient address contained in the RCPT
27710 command, whereas rejection at other times may cause the client MTA to keep on
27711 trying to deliver the message. It is therefore recommended that you do as much
27712 testing as possible at RCPT time.
27713
27714
27715 .section "The non-SMTP ACLs" "SECID190"
27716 .cindex "non-SMTP messages" "ACLs for"
27717 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27718 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27719 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27720 the state of the SMTP connection such as encryption and authentication) are not
27721 relevant and are forbidden in these ACLs. However, the sender and recipients
27722 are known, so the &%senders%& and &%sender_domains%& conditions and the
27723 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27724 &$authenticated_sender$& are also available. You can specify added header lines
27725 in any of these ACLs.
27726
27727 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27728 non-SMTP message, before any of the message has been read. (This is the
27729 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27730 batched SMTP input, it runs after the DATA command has been reached. The
27731 result of this ACL is ignored; it cannot be used to reject a message. If you
27732 really need to, you could set a value in an ACL variable here and reject based
27733 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27734 controls, and in particular, it can be used to set
27735 .code
27736 control = suppress_local_fixups
27737 .endd
27738 This cannot be used in the other non-SMTP ACLs because by the time they are
27739 run, it is too late.
27740
27741 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27742 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27743
27744 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27745 kind of rejection is treated as permanent, because there is no way of sending a
27746 temporary error for these kinds of message.
27747
27748
27749 .section "The SMTP connect ACL" "SECID191"
27750 .cindex "SMTP" "connection, ACL for"
27751 .oindex &%smtp_banner%&
27752 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27753 session, after the test specified by &%host_reject_connection%& (which is now
27754 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27755 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27756 the message override the banner message that is otherwise specified by the
27757 &%smtp_banner%& option.
27758
27759
27760 .section "The EHLO/HELO ACL" "SECID192"
27761 .cindex "EHLO" "ACL for"
27762 .cindex "HELO" "ACL for"
27763 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27764 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27765 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27766 Note that a client may issue more than one EHLO or HELO command in an SMTP
27767 session, and indeed is required to issue a new EHLO or HELO after successfully
27768 setting up encryption following a STARTTLS command.
27769
27770 Note also that a deny neither forces the client to go away nor means that
27771 mail will be refused on the connection.  Consider checking for
27772 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27773
27774 If the command is accepted by an &%accept%& verb that has a &%message%&
27775 modifier, the message may not contain more than one line (it will be truncated
27776 at the first newline and a panic logged if it does). Such a message cannot
27777 affect the EHLO options that are listed on the second and subsequent lines of
27778 an EHLO response.
27779
27780
27781 .section "The DATA ACLs" "SECID193"
27782 .cindex "DATA" "ACLs for"
27783 Two ACLs are associated with the DATA command, because it is two-stage
27784 command, with two responses being sent to the client.
27785 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27786 is obeyed. This gives you control after all the RCPT commands, but before
27787 the message itself is received. It offers the opportunity to give a negative
27788 response to the DATA command before the data is transmitted. Header lines
27789 added by MAIL or RCPT ACLs are not visible at this time, but any that
27790 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27791
27792 You cannot test the contents of the message, for example, to verify addresses
27793 in the headers, at RCPT time or when the DATA command is received. Such
27794 tests have to appear in the ACL that is run after the message itself has been
27795 received, before the final response to the DATA command is sent. This is
27796 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27797 associated with the DATA command.
27798
27799 .new
27800 .cindex CHUNKING "BDAT command"
27801 .cindex BDAT "SMTP command"
27802 .cindex "RFC 3030" CHUNKING
27803 If CHUNKING was advertised and a BDAT command sequence is received,
27804 the &%acl_smtp_predata%& ACL is not run.
27805 . XXX why not?  It should be possible, for the first BDAT.
27806 The &%acl_smtp_data%& is run after the last BDAT command and all of
27807 the data specified is received.
27808 .wen
27809
27810 For both of these ACLs, it is not possible to reject individual recipients. An
27811 error response rejects the entire message. Unfortunately, it is known that some
27812 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27813 before or after the data) correctly &-- they keep the message on their queues
27814 and try again later, but that is their problem, though it does waste some of
27815 your resources.
27816
27817 The &%acl_smtp_data%& ACL is run after
27818 the &%acl_smtp_data_prdr%&,
27819 the &%acl_smtp_dkim%&
27820 and the &%acl_smtp_mime%& ACLs.
27821
27822 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27823 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27824 enabled (which is the default).
27825
27826 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27827 received, and is executed for each DKIM signature found in a message.  If not
27828 otherwise specified, the default action is to accept.
27829
27830 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27831
27832 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27833
27834
27835 .section "The SMTP MIME ACL" "SECID194"
27836 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27837 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27838
27839 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27840
27841
27842 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27843 .cindex "PRDR" "ACL for"
27844 .oindex "&%prdr_enable%&"
27845 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27846 with PRDR support enabled (which is the default).
27847 It becomes active only when the PRDR feature is negotiated between
27848 client and server for a message, and more than one recipient
27849 has been accepted.
27850
27851 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27852 has been received, and is executed once for each recipient of the message
27853 with &$local_part$& and &$domain$& valid.
27854 The test may accept, defer or deny for individual recipients.
27855 The &%acl_smtp_data%& will still be called after this ACL and
27856 can reject the message overall, even if this ACL has accepted it
27857 for some or all recipients.
27858
27859 PRDR may be used to support per-user content filtering.  Without it
27860 one must defer any recipient after the first that has a different
27861 content-filter configuration.  With PRDR, the RCPT-time check
27862 .cindex "PRDR" "variable for"
27863 for this can be disabled when the variable &$prdr_requested$&
27864 is &"yes"&.
27865 Any required difference in behaviour of the main DATA-time
27866 ACL should however depend on the PRDR-time ACL having run, as Exim
27867 will avoid doing so in some situations (e.g.  single-recipient mails).
27868
27869 See also the &%prdr_enable%& global option
27870 and the &%hosts_try_prdr%& smtp transport option.
27871
27872 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27873 If the ACL is not defined, processing completes as if
27874 the feature was not requested by the client.
27875
27876 .section "The QUIT ACL" "SECTQUITACL"
27877 .cindex "QUIT, ACL for"
27878 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27879 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27880 does not in fact control any access.
27881 For this reason, it may only accept
27882 or warn as its final result.
27883
27884 This ACL can be used for tasks such as custom logging at the end of an SMTP
27885 session. For example, you can use ACL variables in other ACLs to count
27886 messages, recipients, etc., and log the totals at QUIT time using one or
27887 more &%logwrite%& modifiers on a &%warn%& verb.
27888
27889 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27890 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27891
27892 You do not need to have a final &%accept%&, but if you do, you can use a
27893 &%message%& modifier to specify custom text that is sent as part of the 221
27894 response to QUIT.
27895
27896 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27897 failure (for example, failure to open a log file, or when Exim is bombing out
27898 because it has detected an unrecoverable error), all SMTP commands from the
27899 client are given temporary error responses until QUIT is received or the
27900 connection is closed. In these special cases, the QUIT ACL does not run.
27901
27902
27903 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27904 .vindex &$acl_smtp_notquit$&
27905 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27906 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27907 trouble, such as being unable to write to its log files, this ACL is not run,
27908 because it might try to do things (such as write to log files) that make the
27909 situation even worse.
27910
27911 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27912 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27913 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27914 and &%warn%&.
27915
27916 .vindex &$smtp_notquit_reason$&
27917 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27918 to a string that indicates the reason for the termination of the SMTP
27919 connection. The possible values are:
27920 .table2
27921 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27922 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27923 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27924 .irow &`connection-lost`&          "The SMTP connection has been lost"
27925 .irow &`data-timeout`&             "Timeout while reading message data"
27926 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27927 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27928 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27929 .irow &`synchronization-error`&    "SMTP synchronization error"
27930 .irow &`tls-failed`&               "TLS failed to start"
27931 .endtable
27932 In most cases when an SMTP connection is closed without having received QUIT,
27933 Exim sends an SMTP response message before actually closing the connection.
27934 With the exception of the &`acl-drop`& case, the default message can be
27935 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27936 &%drop%& verb in another ACL, it is the message from the other ACL that is
27937 used.
27938
27939
27940 .section "Finding an ACL to use" "SECID195"
27941 .cindex "&ACL;" "finding which to use"
27942 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27943 you can use different ACLs in different circumstances. For example,
27944 .code
27945 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27946                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27947 .endd
27948 In the default configuration file there are some example settings for
27949 providing an RFC 4409 message submission service on port 587 and a
27950 non-standard &"smtps"& service on port 465. You can use a string
27951 expansion like this to choose an ACL for MUAs on these ports which is
27952 more appropriate for this purpose than the default ACL on port 25.
27953
27954 The expanded string does not have to be the name of an ACL in the
27955 configuration file; there are other possibilities. Having expanded the
27956 string, Exim searches for an ACL as follows:
27957
27958 .ilist
27959 If the string begins with a slash, Exim uses it as a file name, and reads its
27960 contents as an ACL. The lines are processed in the same way as lines in the
27961 Exim configuration file. In particular, continuation lines are supported, blank
27962 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27963 If the file does not exist or cannot be read, an error occurs (typically
27964 causing a temporary failure of whatever caused the ACL to be run). For example:
27965 .code
27966 acl_smtp_data = /etc/acls/\
27967   ${lookup{$sender_host_address}lsearch\
27968   {/etc/acllist}{$value}{default}}
27969 .endd
27970 This looks up an ACL file to use on the basis of the host's IP address, falling
27971 back to a default if the lookup fails. If an ACL is successfully read from a
27972 file, it is retained in memory for the duration of the Exim process, so that it
27973 can be re-used without having to re-read the file.
27974 .next
27975 If the string does not start with a slash, and does not contain any spaces,
27976 Exim searches the ACL section of the configuration for an ACL whose name
27977 matches the string.
27978 .next
27979 If no named ACL is found, or if the string contains spaces, Exim parses
27980 the string as an inline ACL. This can save typing in cases where you just
27981 want to have something like
27982 .code
27983 acl_smtp_vrfy = accept
27984 .endd
27985 in order to allow free use of the VRFY command. Such a string may contain
27986 newlines; it is processed in the same way as an ACL that is read from a file.
27987 .endlist
27988
27989
27990
27991
27992 .section "ACL return codes" "SECID196"
27993 .cindex "&ACL;" "return codes"
27994 Except for the QUIT ACL, which does not affect the SMTP return code (see
27995 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27996 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27997 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27998 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27999 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28000 This also causes a 4&'xx'& return code.
28001
28002 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28003 &"deny"&, because there is no mechanism for passing temporary errors to the
28004 submitters of non-SMTP messages.
28005
28006
28007 ACLs that are relevant to message reception may also return &"discard"&. This
28008 has the effect of &"accept"&, but causes either the entire message or an
28009 individual recipient address to be discarded. In other words, it is a
28010 blackholing facility. Use it with care.
28011
28012 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28013 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28014 RCPT ACL is to discard just the one recipient address. If there are no
28015 recipients left when the message's data is received, the DATA ACL is not
28016 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28017 remaining recipients. The &"discard"& return is not permitted for the
28018 &%acl_smtp_predata%& ACL.
28019
28020
28021 .cindex "&[local_scan()]& function" "when all recipients discarded"
28022 The &[local_scan()]& function is always run, even if there are no remaining
28023 recipients; it may create new recipients.
28024
28025
28026
28027 .section "Unset ACL options" "SECID197"
28028 .cindex "&ACL;" "unset options"
28029 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28030 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28031 not defined at all. For any defined ACL, the default action when control
28032 reaches the end of the ACL statements is &"deny"&.
28033
28034 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28035 these two are ACLs that are used only for their side effects. They cannot be
28036 used to accept or reject anything.
28037
28038 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28039 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28040 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28041 when the ACL is not defined is &"accept"&.
28042
28043 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28044 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28045 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28046 messages over an SMTP connection. For an example, see the ACL in the default
28047 configuration file.
28048
28049
28050
28051
28052 .section "Data for message ACLs" "SECID198"
28053 .cindex "&ACL;" "data for message ACL"
28054 .vindex &$domain$&
28055 .vindex &$local_part$&
28056 .vindex &$sender_address$&
28057 .vindex &$sender_host_address$&
28058 .vindex &$smtp_command$&
28059 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28060 that contain information about the host and the message's sender (for example,
28061 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28062 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28063 &$local_part$& are set from the argument address. The entire SMTP command
28064 is available in &$smtp_command$&.
28065
28066 When an ACL for the AUTH parameter of MAIL is running, the variables that
28067 contain information about the host are set, but &$sender_address$& is not yet
28068 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28069 how it is used.
28070
28071 .vindex "&$message_size$&"
28072 The &$message_size$& variable is set to the value of the SIZE parameter on
28073 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28074 that parameter is not given. The value is updated to the true message size by
28075 the time the final DATA ACL is run (after the message data has been
28076 received).
28077
28078 .vindex "&$rcpt_count$&"
28079 .vindex "&$recipients_count$&"
28080 The &$rcpt_count$& variable increases by one for each RCPT command received.
28081 The &$recipients_count$& variable increases by one each time a RCPT command is
28082 accepted, so while an ACL for RCPT is being processed, it contains the number
28083 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28084 &$rcpt_count$& contains the total number of RCPT commands, and
28085 &$recipients_count$& contains the total number of accepted recipients.
28086
28087
28088
28089
28090
28091 .section "Data for non-message ACLs" "SECTdatfornon"
28092 .cindex "&ACL;" "data for non-message ACL"
28093 .vindex &$smtp_command_argument$&
28094 .vindex &$smtp_command$&
28095 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28096 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28097 and the entire SMTP command is available in &$smtp_command$&.
28098 These variables can be tested using a &%condition%& condition. For example,
28099 here is an ACL for use with AUTH, which insists that either the session is
28100 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28101 does not permit authentication methods that use cleartext passwords on
28102 unencrypted connections.
28103 .code
28104 acl_check_auth:
28105   accept encrypted = *
28106   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28107                      {CRAM-MD5}}
28108   deny   message   = TLS encryption or CRAM-MD5 required
28109 .endd
28110 (Another way of applying this restriction is to arrange for the authenticators
28111 that use cleartext passwords not to be advertised when the connection is not
28112 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28113 option to do this.)
28114
28115
28116
28117 .section "Format of an ACL" "SECID199"
28118 .cindex "&ACL;" "format of"
28119 .cindex "&ACL;" "verbs, definition of"
28120 An individual ACL consists of a number of statements. Each statement starts
28121 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28122 Modifiers can change the way the verb operates, define error and log messages,
28123 set variables, insert delays, and vary the processing of accepted messages.
28124
28125 If all the conditions are met, the verb is obeyed. The same condition may be
28126 used (with different arguments) more than once in the same statement. This
28127 provides a means of specifying an &"and"& conjunction between conditions. For
28128 example:
28129 .code
28130 deny  dnslists = list1.example
28131 dnslists = list2.example
28132 .endd
28133 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28134 the conditions and modifiers when it reaches a condition that fails. What
28135 happens then depends on the verb (and in one case, on a special modifier). Not
28136 all the conditions make sense at every testing point. For example, you cannot
28137 test a sender address in the ACL that is run for a VRFY command.
28138
28139
28140 .section "ACL verbs" "SECID200"
28141 The ACL verbs are as follows:
28142
28143 .ilist
28144 .cindex "&%accept%& ACL verb"
28145 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28146 of the conditions are not met, what happens depends on whether &%endpass%&
28147 appears among the conditions (for syntax see below). If the failing condition
28148 is before &%endpass%&, control is passed to the next ACL statement; if it is
28149 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28150 check a RCPT command:
28151 .code
28152 accept domains = +local_domains
28153 endpass
28154 verify = recipient
28155 .endd
28156 If the recipient domain does not match the &%domains%& condition, control
28157 passes to the next statement. If it does match, the recipient is verified, and
28158 the command is accepted if verification succeeds. However, if verification
28159 fails, the ACL yields &"deny"&, because the failing condition is after
28160 &%endpass%&.
28161
28162 The &%endpass%& feature has turned out to be confusing to many people, so its
28163 use is not recommended nowadays. It is always possible to rewrite an ACL so
28164 that &%endpass%& is not needed, and it is no longer used in the default
28165 configuration.
28166
28167 .cindex "&%message%& ACL modifier" "with &%accept%&"
28168 If a &%message%& modifier appears on an &%accept%& statement, its action
28169 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28170 (when an &%accept%& verb either accepts or passes control to the next
28171 statement), &%message%& can be used to vary the message that is sent when an
28172 SMTP command is accepted. For example, in a RCPT ACL you could have:
28173 .display
28174 &`accept  `&<&'some conditions'&>
28175 &`        message = OK, I will allow you through today`&
28176 .endd
28177 You can specify an SMTP response code, optionally followed by an &"extended
28178 response code"& at the start of the message, but the first digit must be the
28179 same as would be sent by default, which is 2 for an &%accept%& verb.
28180
28181 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28182 an error message that is used when access is denied. This behaviour is retained
28183 for backward compatibility, but current &"best practice"& is to avoid the use
28184 of &%endpass%&.
28185
28186
28187 .next
28188 .cindex "&%defer%& ACL verb"
28189 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28190 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28191 &%defer%& is the same as &%deny%&, because there is no way of sending a
28192 temporary error. For a RCPT command, &%defer%& is much the same as using a
28193 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28194 be used in any ACL, and even for a recipient it might be a simpler approach.
28195
28196
28197 .next
28198 .cindex "&%deny%& ACL verb"
28199 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28200 the conditions are not met, control is passed to the next ACL statement. For
28201 example,
28202 .code
28203 deny dnslists = blackholes.mail-abuse.org
28204 .endd
28205 rejects commands from hosts that are on a DNS black list.
28206
28207
28208 .next
28209 .cindex "&%discard%& ACL verb"
28210 &%discard%&: This verb behaves like &%accept%&, except that it returns
28211 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28212 that are concerned with receiving messages. When all the conditions are true,
28213 the sending entity receives a &"success"& response. However, &%discard%& causes
28214 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28215 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28216 message's recipients are discarded. Recipients that are discarded before DATA
28217 do not appear in the log line when the &%received_recipients%& log selector is set.
28218
28219 If the &%log_message%& modifier is set when &%discard%& operates,
28220 its contents are added to the line that is automatically written to the log.
28221 The &%message%& modifier operates exactly as it does for &%accept%&.
28222
28223
28224 .next
28225 .cindex "&%drop%& ACL verb"
28226 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28227 forcibly closed after the 5&'xx'& error message has been sent. For example:
28228 .code
28229 drop   message   = I don't take more than 20 RCPTs
28230        condition = ${if > {$rcpt_count}{20}}
28231 .endd
28232 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28233 The connection is always dropped after sending a 550 response.
28234
28235 .next
28236 .cindex "&%require%& ACL verb"
28237 &%require%&: If all the conditions are met, control is passed to the next ACL
28238 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28239 example, when checking a RCPT command,
28240 .code
28241 require message = Sender did not verify
28242         verify  = sender
28243 .endd
28244 passes control to subsequent statements only if the message's sender can be
28245 verified. Otherwise, it rejects the command. Note the positioning of the
28246 &%message%& modifier, before the &%verify%& condition. The reason for this is
28247 discussed in section &<<SECTcondmodproc>>&.
28248
28249 .next
28250 .cindex "&%warn%& ACL verb"
28251 &%warn%&: If all the conditions are true, a line specified by the
28252 &%log_message%& modifier is written to Exim's main log. Control always passes
28253 to the next ACL statement. If any condition is false, the log line is not
28254 written. If an identical log line is requested several times in the same
28255 message, only one copy is actually written to the log. If you want to force
28256 duplicates to be written, use the &%logwrite%& modifier instead.
28257
28258 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28259 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28260 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28261 first failing condition. There is more about adding header lines in section
28262 &<<SECTaddheadacl>>&.
28263
28264 If any condition on a &%warn%& statement cannot be completed (that is, there is
28265 some sort of defer), the log line specified by &%log_message%& is not written.
28266 This does not include the case of a forced failure from a lookup, which
28267 is considered to be a successful completion. After a defer, no further
28268 conditions or modifiers in the &%warn%& statement are processed. The incident
28269 is logged, and the ACL continues to be processed, from the next statement
28270 onwards.
28271
28272
28273 .vindex "&$acl_verify_message$&"
28274 When one of the &%warn%& conditions is an address verification that fails, the
28275 text of the verification failure message is in &$acl_verify_message$&. If you
28276 want this logged, you must set it up explicitly. For example:
28277 .code
28278 warn   !verify = sender
28279        log_message = sender verify failed: $acl_verify_message
28280 .endd
28281 .endlist
28282
28283 At the end of each ACL there is an implicit unconditional &%deny%&.
28284
28285 As you can see from the examples above, the conditions and modifiers are
28286 written one to a line, with the first one on the same line as the verb, and
28287 subsequent ones on following lines. If you have a very long condition, you can
28288 continue it onto several physical lines by the usual backslash continuation
28289 mechanism. It is conventional to align the conditions vertically.
28290
28291
28292
28293 .section "ACL variables" "SECTaclvariables"
28294 .cindex "&ACL;" "variables"
28295 There are some special variables that can be set during ACL processing. They
28296 can be used to pass information between different ACLs, different invocations
28297 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28298 transports, and filters that are used to deliver a message. The names of these
28299 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28300 an underscore, but the remainder of the name can be any sequence of
28301 alphanumeric characters and underscores that you choose. There is no limit on
28302 the number of ACL variables. The two sets act as follows:
28303 .ilist
28304 The values of those variables whose names begin with &$acl_c$& persist
28305 throughout an SMTP connection. They are never reset. Thus, a value that is set
28306 while receiving one message is still available when receiving the next message
28307 on the same SMTP connection.
28308 .next
28309 The values of those variables whose names begin with &$acl_m$& persist only
28310 while a message is being received. They are reset afterwards. They are also
28311 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28312 .endlist
28313
28314 When a message is accepted, the current values of all the ACL variables are
28315 preserved with the message and are subsequently made available at delivery
28316 time. The ACL variables are set by a modifier called &%set%&. For example:
28317 .code
28318 accept hosts = whatever
28319        set acl_m4 = some value
28320 accept authenticated = *
28321        set acl_c_auth = yes
28322 .endd
28323 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28324 be set. If you want to set a variable without taking any action, you can use a
28325 &%warn%& verb without any other modifiers or conditions.
28326
28327 .oindex &%strict_acl_vars%&
28328 What happens if a syntactically valid but undefined ACL variable is
28329 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28330 false (the default), an empty string is substituted; if it is true, an
28331 error is generated.
28332
28333 Versions of Exim before 4.64 have a limited set of numbered variables, but
28334 their names are compatible, so there is no problem with upgrading.
28335
28336
28337 .section "Condition and modifier processing" "SECTcondmodproc"
28338 .cindex "&ACL;" "conditions; processing"
28339 .cindex "&ACL;" "modifiers; processing"
28340 An exclamation mark preceding a condition negates its result. For example:
28341 .code
28342 deny   domains = *.dom.example
28343       !verify  = recipient
28344 .endd
28345 causes the ACL to return &"deny"& if the recipient domain ends in
28346 &'dom.example'& and the recipient address cannot be verified. Sometimes
28347 negation can be used on the right-hand side of a condition. For example, these
28348 two statements are equivalent:
28349 .code
28350 deny  hosts = !192.168.3.4
28351 deny !hosts =  192.168.3.4
28352 .endd
28353 However, for many conditions (&%verify%& being a good example), only left-hand
28354 side negation of the whole condition is possible.
28355
28356 The arguments of conditions and modifiers are expanded. A forced failure
28357 of an expansion causes a condition to be ignored, that is, it behaves as if the
28358 condition is true. Consider these two statements:
28359 .code
28360 accept  senders = ${lookup{$host_name}lsearch\
28361                   {/some/file}{$value}fail}
28362 accept  senders = ${lookup{$host_name}lsearch\
28363                   {/some/file}{$value}{}}
28364 .endd
28365 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28366 the returned list is searched, but if the lookup fails the behaviour is
28367 different in the two cases. The &%fail%& in the first statement causes the
28368 condition to be ignored, leaving no further conditions. The &%accept%& verb
28369 therefore succeeds. The second statement, however, generates an empty list when
28370 the lookup fails. No sender can match an empty list, so the condition fails,
28371 and therefore the &%accept%& also fails.
28372
28373 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28374 specify actions that are taken as the conditions for a statement are checked;
28375 others specify text for messages that are used when access is denied or a
28376 warning is generated. The &%control%& modifier affects the way an incoming
28377 message is handled.
28378
28379 The positioning of the modifiers in an ACL statement is important, because the
28380 processing of a verb ceases as soon as its outcome is known. Only those
28381 modifiers that have already been encountered will take effect. For example,
28382 consider this use of the &%message%& modifier:
28383 .code
28384 require message = Can't verify sender
28385         verify  = sender
28386         message = Can't verify recipient
28387         verify  = recipient
28388         message = This message cannot be used
28389 .endd
28390 If sender verification fails, Exim knows that the result of the statement is
28391 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28392 so its text is used as the error message. If sender verification succeeds, but
28393 recipient verification fails, the second message is used. If recipient
28394 verification succeeds, the third message becomes &"current"&, but is never used
28395 because there are no more conditions to cause failure.
28396
28397 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28398 modifier that is used, because all the conditions must be true for rejection to
28399 happen. Specifying more than one &%message%& modifier does not make sense, and
28400 the message can even be specified after all the conditions. For example:
28401 .code
28402 deny   hosts = ...
28403       !senders = *@my.domain.example
28404        message = Invalid sender from client host
28405 .endd
28406 The &"deny"& result does not happen until the end of the statement is reached,
28407 by which time Exim has set up the message.
28408
28409
28410
28411 .section "ACL modifiers" "SECTACLmodi"
28412 .cindex "&ACL;" "modifiers; list of"
28413 The ACL modifiers are as follows:
28414
28415 .vlist
28416 .vitem &*add_header*&&~=&~<&'text'&>
28417 This modifier specifies one or more header lines that are to be added to an
28418 incoming message, assuming, of course, that the message is ultimately
28419 accepted. For details, see section &<<SECTaddheadacl>>&.
28420
28421 .vitem &*continue*&&~=&~<&'text'&>
28422 .cindex "&%continue%& ACL modifier"
28423 .cindex "database" "updating in ACL"
28424 This modifier does nothing of itself, and processing of the ACL always
28425 continues with the next condition or modifier. The value of &%continue%& is in
28426 the side effects of expanding its argument. Typically this could be used to
28427 update a database. It is really just a syntactic tidiness, to avoid having to
28428 write rather ugly lines like this:
28429 .display
28430 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28431 .endd
28432 Instead, all you need is
28433 .display
28434 &`continue = `&<&'some expansion'&>
28435 .endd
28436
28437 .vitem &*control*&&~=&~<&'text'&>
28438 .cindex "&%control%& ACL modifier"
28439 This modifier affects the subsequent processing of the SMTP connection or of an
28440 incoming message that is accepted. The effect of the first type of control
28441 lasts for the duration of the connection, whereas the effect of the second type
28442 lasts only until the current message has been received. The message-specific
28443 controls always apply to the whole message, not to individual recipients,
28444 even if the &%control%& modifier appears in a RCPT ACL.
28445
28446 As there are now quite a few controls that can be applied, they are described
28447 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28448 in several different ways. For example:
28449
28450 . ==== As this is a nested list, any displays it contains must be indented
28451 . ==== as otherwise they are too far to the left. That comment applies only
28452 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28453 . ==== way.
28454
28455 .ilist
28456 It can be at the end of an &%accept%& statement:
28457 .code
28458     accept  ...some conditions
28459             control = queue_only
28460 .endd
28461 In this case, the control is applied when this statement yields &"accept"&, in
28462 other words, when the conditions are all true.
28463
28464 .next
28465 It can be in the middle of an &%accept%& statement:
28466 .code
28467     accept  ...some conditions...
28468             control = queue_only
28469             ...some more conditions...
28470 .endd
28471 If the first set of conditions are true, the control is applied, even if the
28472 statement does not accept because one of the second set of conditions is false.
28473 In this case, some subsequent statement must yield &"accept"& for the control
28474 to be relevant.
28475
28476 .next
28477 It can be used with &%warn%& to apply the control, leaving the
28478 decision about accepting or denying to a subsequent verb. For
28479 example:
28480 .code
28481     warn    ...some conditions...
28482             control = freeze
28483     accept  ...
28484 .endd
28485 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28486 &%logwrite%&, so it does not add anything to the message and does not write a
28487 log entry.
28488
28489 .next
28490 If you want to apply a control unconditionally, you can use it with a
28491 &%require%& verb. For example:
28492 .code
28493     require  control = no_multiline_responses
28494 .endd
28495 .endlist
28496
28497 .vitem &*delay*&&~=&~<&'time'&>
28498 .cindex "&%delay%& ACL modifier"
28499 .oindex "&%-bh%&"
28500 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28501 the time interval before proceeding. However, when testing Exim using the
28502 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28503 output instead). The time is given in the usual Exim notation, and the delay
28504 happens as soon as the modifier is processed. In an SMTP session, pending
28505 output is flushed before the delay is imposed.
28506
28507 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28508 example:
28509 .code
28510 deny    ...some conditions...
28511         delay = 30s
28512 .endd
28513 The delay happens if all the conditions are true, before the statement returns
28514 &"deny"&. Compare this with:
28515 .code
28516 deny    delay = 30s
28517         ...some conditions...
28518 .endd
28519 which waits for 30s before processing the conditions. The &%delay%& modifier
28520 can also be used with &%warn%& and together with &%control%&:
28521 .code
28522 warn    ...some conditions...
28523         delay = 2m
28524         control = freeze
28525 accept  ...
28526 .endd
28527
28528 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28529 responses to several commands are no longer buffered and sent in one packet (as
28530 they would normally be) because all output is flushed before imposing the
28531 delay. This optimization is disabled so that a number of small delays do not
28532 appear to the client as one large aggregated delay that might provoke an
28533 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28534 using a &%control%& modifier to set &%no_delay_flush%&.
28535
28536
28537 .vitem &*endpass*&
28538 .cindex "&%endpass%& ACL modifier"
28539 This modifier, which has no argument, is recognized only in &%accept%& and
28540 &%discard%& statements. It marks the boundary between the conditions whose
28541 failure causes control to pass to the next statement, and the conditions whose
28542 failure causes the ACL to return &"deny"&. This concept has proved to be
28543 confusing to some people, so the use of &%endpass%& is no longer recommended as
28544 &"best practice"&. See the description of &%accept%& above for more details.
28545
28546
28547 .vitem &*log_message*&&~=&~<&'text'&>
28548 .cindex "&%log_message%& ACL modifier"
28549 This modifier sets up a message that is used as part of the log message if the
28550 ACL denies access or a &%warn%& statement's conditions are true. For example:
28551 .code
28552 require log_message = wrong cipher suite $tls_in_cipher
28553         encrypted   = DES-CBC3-SHA
28554 .endd
28555 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28556 example:
28557 .display
28558 &`discard `&<&'some conditions'&>
28559 &`        log_message = Discarded $local_part@$domain because...`&
28560 .endd
28561 When access is denied, &%log_message%& adds to any underlying error message
28562 that may exist because of a condition failure. For example, while verifying a
28563 recipient address, a &':fail:'& redirection might have already set up a
28564 message.
28565
28566 The message may be defined before the conditions to which it applies, because
28567 the string expansion does not happen until Exim decides that access is to be
28568 denied. This means that any variables that are set by the condition are
28569 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28570 variables are set after a DNS black list lookup succeeds. If the expansion of
28571 &%log_message%& fails, or if the result is an empty string, the modifier is
28572 ignored.
28573
28574 .vindex "&$acl_verify_message$&"
28575 If you want to use a &%warn%& statement to log the result of an address
28576 verification, you can use &$acl_verify_message$& to include the verification
28577 error message.
28578
28579 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28580 the start of the logged message. If the same warning log message is requested
28581 more than once while receiving  a single email message, only one copy is
28582 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28583 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28584 is logged for a successful &%warn%& statement.
28585
28586 If &%log_message%& is not present and there is no underlying error message (for
28587 example, from the failure of address verification), but &%message%& is present,
28588 the &%message%& text is used for logging rejections. However, if any text for
28589 logging contains newlines, only the first line is logged. In the absence of
28590 both &%log_message%& and &%message%&, a default built-in message is used for
28591 logging rejections.
28592
28593
28594 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28595 .cindex "&%log_reject_target%& ACL modifier"
28596 .cindex "logging in ACL" "specifying which log"
28597 This modifier makes it possible to specify which logs are used for messages
28598 about ACL rejections. Its argument is a colon-separated list of words that can
28599 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28600 may be empty, in which case a rejection is not logged at all. For example, this
28601 ACL fragment writes no logging information when access is denied:
28602 .display
28603 &`deny `&<&'some conditions'&>
28604 &`     log_reject_target =`&
28605 .endd
28606 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28607 permanent and temporary rejections. Its effect lasts for the rest of the
28608 current ACL.
28609
28610
28611 .vitem &*logwrite*&&~=&~<&'text'&>
28612 .cindex "&%logwrite%& ACL modifier"
28613 .cindex "logging in ACL" "immediate"
28614 This modifier writes a message to a log file as soon as it is encountered when
28615 processing an ACL. (Compare &%log_message%&, which, except in the case of
28616 &%warn%& and &%discard%&, is used only if the ACL statement denies
28617 access.) The &%logwrite%& modifier can be used to log special incidents in
28618 ACLs. For example:
28619 .display
28620 &`accept `&<&'some special conditions'&>
28621 &`       control  = freeze`&
28622 &`       logwrite = froze message because ...`&
28623 .endd
28624 By default, the message is written to the main log. However, it may begin
28625 with a colon, followed by a comma-separated list of log names, and then
28626 another colon, to specify exactly which logs are to be written. For
28627 example:
28628 .code
28629 logwrite = :main,reject: text for main and reject logs
28630 logwrite = :panic: text for panic log only
28631 .endd
28632
28633
28634 .vitem &*message*&&~=&~<&'text'&>
28635 .cindex "&%message%& ACL modifier"
28636 This modifier sets up a text string that is expanded and used as a response
28637 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28638 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28639 there is some complication if &%endpass%& is involved; see the description of
28640 &%accept%& for details.)
28641
28642 The expansion of the message happens at the time Exim decides that the ACL is
28643 to end, not at the time it processes &%message%&. If the expansion fails, or
28644 generates an empty string, the modifier is ignored. Here is an example where
28645 &%message%& must be specified first, because the ACL ends with a rejection if
28646 the &%hosts%& condition fails:
28647 .code
28648 require  message = Host not recognized
28649          hosts = 10.0.0.0/8
28650 .endd
28651 (Once a condition has failed, no further conditions or modifiers are
28652 processed.)
28653
28654 .cindex "SMTP" "error codes"
28655 .oindex "&%smtp_banner%&
28656 For ACLs that are triggered by SMTP commands, the message is returned as part
28657 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28658 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28659 is accepted. In the case of the connect ACL, accepting with a message modifier
28660 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28661 accept message may not contain more than one line (otherwise it will be
28662 truncated at the first newline and a panic logged), and it cannot affect the
28663 EHLO options.
28664
28665 When SMTP is involved, the message may begin with an overriding response code,
28666 consisting of three digits optionally followed by an &"extended response code"&
28667 of the form &'n.n.n'&, each code being followed by a space. For example:
28668 .code
28669 deny  message = 599 1.2.3 Host not welcome
28670       hosts = 192.168.34.0/24
28671 .endd
28672 The first digit of the supplied response code must be the same as would be sent
28673 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28674 access, but for the predata ACL, note that the default success code is 354, not
28675 2&'xx'&.
28676
28677 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28678 the message modifier cannot override the 221 response code.
28679
28680 The text in a &%message%& modifier is literal; any quotes are taken as
28681 literals, but because the string is expanded, backslash escapes are processed
28682 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28683 response.
28684
28685 .vindex "&$acl_verify_message$&"
28686 For ACLs that are called by an &%acl =%& ACL condition, the message is
28687 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28688
28689 If &%message%& is used on a statement that verifies an address, the message
28690 specified overrides any message that is generated by the verification process.
28691 However, the original message is available in the variable
28692 &$acl_verify_message$&, so you can incorporate it into your message if you
28693 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28694 routers to be passed back as part of the SMTP response, you should either not
28695 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28696
28697 For compatibility with previous releases of Exim, a &%message%& modifier that
28698 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28699 modifier, but this usage is now deprecated. However, &%message%& acts only when
28700 all the conditions are true, wherever it appears in an ACL command, whereas
28701 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28702 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28703 effect.
28704
28705
28706 .new
28707 .vitem &*queue*&&~=&~<&'text'&>
28708 This modifier specifies the use of a named queue for spool files
28709 for the message.
28710 It can only be used before the message is received (i.e. not in
28711 the DATA ACL).
28712 This could be used, for example, for known high-volume burst sources
28713 of traffic, or for quarantine of messages.
28714 Separate queue-runner processes will be needed for named queues.
28715 If the text after expansion is empty, the default queue is used.
28716 .wen
28717
28718
28719 .vitem &*remove_header*&&~=&~<&'text'&>
28720 This modifier specifies one or more header names in a colon-separated list
28721  that are to be removed from an incoming message, assuming, of course, that
28722 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28723
28724
28725 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28726 .cindex "&%set%& ACL modifier"
28727 This modifier puts a value into one of the ACL variables (see section
28728 &<<SECTaclvariables>>&).
28729
28730
28731 .vitem &*udpsend*&&~=&~<&'parameters'&>
28732 This modifier sends a UDP packet, for purposes such as statistics
28733 collection or behaviour monitoring. The parameters are expanded, and
28734 the result of the expansion must be a colon-separated list consisting
28735 of a destination server, port number, and the packet contents. The
28736 server can be specified as a host name or IPv4 or IPv6 address. The
28737 separator can be changed with the usual angle bracket syntax. For
28738 example, you might want to collect information on which hosts connect
28739 when:
28740 .code
28741 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28742              $tod_zulu $sender_host_address
28743 .endd
28744 .endlist
28745
28746
28747
28748
28749 .section "Use of the control modifier" "SECTcontrols"
28750 .cindex "&%control%& ACL modifier"
28751 The &%control%& modifier supports the following settings:
28752
28753 .vlist
28754 .vitem &*control&~=&~allow_auth_unadvertised*&
28755 This modifier allows a client host to use the SMTP AUTH command even when it
28756 has not been advertised in response to EHLO. Furthermore, because there are
28757 apparently some really broken clients that do this, Exim will accept AUTH after
28758 HELO (rather than EHLO) when this control is set. It should be used only if you
28759 really need it, and you should limit its use to those broken clients that do
28760 not work without it. For example:
28761 .code
28762 warn hosts   = 192.168.34.25
28763      control = allow_auth_unadvertised
28764 .endd
28765 Normally, when an Exim server receives an AUTH command, it checks the name of
28766 the authentication mechanism that is given in the command to ensure that it
28767 matches an advertised mechanism. When this control is set, the check that a
28768 mechanism has been advertised is bypassed. Any configured mechanism can be used
28769 by the client. This control is permitted only in the connection and HELO ACLs.
28770
28771
28772 .vitem &*control&~=&~caseful_local_part*& &&&
28773        &*control&~=&~caselower_local_part*&
28774 .cindex "&ACL;" "case of local part in"
28775 .cindex "case of local parts"
28776 .vindex "&$local_part$&"
28777 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28778 (that is, during RCPT processing). By default, the contents of &$local_part$&
28779 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28780 any uppercase letters in the original local part are restored in &$local_part$&
28781 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28782 is encountered.
28783
28784 These controls affect only the current recipient. Moreover, they apply only to
28785 local part handling that takes place directly in the ACL (for example, as a key
28786 in lookups). If a test to verify the recipient is obeyed, the case-related
28787 handling of the local part during the verification is controlled by the router
28788 configuration (see the &%caseful_local_part%& generic router option).
28789
28790 This facility could be used, for example, to add a spam score to local parts
28791 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28792 spam score:
28793 .code
28794 warn  control = caseful_local_part
28795       set acl_m4 = ${eval:\
28796                      $acl_m4 + \
28797                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28798                     }
28799       control = caselower_local_part
28800 .endd
28801 Notice that we put back the lower cased version afterwards, assuming that
28802 is what is wanted for subsequent tests.
28803
28804
28805 .vitem &*control&~=&~cutthrough_delivery*&
28806 .cindex "&ACL;" "cutthrough routing"
28807 .cindex "cutthrough" "requesting"
28808 This option requests delivery be attempted while the item is being received.
28809
28810 The option is usable in the RCPT ACL.
28811 If enabled for a message received via smtp and routed to an smtp transport,
28812 and only one transport, interface, destination host and port combination
28813 is used for all recipients of the message,
28814 then the delivery connection is made while the receiving connection is open
28815 and data is copied from one to the other.
28816
28817 An attempt to set this option for any recipient but the first
28818 for a mail will be quietly ignored.
28819 If a recipient-verify callout
28820 (with use_sender)
28821 connection is subsequently
28822 requested in the same ACL it is held open and used for
28823 any subsequent recipients and the data,
28824 otherwise one is made after the initial RCPT ACL completes.
28825
28826 Note that routers are used in verify mode,
28827 and cannot depend on content of received headers.
28828 Note also that headers cannot be
28829 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28830 Headers may be modified by routers (subject to the above) and transports.
28831
28832 All the usual ACLs are called; if one results in the message being
28833 rejected, all effort spent in delivery (including the costs on
28834 the ultimate destination) will be wasted.
28835 Note that in the case of data-time ACLs this includes the entire
28836 message body.
28837
28838 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28839 of outgoing messages is done, because it sends data to the ultimate destination
28840 before the entire message has been received from the source.
28841 It is not supported for messages received with the SMTP PRDR option in use.
28842
28843 Should the ultimate destination system positively accept or reject the mail,
28844 a corresponding indication is given to the source system and nothing is queued.
28845 If there is a temporary error the item is queued for later delivery in the
28846 usual fashion. If the item is successfully delivered in cutthrough mode
28847 the delivery log lines are tagged with ">>" rather than "=>" and appear
28848 before the acceptance "<=" line.
28849
28850 Delivery in this mode avoids the generation of a bounce mail to a
28851 (possibly faked)
28852 sender when the destination system is doing content-scan based rejection.
28853
28854
28855 .vitem &*control&~=&~debug/*&<&'options'&>
28856 .cindex "&ACL;" "enabling debug logging"
28857 .cindex "debugging" "enabling from an ACL"
28858 This control turns on debug logging, almost as though Exim had been invoked
28859 with &`-d`&, with the output going to a new logfile, by default called
28860 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28861 may access any variables already defined.  The logging may be adjusted with
28862 the &'opts'& option, which takes the same values as the &`-d`& command-line
28863 option.
28864 .new
28865 Logging may be stopped, and the file removed, with the &'kill'& option.
28866 .wen
28867 Some examples (which depend on variables that don't exist in all
28868 contexts):
28869 .code
28870       control = debug
28871       control = debug/tag=.$sender_host_address
28872       control = debug/opts=+expand+acl
28873       control = debug/tag=.$message_exim_id/opts=+expand
28874       control = debug/kill
28875 .endd
28876
28877
28878 .vitem &*control&~=&~dkim_disable_verify*&
28879 .cindex "disable DKIM verify"
28880 .cindex "DKIM" "disable verify"
28881 This control turns off DKIM verification processing entirely.  For details on
28882 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28883
28884
28885 .vitem &*control&~=&~dscp/*&<&'value'&>
28886 .cindex "&ACL;" "setting DSCP value"
28887 .cindex "DSCP" "inbound"
28888 This option causes the DSCP value associated with the socket for the inbound
28889 connection to be adjusted to a given value, given as one of a number of fixed
28890 strings or to numeric value.
28891 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28892 Common values include &`throughput`&, &`mincost`&, and on newer systems
28893 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28894
28895 The outbound packets from Exim will be marked with this value in the header
28896 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28897 that these values will have any effect, not be stripped by networking
28898 equipment, or do much of anything without cooperation with your Network
28899 Engineer and those of all network operators between the source and destination.
28900
28901
28902 .vitem &*control&~=&~enforce_sync*& &&&
28903        &*control&~=&~no_enforce_sync*&
28904 .cindex "SMTP" "synchronization checking"
28905 .cindex "synchronization checking in SMTP"
28906 These controls make it possible to be selective about when SMTP synchronization
28907 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28908 state of the switch (it is true by default). See the description of this option
28909 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28910
28911 The effect of these two controls lasts for the remainder of the SMTP
28912 connection. They can appear in any ACL except the one for the non-SMTP
28913 messages. The most straightforward place to put them is in the ACL defined by
28914 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28915 before the first synchronization check. The expected use is to turn off the
28916 synchronization checks for badly-behaved hosts that you nevertheless need to
28917 work with.
28918
28919
28920 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28921 .cindex "fake defer"
28922 .cindex "defer, fake"
28923 This control works in exactly the same way as &%fakereject%& (described below)
28924 except that it causes an SMTP 450 response after the message data instead of a
28925 550 response. You must take care when using &%fakedefer%& because it causes the
28926 messages to be duplicated when the sender retries. Therefore, you should not
28927 use &%fakedefer%& if the message is to be delivered normally.
28928
28929 .vitem &*control&~=&~fakereject/*&<&'message'&>
28930 .cindex "fake rejection"
28931 .cindex "rejection, fake"
28932 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28933 words, only when an SMTP message is being received. If Exim accepts the
28934 message, instead the final 250 response, a 550 rejection message is sent.
28935 However, Exim proceeds to deliver the message as normal. The control applies
28936 only to the current message, not to any subsequent ones that may be received in
28937 the same SMTP connection.
28938
28939 The text for the 550 response is taken from the &%control%& modifier. If no
28940 message is supplied, the following is used:
28941 .code
28942 550-Your message has been rejected but is being
28943 550-kept for evaluation.
28944 550-If it was a legitimate message, it may still be
28945 550 delivered to the target recipient(s).
28946 .endd
28947 This facility should be used with extreme caution.
28948
28949 .vitem &*control&~=&~freeze*&
28950 .cindex "frozen messages" "forcing in ACL"
28951 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28952 other words, only when a message is being received. If the message is accepted,
28953 it is placed on Exim's queue and frozen. The control applies only to the
28954 current message, not to any subsequent ones that may be received in the same
28955 SMTP connection.
28956
28957 This modifier can optionally be followed by &`/no_tell`&. If the global option
28958 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28959 is told about the freezing), provided all the &*control=freeze*& modifiers that
28960 are obeyed for the current message have the &`/no_tell`& option.
28961
28962 .vitem &*control&~=&~no_delay_flush*&
28963 .cindex "SMTP" "output flushing, disabling for delay"
28964 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28965 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28966 use. This control, as long as it is encountered before the &%delay%& modifier,
28967 disables such output flushing.
28968
28969 .vitem &*control&~=&~no_callout_flush*&
28970 .cindex "SMTP" "output flushing, disabling for callout"
28971 Exim normally flushes SMTP output before performing a callout in an ACL, to
28972 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28973 use. This control, as long as it is encountered before the &%verify%& condition
28974 that causes the callout, disables such output flushing.
28975
28976 .vitem &*control&~=&~no_mbox_unspool*&
28977 This control is available when Exim is compiled with the content scanning
28978 extension. Content scanning may require a copy of the current message, or parts
28979 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28980 or spam scanner. Normally, such copies are deleted when they are no longer
28981 needed. If this control is set, the copies are not deleted. The control applies
28982 only to the current message, not to any subsequent ones that may be received in
28983 the same SMTP connection. It is provided for debugging purposes and is unlikely
28984 to be useful in production.
28985
28986 .vitem &*control&~=&~no_multiline_responses*&
28987 .cindex "multiline responses, suppressing"
28988 This control is permitted for any ACL except the one for non-SMTP messages.
28989 It seems that there are broken clients in use that cannot handle multiline
28990 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28991
28992 If this control is set, multiline SMTP responses from ACL rejections are
28993 suppressed. One way of doing this would have been to put out these responses as
28994 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28995 (&"use multiline responses for more"& it says &-- ha!), and some of the
28996 responses might get close to that. So this facility, which is after all only a
28997 sop to broken clients, is implemented by doing two very easy things:
28998
28999 .ilist
29000 Extra information that is normally output as part of a rejection caused by
29001 sender verification failure is omitted. Only the final line (typically &"sender
29002 verification failed"&) is sent.
29003 .next
29004 If a &%message%& modifier supplies a multiline response, only the first
29005 line is output.
29006 .endlist
29007
29008 The setting of the switch can, of course, be made conditional on the
29009 calling host. Its effect lasts until the end of the SMTP connection.
29010
29011 .vitem &*control&~=&~no_pipelining*&
29012 .cindex "PIPELINING" "suppressing advertising"
29013 This control turns off the advertising of the PIPELINING extension to SMTP in
29014 the current session. To be useful, it must be obeyed before Exim sends its
29015 response to an EHLO command. Therefore, it should normally appear in an ACL
29016 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29017 &%pipelining_advertise_hosts%&.
29018
29019 .vitem &*control&~=&~queue_only*&
29020 .oindex "&%queue_only%&"
29021 .cindex "queueing incoming messages"
29022 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29023 other words, only when a message is being received. If the message is accepted,
29024 it is placed on Exim's queue and left there for delivery by a subsequent queue
29025 runner. No immediate delivery process is started. In other words, it has the
29026 effect as the &%queue_only%& global option. However, the control applies only
29027 to the current message, not to any subsequent ones that may be received in the
29028 same SMTP connection.
29029
29030 .vitem &*control&~=&~submission/*&<&'options'&>
29031 .cindex "message" "submission"
29032 .cindex "submission mode"
29033 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29034 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29035 the current message is a submission from a local MUA. In this case, Exim
29036 operates in &"submission mode"&, and applies certain fixups to the message if
29037 necessary. For example, it adds a &'Date:'& header line if one is not present.
29038 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29039 late (the message has already been created).
29040
29041 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29042 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29043 submission mode; the available options for this control are described there.
29044 The control applies only to the current message, not to any subsequent ones
29045 that may be received in the same SMTP connection.
29046
29047 .vitem &*control&~=&~suppress_local_fixups*&
29048 .cindex "submission fixups, suppressing"
29049 This control applies to locally submitted (non TCP/IP) messages, and is the
29050 complement of &`control = submission`&. It disables the fixups that are
29051 normally applied to locally-submitted messages. Specifically:
29052
29053 .ilist
29054 Any &'Sender:'& header line is left alone (in this respect, it is a
29055 dynamic version of &%local_sender_retain%&).
29056 .next
29057 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29058 .next
29059 There is no check that &'From:'& corresponds to the actual sender.
29060 .endlist ilist
29061
29062 This control may be useful when a remotely-originated message is accepted,
29063 passed to some scanning program, and then re-submitted for delivery. It can be
29064 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29065 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29066 data is read.
29067
29068 &*Note:*& This control applies only to the current message, not to any others
29069 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29070
29071 .vitem &*control&~=&~utf8_downconvert*&
29072 This control enables conversion of UTF-8 in message addresses
29073 to a-label form.
29074 For details see &<<SECTi18nMTA>>&.
29075 .endlist vlist
29076
29077
29078 .section "Summary of message fixup control" "SECTsummesfix"
29079 All four possibilities for message fixups can be specified:
29080
29081 .ilist
29082 Locally submitted, fixups applied: the default.
29083 .next
29084 Locally submitted, no fixups applied: use
29085 &`control = suppress_local_fixups`&.
29086 .next
29087 Remotely submitted, no fixups applied: the default.
29088 .next
29089 Remotely submitted, fixups applied: use &`control = submission`&.
29090 .endlist
29091
29092
29093
29094 .section "Adding header lines in ACLs" "SECTaddheadacl"
29095 .cindex "header lines" "adding in an ACL"
29096 .cindex "header lines" "position of added lines"
29097 .cindex "&%add_header%& ACL modifier"
29098 The &%add_header%& modifier can be used to add one or more extra header lines
29099 to an incoming message, as in this example:
29100 .code
29101 warn dnslists = sbl.spamhaus.org : \
29102                 dialup.mail-abuse.org
29103      add_header = X-blacklisted-at: $dnslist_domain
29104 .endd
29105 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29106 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29107 receiving a message). The message must ultimately be accepted for
29108 &%add_header%& to have any significant effect. You can use &%add_header%& with
29109 any ACL verb, including &%deny%& (though this is potentially useful only in a
29110 RCPT ACL).
29111
29112 Headers will not be added to the message if the modifier is used in
29113 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29114
29115 Leading and trailing newlines are removed from
29116 the data for the &%add_header%& modifier; if it then
29117 contains one or more newlines that
29118 are not followed by a space or a tab, it is assumed to contain multiple header
29119 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29120 front of any line that is not a valid header line.
29121
29122 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29123 They are added to the message before processing the DATA and MIME ACLs.
29124 However, if an identical header line is requested more than once, only one copy
29125 is actually added to the message. Further header lines may be accumulated
29126 during the DATA and MIME ACLs, after which they are added to the message, again
29127 with duplicates suppressed. Thus, it is possible to add two identical header
29128 lines to an SMTP message, but only if one is added before DATA and one after.
29129 In the case of non-SMTP messages, new headers are accumulated during the
29130 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29131 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29132 are included in the entry that is written to the reject log.
29133
29134 .cindex "header lines" "added; visibility of"
29135 Header lines are not visible in string expansions
29136 of message headers
29137 until they are added to the
29138 message. It follows that header lines defined in the MAIL, RCPT, and predata
29139 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29140 header lines that are added by the DATA or MIME ACLs are not visible in those
29141 ACLs. Because of this restriction, you cannot use header lines as a way of
29142 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29143 this, you can use ACL variables, as described in section
29144 &<<SECTaclvariables>>&.
29145
29146 The list of headers yet to be added is given by the &%$headers_added%& variable.
29147
29148 The &%add_header%& modifier acts immediately as it is encountered during the
29149 processing of an ACL. Notice the difference between these two cases:
29150 .display
29151 &`accept add_header = ADDED: some text`&
29152 &`       `&<&'some condition'&>
29153
29154 &`accept `&<&'some condition'&>
29155 &`       add_header = ADDED: some text`&
29156 .endd
29157 In the first case, the header line is always added, whether or not the
29158 condition is true. In the second case, the header line is added only if the
29159 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29160 ACL statement. All those that are encountered before a condition fails are
29161 honoured.
29162
29163 .cindex "&%warn%& ACL verb"
29164 For compatibility with previous versions of Exim, a &%message%& modifier for a
29165 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29166 effect only if all the conditions are true, even if it appears before some of
29167 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29168 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29169 are present on a &%warn%& verb, both are processed according to their
29170 specifications.
29171
29172 By default, new header lines are added to a message at the end of the existing
29173 header lines. However, you can specify that any particular header line should
29174 be added right at the start (before all the &'Received:'& lines), immediately
29175 after the first block of &'Received:'& lines, or immediately before any line
29176 that is not a &'Received:'& or &'Resent-something:'& header.
29177
29178 This is done by specifying &":at_start:"&, &":after_received:"&, or
29179 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29180 header line, respectively. (Header text cannot start with a colon, as there has
29181 to be a header name first.) For example:
29182 .code
29183 warn add_header = \
29184        :after_received:X-My-Header: something or other...
29185 .endd
29186 If more than one header line is supplied in a single &%add_header%& modifier,
29187 each one is treated independently and can therefore be placed differently. If
29188 you add more than one line at the start, or after the Received: block, they end
29189 up in reverse order.
29190
29191 &*Warning*&: This facility currently applies only to header lines that are
29192 added in an ACL. It does NOT work for header lines that are added in a
29193 system filter or in a router or transport.
29194
29195
29196
29197 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29198 .cindex "header lines" "removing in an ACL"
29199 .cindex "header lines" "position of removed lines"
29200 .cindex "&%remove_header%& ACL modifier"
29201 The &%remove_header%& modifier can be used to remove one or more header lines
29202 from an incoming message, as in this example:
29203 .code
29204 warn   message        = Remove internal headers
29205        remove_header  = x-route-mail1 : x-route-mail2
29206 .endd
29207 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29208 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29209 receiving a message). The message must ultimately be accepted for
29210 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29211 with any ACL verb, including &%deny%&, though this is really not useful for
29212 any verb that doesn't result in a delivered message.
29213
29214 Headers will not be removed from the message if the modifier is used in
29215 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29216
29217 More than one header can be removed at the same time by using a colon separated
29218 list of header names. The header matching is case insensitive. Wildcards are
29219 not permitted, nor is list expansion performed, so you cannot use hostlists to
29220 create a list of headers, however both connection and message variable expansion
29221 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29222 .code
29223 warn   hosts           = +internal_hosts
29224        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29225 warn   message         = Remove internal headers
29226        remove_header   = $acl_c_ihdrs
29227 .endd
29228 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29229 They are removed from the message before processing the DATA and MIME ACLs.
29230 There is no harm in attempting to remove the same header twice nor is removing
29231 a non-existent header. Further header lines to be removed may be accumulated
29232 during the DATA and MIME ACLs, after which they are removed from the message,
29233 if present. In the case of non-SMTP messages, headers to be removed are
29234 accumulated during the non-SMTP ACLs, and are removed from the message after
29235 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29236 ACL, there really is no effect because there is no logging of what headers
29237 would have been removed.
29238
29239 .cindex "header lines" "removed; visibility of"
29240 Header lines are not visible in string expansions until the DATA phase when it
29241 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29242 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29243 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29244 this restriction, you cannot use header lines as a way of controlling data
29245 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29246 you should instead use ACL variables, as described in section
29247 &<<SECTaclvariables>>&.
29248
29249 The &%remove_header%& modifier acts immediately as it is encountered during the
29250 processing of an ACL. Notice the difference between these two cases:
29251 .display
29252 &`accept remove_header = X-Internal`&
29253 &`       `&<&'some condition'&>
29254
29255 &`accept `&<&'some condition'&>
29256 &`       remove_header = X-Internal`&
29257 .endd
29258 In the first case, the header line is always removed, whether or not the
29259 condition is true. In the second case, the header line is removed only if the
29260 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29261 same ACL statement. All those that are encountered before a condition fails
29262 are honoured.
29263
29264 &*Warning*&: This facility currently applies only to header lines that are
29265 present during ACL processing. It does NOT remove header lines that are added
29266 in a system filter or in a router or transport.
29267
29268
29269
29270
29271 .section "ACL conditions" "SECTaclconditions"
29272 .cindex "&ACL;" "conditions; list of"
29273 Some of the conditions listed in this section are available only when Exim is
29274 compiled with the content-scanning extension. They are included here briefly
29275 for completeness. More detailed descriptions can be found in the discussion on
29276 content scanning in chapter &<<CHAPexiscan>>&.
29277
29278 Not all conditions are relevant in all circumstances. For example, testing
29279 senders and recipients does not make sense in an ACL that is being run as the
29280 result of the arrival of an ETRN command, and checks on message headers can be
29281 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29282 can use the same condition (with different parameters) more than once in the
29283 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29284 The conditions are as follows:
29285
29286
29287 .vlist
29288 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29289 .cindex "&ACL;" "nested"
29290 .cindex "&ACL;" "indirect"
29291 .cindex "&ACL;" "arguments"
29292 .cindex "&%acl%& ACL condition"
29293 The possible values of the argument are the same as for the
29294 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29295 &"accept"& the condition is true; if it returns &"deny"& the condition is
29296 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29297 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29298 condition false. This means that further processing of the &%warn%& verb
29299 ceases, but processing of the ACL continues.
29300
29301 If the argument is a named ACL, up to nine space-separated optional values
29302 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29303 and $acl_narg is set to the count of values.
29304 Previous values of these variables are restored after the call returns.
29305 The name and values are expanded separately.
29306 Note that spaces in complex expansions which are used as arguments
29307 will act as argument separators.
29308
29309 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29310 the connection is dropped. If it returns &"discard"&, the verb must be
29311 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29312 conditions are tested.
29313
29314 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29315 loops. This condition allows you to use different ACLs in different
29316 circumstances. For example, different ACLs can be used to handle RCPT commands
29317 for different local users or different local domains.
29318
29319 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29320 .cindex "&%authenticated%& ACL condition"
29321 .cindex "authentication" "ACL checking"
29322 .cindex "&ACL;" "testing for authentication"
29323 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29324 the name of the authenticator is tested against the list. To test for
29325 authentication by any authenticator, you can set
29326 .code
29327 authenticated = *
29328 .endd
29329
29330 .vitem &*condition&~=&~*&<&'string'&>
29331 .cindex "&%condition%& ACL condition"
29332 .cindex "customizing" "ACL condition"
29333 .cindex "&ACL;" "customized test"
29334 .cindex "&ACL;" "testing, customized"
29335 This feature allows you to make up custom conditions. If the result of
29336 expanding the string is an empty string, the number zero, or one of the strings
29337 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29338 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29339 any other value, some error is assumed to have occurred, and the ACL returns
29340 &"defer"&. However, if the expansion is forced to fail, the condition is
29341 ignored. The effect is to treat it as true, whether it is positive or
29342 negative.
29343
29344 .vitem &*decode&~=&~*&<&'location'&>
29345 .cindex "&%decode%& ACL condition"
29346 This condition is available only when Exim is compiled with the
29347 content-scanning extension, and it is allowed only in the ACL defined by
29348 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29349 If all goes well, the condition is true. It is false only if there are
29350 problems such as a syntax error or a memory shortage. For more details, see
29351 chapter &<<CHAPexiscan>>&.
29352
29353 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29354 .cindex "&%dnslists%& ACL condition"
29355 .cindex "DNS list" "in ACL"
29356 .cindex "black list (DNS)"
29357 .cindex "&ACL;" "testing a DNS list"
29358 This condition checks for entries in DNS black lists. These are also known as
29359 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29360 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29361 different variants of this condition to describe briefly here. See sections
29362 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29363
29364 .vitem &*domains&~=&~*&<&'domain&~list'&>
29365 .cindex "&%domains%& ACL condition"
29366 .cindex "domain" "ACL checking"
29367 .cindex "&ACL;" "testing a recipient domain"
29368 .vindex "&$domain_data$&"
29369 This condition is relevant only after a RCPT command. It checks that the domain
29370 of the recipient address is in the domain list. If percent-hack processing is
29371 enabled, it is done before this test is done. If the check succeeds with a
29372 lookup, the result of the lookup is placed in &$domain_data$& until the next
29373 &%domains%& test.
29374
29375 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29376 use &%domains%& in a DATA ACL.
29377
29378
29379 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29380 .cindex "&%encrypted%& ACL condition"
29381 .cindex "encryption" "checking in an ACL"
29382 .cindex "&ACL;" "testing for encryption"
29383 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29384 name of the cipher suite in use is tested against the list. To test for
29385 encryption without testing for any specific cipher suite(s), set
29386 .code
29387 encrypted = *
29388 .endd
29389
29390
29391 .vitem &*hosts&~=&~*&<&'host&~list'&>
29392 .cindex "&%hosts%& ACL condition"
29393 .cindex "host" "ACL checking"
29394 .cindex "&ACL;" "testing the client host"
29395 This condition tests that the calling host matches the host list. If you have
29396 name lookups or wildcarded host names and IP addresses in the same host list,
29397 you should normally put the IP addresses first. For example, you could have:
29398 .code
29399 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29400 .endd
29401 The lookup in this example uses the host name for its key. This is implied by
29402 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29403 and it wouldn't matter which way round you had these two items.)
29404
29405 The reason for the problem with host names lies in the left-to-right way that
29406 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29407 but when it reaches an item that requires a host name, it fails if it cannot
29408 find a host name to compare with the pattern. If the above list is given in the
29409 opposite order, the &%accept%& statement fails for a host whose name cannot be
29410 found, even if its IP address is 10.9.8.7.
29411
29412 If you really do want to do the name check first, and still recognize the IP
29413 address even if the name lookup fails, you can rewrite the ACL like this:
29414 .code
29415 accept hosts = dbm;/etc/friendly/hosts
29416 accept hosts = 10.9.8.7
29417 .endd
29418 The default action on failing to find the host name is to assume that the host
29419 is not in the list, so the first &%accept%& statement fails. The second
29420 statement can then check the IP address.
29421
29422 .vindex "&$host_data$&"
29423 If a &%hosts%& condition is satisfied by means of a lookup, the result
29424 of the lookup is made available in the &$host_data$& variable. This
29425 allows you, for example, to set up a statement like this:
29426 .code
29427 deny  hosts = net-lsearch;/some/file
29428 message = $host_data
29429 .endd
29430 which gives a custom error message for each denied host.
29431
29432 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29433 .cindex "&%local_parts%& ACL condition"
29434 .cindex "local part" "ACL checking"
29435 .cindex "&ACL;" "testing a local part"
29436 .vindex "&$local_part_data$&"
29437 This condition is relevant only after a RCPT command. It checks that the local
29438 part of the recipient address is in the list. If percent-hack processing is
29439 enabled, it is done before this test. If the check succeeds with a lookup, the
29440 result of the lookup is placed in &$local_part_data$&, which remains set until
29441 the next &%local_parts%& test.
29442
29443 .vitem &*malware&~=&~*&<&'option'&>
29444 .cindex "&%malware%& ACL condition"
29445 .cindex "&ACL;" "virus scanning"
29446 .cindex "&ACL;" "scanning for viruses"
29447 This condition is available only when Exim is compiled with the
29448 content-scanning extension. It causes the incoming message to be scanned for
29449 viruses. For details, see chapter &<<CHAPexiscan>>&.
29450
29451 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29452 .cindex "&%mime_regex%& ACL condition"
29453 .cindex "&ACL;" "testing by regex matching"
29454 This condition is available only when Exim is compiled with the
29455 content-scanning extension, and it is allowed only in the ACL defined by
29456 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29457 with any of the regular expressions. For details, see chapter
29458 &<<CHAPexiscan>>&.
29459
29460 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29461 .cindex "rate limiting"
29462 This condition can be used to limit the rate at which a user or host submits
29463 messages. Details are given in section &<<SECTratelimiting>>&.
29464
29465 .vitem &*recipients&~=&~*&<&'address&~list'&>
29466 .cindex "&%recipients%& ACL condition"
29467 .cindex "recipient" "ACL checking"
29468 .cindex "&ACL;" "testing a recipient"
29469 This condition is relevant only after a RCPT command. It checks the entire
29470 recipient address against a list of recipients.
29471
29472 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29473 .cindex "&%regex%& ACL condition"
29474 .cindex "&ACL;" "testing by regex matching"
29475 This condition is available only when Exim is compiled with the
29476 content-scanning extension, and is available only in the DATA, MIME, and
29477 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29478 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29479
29480 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29481 .cindex "&%sender_domains%& ACL condition"
29482 .cindex "sender" "ACL checking"
29483 .cindex "&ACL;" "testing a sender domain"
29484 .vindex "&$domain$&"
29485 .vindex "&$sender_address_domain$&"
29486 This condition tests the domain of the sender of the message against the given
29487 domain list. &*Note*&: The domain of the sender address is in
29488 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29489 of this condition. This is an exception to the general rule for testing domain
29490 lists. It is done this way so that, if this condition is used in an ACL for a
29491 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29492 influence the sender checking.
29493
29494 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29495 relaying, because sender addresses are easily, and commonly, forged.
29496
29497 .vitem &*senders&~=&~*&<&'address&~list'&>
29498 .cindex "&%senders%& ACL condition"
29499 .cindex "sender" "ACL checking"
29500 .cindex "&ACL;" "testing a sender"
29501 This condition tests the sender of the message against the given list. To test
29502 for a bounce message, which has an empty sender, set
29503 .code
29504 senders = :
29505 .endd
29506 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29507 relaying, because sender addresses are easily, and commonly, forged.
29508
29509 .vitem &*spam&~=&~*&<&'username'&>
29510 .cindex "&%spam%& ACL condition"
29511 .cindex "&ACL;" "scanning for spam"
29512 This condition is available only when Exim is compiled with the
29513 content-scanning extension. It causes the incoming message to be scanned by
29514 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29515
29516 .vitem &*verify&~=&~certificate*&
29517 .cindex "&%verify%& ACL condition"
29518 .cindex "TLS" "client certificate verification"
29519 .cindex "certificate" "verification of client"
29520 .cindex "&ACL;" "certificate verification"
29521 .cindex "&ACL;" "testing a TLS certificate"
29522 This condition is true in an SMTP session if the session is encrypted, and a
29523 certificate was received from the client, and the certificate was verified. The
29524 server requests a certificate only if the client matches &%tls_verify_hosts%&
29525 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29526
29527 .vitem &*verify&~=&~csa*&
29528 .cindex "CSA verification"
29529 This condition checks whether the sending host (the client) is authorized to
29530 send email. Details of how this works are given in section
29531 &<<SECTverifyCSA>>&.
29532
29533 .vitem &*verify&~=&~header_names_ascii*&
29534 .cindex "&%verify%& ACL condition"
29535 .cindex "&ACL;" "verifying header names only ASCII"
29536 .cindex "header lines" "verifying header names only ASCII"
29537 .cindex "verifying" "header names only ASCII"
29538 This condition is relevant only in an ACL that is run after a message has been
29539 received, that is, in an ACL specified by &%acl_smtp_data%& or
29540 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29541 there are no non-ASCII characters, also excluding control characters.  The
29542 allowable characters are decimal ASCII values 33 through 126.
29543
29544 Exim itself will handle headers with non-ASCII characters, but it can cause
29545 problems for downstream applications, so this option will allow their
29546 detection and rejection in the DATA ACL's.
29547
29548 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29549 .cindex "&%verify%& ACL condition"
29550 .cindex "&ACL;" "verifying sender in the header"
29551 .cindex "header lines" "verifying the sender in"
29552 .cindex "sender" "verifying in header"
29553 .cindex "verifying" "sender in header"
29554 This condition is relevant only in an ACL that is run after a message has been
29555 received, that is, in an ACL specified by &%acl_smtp_data%& or
29556 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29557 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29558 is loosely thought of as a &"sender"& address (hence the name of the test).
29559 However, an address that appears in one of these headers need not be an address
29560 that accepts bounce messages; only sender addresses in envelopes are required
29561 to accept bounces. Therefore, if you use the callout option on this check, you
29562 might want to arrange for a non-empty address in the MAIL command.
29563
29564 Details of address verification and the options are given later, starting at
29565 section &<<SECTaddressverification>>& (callouts are described in section
29566 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29567 condition to restrict it to bounce messages only:
29568 .code
29569 deny    senders = :
29570         message = A valid sender header is required for bounces
29571        !verify  = header_sender
29572 .endd
29573
29574 .vitem &*verify&~=&~header_syntax*&
29575 .cindex "&%verify%& ACL condition"
29576 .cindex "&ACL;" "verifying header syntax"
29577 .cindex "header lines" "verifying syntax"
29578 .cindex "verifying" "header syntax"
29579 This condition is relevant only in an ACL that is run after a message has been
29580 received, that is, in an ACL specified by &%acl_smtp_data%& or
29581 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29582 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29583 and &'Bcc:'&), returning true if there are no problems.
29584 Unqualified addresses (local parts without domains) are
29585 permitted only in locally generated messages and from hosts that match
29586 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29587 appropriate.
29588
29589 Note that this condition is a syntax check only. However, a common spamming
29590 ploy used to be to send syntactically invalid headers such as
29591 .code
29592 To: @
29593 .endd
29594 and this condition can be used to reject such messages, though they are not as
29595 common as they used to be.
29596
29597 .vitem &*verify&~=&~helo*&
29598 .cindex "&%verify%& ACL condition"
29599 .cindex "&ACL;" "verifying HELO/EHLO"
29600 .cindex "HELO" "verifying"
29601 .cindex "EHLO" "verifying"
29602 .cindex "verifying" "EHLO"
29603 .cindex "verifying" "HELO"
29604 This condition is true if a HELO or EHLO command has been received from the
29605 client host, and its contents have been verified. If there has been no previous
29606 attempt to verify the HELO/EHLO contents, it is carried out when this
29607 condition is encountered. See the description of the &%helo_verify_hosts%& and
29608 &%helo_try_verify_hosts%& options for details of how to request verification
29609 independently of this condition.
29610
29611 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29612 option), this condition is always true.
29613
29614
29615 .vitem &*verify&~=&~not_blind*&
29616 .cindex "verifying" "not blind"
29617 .cindex "bcc recipients, verifying none"
29618 This condition checks that there are no blind (bcc) recipients in the message.
29619 Every envelope recipient must appear either in a &'To:'& header line or in a
29620 &'Cc:'& header line for this condition to be true. Local parts are checked
29621 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29622 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29623 used only in a DATA or non-SMTP ACL.
29624
29625 There are, of course, many legitimate messages that make use of blind (bcc)
29626 recipients. This check should not be used on its own for blocking messages.
29627
29628
29629 .vitem &*verify&~=&~recipient/*&<&'options'&>
29630 .cindex "&%verify%& ACL condition"
29631 .cindex "&ACL;" "verifying recipient"
29632 .cindex "recipient" "verifying"
29633 .cindex "verifying" "recipient"
29634 .vindex "&$address_data$&"
29635 This condition is relevant only after a RCPT command. It verifies the current
29636 recipient. Details of address verification are given later, starting at section
29637 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29638 of &$address_data$& is the last value that was set while routing the address.
29639 This applies even if the verification fails. When an address that is being
29640 verified is redirected to a single address, verification continues with the new
29641 address, and in that case, the subsequent value of &$address_data$& is the
29642 value for the child address.
29643
29644 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29645 .cindex "&%verify%& ACL condition"
29646 .cindex "&ACL;" "verifying host reverse lookup"
29647 .cindex "host" "verifying reverse lookup"
29648 This condition ensures that a verified host name has been looked up from the IP
29649 address of the client host. (This may have happened already if the host name
29650 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29651 Verification ensures that the host name obtained from a reverse DNS lookup, or
29652 one of its aliases, does, when it is itself looked up in the DNS, yield the
29653 original IP address.
29654
29655 There is one possible option, &`defer_ok`&.  If this is present and a
29656 DNS operation returns a temporary error, the verify condition succeeds.
29657
29658 If this condition is used for a locally generated message (that is, when there
29659 is no client host involved), it always succeeds.
29660
29661 .vitem &*verify&~=&~sender/*&<&'options'&>
29662 .cindex "&%verify%& ACL condition"
29663 .cindex "&ACL;" "verifying sender"
29664 .cindex "sender" "verifying"
29665 .cindex "verifying" "sender"
29666 This condition is relevant only after a MAIL or RCPT command, or after a
29667 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29668 the message's sender is empty (that is, this is a bounce message), the
29669 condition is true. Otherwise, the sender address is verified.
29670
29671 .vindex "&$address_data$&"
29672 .vindex "&$sender_address_data$&"
29673 If there is data in the &$address_data$& variable at the end of routing, its
29674 value is placed in &$sender_address_data$& at the end of verification. This
29675 value can be used in subsequent conditions and modifiers in the same ACL
29676 statement. It does not persist after the end of the current statement. If you
29677 want to preserve the value for longer, you can save it in an ACL variable.
29678
29679 Details of verification are given later, starting at section
29680 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29681 to avoid doing it more than once per message.
29682
29683 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29684 .cindex "&%verify%& ACL condition"
29685 This is a variation of the previous option, in which a modified address is
29686 verified as a sender.
29687 .endlist
29688
29689
29690
29691 .section "Using DNS lists" "SECTmorednslists"
29692 .cindex "DNS list" "in ACL"
29693 .cindex "black list (DNS)"
29694 .cindex "&ACL;" "testing a DNS list"
29695 In its simplest form, the &%dnslists%& condition tests whether the calling host
29696 is on at least one of a number of DNS lists by looking up the inverted IP
29697 address in one or more DNS domains. (Note that DNS list domains are not mail
29698 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29699 special options instead.) For example, if the calling host's IP
29700 address is 192.168.62.43, and the ACL statement is
29701 .code
29702 deny dnslists = blackholes.mail-abuse.org : \
29703                 dialups.mail-abuse.org
29704 .endd
29705 the following records are looked up:
29706 .code
29707 43.62.168.192.blackholes.mail-abuse.org
29708 43.62.168.192.dialups.mail-abuse.org
29709 .endd
29710 As soon as Exim finds an existing DNS record, processing of the list stops.
29711 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29712 to test that a host is on more than one list (an &"and"& conjunction), you can
29713 use two separate conditions:
29714 .code
29715 deny dnslists = blackholes.mail-abuse.org
29716      dnslists = dialups.mail-abuse.org
29717 .endd
29718 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29719 behaves as if the host does not match the list item, that is, as if the DNS
29720 record does not exist. If there are further items in the DNS list, they are
29721 processed.
29722
29723 This is usually the required action when &%dnslists%& is used with &%deny%&
29724 (which is the most common usage), because it prevents a DNS failure from
29725 blocking mail. However, you can change this behaviour by putting one of the
29726 following special items in the list:
29727 .display
29728 &`+include_unknown `&   behave as if the item is on the list
29729 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29730 &`+defer_unknown   `&   give a temporary error
29731 .endd
29732 .cindex "&`+include_unknown`&"
29733 .cindex "&`+exclude_unknown`&"
29734 .cindex "&`+defer_unknown`&"
29735 Each of these applies to any subsequent items on the list. For example:
29736 .code
29737 deny dnslists = +defer_unknown : foo.bar.example
29738 .endd
29739 Testing the list of domains stops as soon as a match is found. If you want to
29740 warn for one list and block for another, you can use two different statements:
29741 .code
29742 deny  dnslists = blackholes.mail-abuse.org
29743 warn  message  = X-Warn: sending host is on dialups list
29744       dnslists = dialups.mail-abuse.org
29745 .endd
29746 .cindex cacheing "of dns lookup"
29747 .cindex DNS TTL
29748 DNS list lookups are cached by Exim for the duration of the SMTP session
29749 (but limited by the DNS return TTL value),
29750 so a lookup based on the IP address is done at most once for any incoming
29751 connection (assuming long-enough TTL).
29752 Exim does not share information between multiple incoming
29753 connections (but your local name server cache should be active).
29754
29755
29756
29757 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29758 .cindex "DNS list" "keyed by explicit IP address"
29759 By default, the IP address that is used in a DNS list lookup is the IP address
29760 of the calling host. However, you can specify another IP address by listing it
29761 after the domain name, introduced by a slash. For example:
29762 .code
29763 deny dnslists = black.list.tld/192.168.1.2
29764 .endd
29765 This feature is not very helpful with explicit IP addresses; it is intended for
29766 use with IP addresses that are looked up, for example, the IP addresses of the
29767 MX hosts or nameservers of an email sender address. For an example, see section
29768 &<<SECTmulkeyfor>>& below.
29769
29770
29771
29772
29773 .section "DNS lists keyed on domain names" "SECID202"
29774 .cindex "DNS list" "keyed by domain name"
29775 There are some lists that are keyed on domain names rather than inverted IP
29776 addresses (see for example the &'domain based zones'& link at
29777 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29778 with these lists. You can change the name that is looked up in a DNS list by
29779 listing it after the domain name, introduced by a slash. For example,
29780 .code
29781 deny  message  = Sender's domain is listed at $dnslist_domain
29782       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29783 .endd
29784 This particular example is useful only in ACLs that are obeyed after the
29785 RCPT or DATA commands, when a sender address is available. If (for
29786 example) the message's sender is &'user@tld.example'& the name that is looked
29787 up by this example is
29788 .code
29789 tld.example.dsn.rfc-ignorant.org
29790 .endd
29791 A single &%dnslists%& condition can contain entries for both names and IP
29792 addresses. For example:
29793 .code
29794 deny dnslists = sbl.spamhaus.org : \
29795                 dsn.rfc-ignorant.org/$sender_address_domain
29796 .endd
29797 The first item checks the sending host's IP address; the second checks a domain
29798 name. The whole condition is true if either of the DNS lookups succeeds.
29799
29800
29801
29802
29803 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29804 .cindex "DNS list" "multiple keys for"
29805 The syntax described above for looking up explicitly-defined values (either
29806 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29807 name for the DNS list, what follows the slash can in fact be a list of items.
29808 As with all lists in Exim, the default separator is a colon. However, because
29809 this is a sublist within the list of DNS blacklist domains, it is necessary
29810 either to double the separators like this:
29811 .code
29812 dnslists = black.list.tld/name.1::name.2
29813 .endd
29814 or to change the separator character, like this:
29815 .code
29816 dnslists = black.list.tld/<;name.1;name.2
29817 .endd
29818 If an item in the list is an IP address, it is inverted before the DNS
29819 blacklist domain is appended. If it is not an IP address, no inversion
29820 occurs. Consider this condition:
29821 .code
29822 dnslists = black.list.tld/<;192.168.1.2;a.domain
29823 .endd
29824 The DNS lookups that occur are:
29825 .code
29826 2.1.168.192.black.list.tld
29827 a.domain.black.list.tld
29828 .endd
29829 Once a DNS record has been found (that matches a specific IP return
29830 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29831 are done. If there is a temporary DNS error, the rest of the sublist of domains
29832 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29833 only if no other DNS lookup in this sublist succeeds. In other words, a
29834 successful lookup for any of the items in the sublist overrides a temporary
29835 error for a previous item.
29836
29837 The ability to supply a list of items after the slash is in some sense just a
29838 syntactic convenience. These two examples have the same effect:
29839 .code
29840 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29841 dnslists = black.list.tld/a.domain::b.domain
29842 .endd
29843 However, when the data for the list is obtained from a lookup, the second form
29844 is usually much more convenient. Consider this example:
29845 .code
29846 deny message  = The mail servers for the domain \
29847                 $sender_address_domain \
29848                 are listed at $dnslist_domain ($dnslist_value); \
29849                 see $dnslist_text.
29850      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29851                                    ${lookup dnsdb {>|mxh=\
29852                                    $sender_address_domain} }} }
29853 .endd
29854 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29855 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29856 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29857 of expanding the condition might be something like this:
29858 .code
29859 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29860 .endd
29861 Thus, this example checks whether or not the IP addresses of the sender
29862 domain's mail servers are on the Spamhaus black list.
29863
29864 The key that was used for a successful DNS list lookup is put into the variable
29865 &$dnslist_matched$& (see section &<<SECID204>>&).
29866
29867
29868
29869
29870 .section "Data returned by DNS lists" "SECID203"
29871 .cindex "DNS list" "data returned from"
29872 DNS lists are constructed using address records in the DNS. The original RBL
29873 just used the address 127.0.0.1 on the right hand side of each record, but the
29874 RBL+ list and some other lists use a number of values with different meanings.
29875 The values used on the RBL+ list are:
29876 .display
29877 127.1.0.1  RBL
29878 127.1.0.2  DUL
29879 127.1.0.3  DUL and RBL
29880 127.1.0.4  RSS
29881 127.1.0.5  RSS and RBL
29882 127.1.0.6  RSS and DUL
29883 127.1.0.7  RSS and DUL and RBL
29884 .endd
29885 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29886 different values. Some DNS lists may return more than one address record;
29887 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29888
29889
29890 .section "Variables set from DNS lists" "SECID204"
29891 .cindex "expansion" "variables, set from DNS list"
29892 .cindex "DNS list" "variables set from"
29893 .vindex "&$dnslist_domain$&"
29894 .vindex "&$dnslist_matched$&"
29895 .vindex "&$dnslist_text$&"
29896 .vindex "&$dnslist_value$&"
29897 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29898 the name of the overall domain that matched (for example,
29899 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29900 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29901 the DNS record. When the key is an IP address, it is not reversed in
29902 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29903 cases, for example:
29904 .code
29905 deny dnslists = spamhaus.example
29906 .endd
29907 the key is also available in another variable (in this case,
29908 &$sender_host_address$&). In more complicated cases, however, this is not true.
29909 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29910 might generate a dnslists lookup like this:
29911 .code
29912 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29913 .endd
29914 If this condition succeeds, the value in &$dnslist_matched$& might be
29915 &`192.168.6.7`& (for example).
29916
29917 If more than one address record is returned by the DNS lookup, all the IP
29918 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29919 The variable &$dnslist_text$& contains the contents of any associated TXT
29920 record. For lists such as RBL+ the TXT record for a merged entry is often not
29921 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29922 information.
29923
29924 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29925 &-- although these appear before the condition in the ACL, they are not
29926 expanded until after it has failed. For example:
29927 .code
29928 deny    hosts = !+local_networks
29929         message = $sender_host_address is listed \
29930                   at $dnslist_domain
29931         dnslists = rbl-plus.mail-abuse.example
29932 .endd
29933
29934
29935
29936 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29937 .cindex "DNS list" "matching specific returned data"
29938 You can add an equals sign and an IP address after a &%dnslists%& domain name
29939 in order to restrict its action to DNS records with a matching right hand side.
29940 For example,
29941 .code
29942 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29943 .endd
29944 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29945 any address record is considered to be a match. For the moment, we assume
29946 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29947 describes how multiple records are handled.
29948
29949 More than one IP address may be given for checking, using a comma as a
29950 separator. These are alternatives &-- if any one of them matches, the
29951 &%dnslists%& condition is true. For example:
29952 .code
29953 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29954 .endd
29955 If you want to specify a constraining address list and also specify names or IP
29956 addresses to be looked up, the constraining address list must be specified
29957 first. For example:
29958 .code
29959 deny dnslists = dsn.rfc-ignorant.org\
29960                 =127.0.0.2/$sender_address_domain
29961 .endd
29962
29963 If the character &`&&`& is used instead of &`=`&, the comparison for each
29964 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29965 In other words, the listed addresses are used as bit masks. The comparison is
29966 true if all the bits in the mask are present in the address that is being
29967 tested. For example:
29968 .code
29969 dnslists = a.b.c&0.0.0.3
29970 .endd
29971 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29972 want to test whether one bit or another bit is present (as opposed to both
29973 being present), you must use multiple values. For example:
29974 .code
29975 dnslists = a.b.c&0.0.0.1,0.0.0.2
29976 .endd
29977 matches if the final component of the address is an odd number or two times
29978 an odd number.
29979
29980
29981
29982 .section "Negated DNS matching conditions" "SECID205"
29983 You can supply a negative list of IP addresses as part of a &%dnslists%&
29984 condition. Whereas
29985 .code
29986 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29987 .endd
29988 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29989 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29990 .code
29991 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29992 .endd
29993 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29994 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29995 words, the result of the test is inverted if an exclamation mark appears before
29996 the &`=`& (or the &`&&`&) sign.
29997
29998 &*Note*&: This kind of negation is not the same as negation in a domain,
29999 host, or address list (which is why the syntax is different).
30000
30001 If you are using just one list, the negation syntax does not gain you much. The
30002 previous example is precisely equivalent to
30003 .code
30004 deny  dnslists = a.b.c
30005      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30006 .endd
30007 However, if you are using multiple lists, the negation syntax is clearer.
30008 Consider this example:
30009 .code
30010 deny  dnslists = sbl.spamhaus.org : \
30011                  list.dsbl.org : \
30012                  dnsbl.njabl.org!=127.0.0.3 : \
30013                  relays.ordb.org
30014 .endd
30015 Using only positive lists, this would have to be:
30016 .code
30017 deny  dnslists = sbl.spamhaus.org : \
30018                  list.dsbl.org
30019 deny  dnslists = dnsbl.njabl.org
30020      !dnslists = dnsbl.njabl.org=127.0.0.3
30021 deny  dnslists = relays.ordb.org
30022 .endd
30023 which is less clear, and harder to maintain.
30024
30025
30026
30027
30028 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30029 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30030 thereby providing more than one IP address. When an item in a &%dnslists%& list
30031 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30032 the match to specific results from the DNS lookup, there are two ways in which
30033 the checking can be handled. For example, consider the condition:
30034 .code
30035 dnslists = a.b.c=127.0.0.1
30036 .endd
30037 What happens if the DNS lookup for the incoming IP address yields both
30038 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30039 condition true because at least one given value was found, or is it false
30040 because at least one of the found values was not listed? And how does this
30041 affect negated conditions? Both possibilities are provided for with the help of
30042 additional separators &`==`& and &`=&&`&.
30043
30044 .ilist
30045 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30046 IP addresses matches one of the listed addresses. For the example above, the
30047 condition is true because 127.0.0.1 matches.
30048 .next
30049 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30050 looked up IP addresses matches one of the listed addresses. If the condition is
30051 changed to:
30052 .code
30053 dnslists = a.b.c==127.0.0.1
30054 .endd
30055 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30056 false because 127.0.0.2 is not listed. You would need to have:
30057 .code
30058 dnslists = a.b.c==127.0.0.1,127.0.0.2
30059 .endd
30060 for the condition to be true.
30061 .endlist
30062
30063 When &`!`& is used to negate IP address matching, it inverts the result, giving
30064 the precise opposite of the behaviour above. Thus:
30065 .ilist
30066 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30067 addresses matches one of the listed addresses. Consider:
30068 .code
30069 dnslists = a.b.c!&0.0.0.1
30070 .endd
30071 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30072 false because 127.0.0.1 matches.
30073 .next
30074 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30075 looked up IP address that does not match. Consider:
30076 .code
30077 dnslists = a.b.c!=&0.0.0.1
30078 .endd
30079 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30080 true, because 127.0.0.2 does not match. You would need to have:
30081 .code
30082 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30083 .endd
30084 for the condition to be false.
30085 .endlist
30086 When the DNS lookup yields only a single IP address, there is no difference
30087 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30088
30089
30090
30091
30092 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30093 .cindex "DNS list" "information from merged"
30094 When the facility for restricting the matching IP values in a DNS list is used,
30095 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30096 the true reason for rejection. This happens when lists are merged and the IP
30097 address in the A record is used to distinguish them; unfortunately there is
30098 only one TXT record. One way round this is not to use merged lists, but that
30099 can be inefficient because it requires multiple DNS lookups where one would do
30100 in the vast majority of cases when the host of interest is not on any of the
30101 lists.
30102
30103 A less inefficient way of solving this problem is available. If
30104 two domain names, comma-separated, are given, the second is used first to
30105 do an initial check, making use of any IP value restrictions that are set.
30106 If there is a match, the first domain is used, without any IP value
30107 restrictions, to get the TXT record. As a byproduct of this, there is also
30108 a check that the IP being tested is indeed on the first list. The first
30109 domain is the one that is put in &$dnslist_domain$&. For example:
30110 .code
30111 reject message  = \
30112          rejected because $sender_host_address is blacklisted \
30113          at $dnslist_domain\n$dnslist_text
30114        dnslists = \
30115          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30116          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30117 .endd
30118 For the first blacklist item, this starts by doing a lookup in
30119 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30120 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30121 value, and as long as something is found, it looks for the corresponding TXT
30122 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30123 The second blacklist item is processed similarly.
30124
30125 If you are interested in more than one merged list, the same list must be
30126 given several times, but because the results of the DNS lookups are cached,
30127 the DNS calls themselves are not repeated. For example:
30128 .code
30129 reject dnslists = \
30130          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30131          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30132          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30133          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30134 .endd
30135 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30136 values matches (or if no record is found), this is the only lookup that is
30137 done. Only if there is a match is one of the more specific lists consulted.
30138
30139
30140
30141 .section "DNS lists and IPv6" "SECTmorednslistslast"
30142 .cindex "IPv6" "DNS black lists"
30143 .cindex "DNS list" "IPv6 usage"
30144 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30145 nibble by nibble. For example, if the calling host's IP address is
30146 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30147 .code
30148 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30149   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30150 .endd
30151 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30152 lists contain wildcard records, intended for IPv4, that interact badly with
30153 IPv6. For example, the DNS entry
30154 .code
30155 *.3.some.list.example.    A    127.0.0.1
30156 .endd
30157 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30158 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30159
30160 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30161 &%condition%& condition, as in this example:
30162 .code
30163 deny   condition = ${if isip4{$sender_host_address}}
30164        dnslists  = some.list.example
30165 .endd
30166
30167 If an explicit key is being used for a DNS lookup and it may be an IPv6
30168 address you should specify alternate list separators for both the outer
30169 (DNS list name) list and inner (lookup keys) list:
30170 .code
30171        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30172 .endd
30173
30174 .section "Rate limiting incoming messages" "SECTratelimiting"
30175 .cindex "rate limiting" "client sending"
30176 .cindex "limiting client sending rates"
30177 .oindex "&%smtp_ratelimit_*%&"
30178 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30179 which clients can send email. This is more powerful than the
30180 &%smtp_ratelimit_*%& options, because those options control the rate of
30181 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30182 works across all connections (concurrent and sequential) from the same client
30183 host. The syntax of the &%ratelimit%& condition is:
30184 .display
30185 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30186 .endd
30187 If the average client sending rate is less than &'m'& messages per time
30188 period &'p'& then the condition is false; otherwise it is true.
30189
30190 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30191 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30192 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30193 of &'p'&.
30194
30195 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30196 time interval, for example, &`8h`& for eight hours. A larger time constant
30197 means that it takes Exim longer to forget a client's past behaviour. The
30198 parameter &'m'& is the maximum number of messages that a client is permitted to
30199 send in each time interval. It also specifies the number of messages permitted
30200 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30201 constant, you can allow a client to send more messages in a burst without
30202 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30203 both small, messages must be sent at an even rate.
30204
30205 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30206 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30207 when deploying the &%ratelimit%& ACL condition. The script prints usage
30208 instructions when it is run with no arguments.
30209
30210 The key is used to look up the data for calculating the client's average
30211 sending rate. This data is stored in Exim's spool directory, alongside the
30212 retry and other hints databases. The default key is &$sender_host_address$&,
30213 which means Exim computes the sending rate of each client host IP address.
30214 By changing the key you can change how Exim identifies clients for the purpose
30215 of ratelimiting. For example, to limit the sending rate of each authenticated
30216 user, independent of the computer they are sending from, set the key to
30217 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30218 example, &$authenticated_id$& is only meaningful if the client has
30219 authenticated (which you can check with the &%authenticated%& ACL condition).
30220
30221 The lookup key does not have to identify clients: If you want to limit the
30222 rate at which a recipient receives messages, you can use the key
30223 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30224 ACL.
30225
30226 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30227 specifies what Exim measures the rate of, for example messages or recipients
30228 or bytes. You can adjust the measurement using the &%unique=%& and/or
30229 &%count=%& options. You can also control when Exim updates the recorded rate
30230 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30231 separated by a slash, like the other parameters. They may appear in any order.
30232
30233 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30234 any options that alter the meaning of the stored data. The limit &'m'& is not
30235 stored, so you can alter the configured maximum rate and Exim will still
30236 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30237 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30238 behaviour. The lookup key is not affected by changes to the update mode and
30239 the &%count=%& option.
30240
30241
30242 .section "Ratelimit options for what is being measured" "ratoptmea"
30243 .cindex "rate limiting" "per_* options"
30244 The &%per_conn%& option limits the client's connection rate. It is not
30245 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30246 &%acl_not_smtp_start%& ACLs.
30247
30248 The &%per_mail%& option limits the client's rate of sending messages. This is
30249 the default if none of the &%per_*%& options is specified. It can be used in
30250 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30251 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30252
30253 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30254 the same ACLs as the &%per_mail%& option, though it is best to use this option
30255 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30256 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30257 in its MAIL command, which may be inaccurate or completely missing. You can
30258 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30259 in kilobytes, megabytes, or gigabytes, respectively.
30260
30261 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30262 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30263 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30264 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30265 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30266 in either case the rate limiting engine will see a message with many
30267 recipients as a large high-speed burst.
30268
30269 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30270 number of different recipients that the client has sent messages to in the
30271 last time period. That is, if the client repeatedly sends messages to the same
30272 recipient, its measured rate is not increased. This option can only be used in
30273 &%acl_smtp_rcpt%&.
30274
30275 The &%per_cmd%& option causes Exim to recompute the rate every time the
30276 condition is processed. This can be used to limit the rate of any SMTP
30277 command. If it is used in multiple ACLs it can limit the aggregate rate of
30278 multiple different commands.
30279
30280 The &%count=%& option can be used to alter how much Exim adds to the client's
30281 measured rate. For example, the &%per_byte%& option is equivalent to
30282 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30283 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30284 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30285
30286 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30287
30288
30289 .section "Ratelimit update modes" "ratoptupd"
30290 .cindex "rate limiting" "reading data without updating"
30291 You can specify one of three options with the &%ratelimit%& condition to
30292 control when its database is updated. This section describes the &%readonly%&
30293 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30294
30295 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30296 previously-computed rate to check against the limit.
30297
30298 For example, you can test the client's sending rate and deny it access (when
30299 it is too fast) in the connect ACL. If the client passes this check then it
30300 can go on to send a message, in which case its recorded rate will be updated
30301 in the MAIL ACL. Subsequent connections from the same client will check this
30302 new rate.
30303 .code
30304 acl_check_connect:
30305  deny ratelimit = 100 / 5m / readonly
30306     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30307                   (max $sender_rate_limit)
30308 # ...
30309 acl_check_mail:
30310  warn ratelimit = 100 / 5m / strict
30311     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30312                   (max $sender_rate_limit)
30313 .endd
30314
30315 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30316 processing a message then it may increase the client's measured rate more than
30317 it should. For example, this will happen if you check the &%per_rcpt%& option
30318 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30319 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30320 multiple update problems by using the &%readonly%& option on later ratelimit
30321 checks.
30322
30323 The &%per_*%& options described above do not make sense in some ACLs. If you
30324 use a &%per_*%& option in an ACL where it is not normally permitted then the
30325 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30326 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30327 next section) so you must specify the &%readonly%& option explicitly.
30328
30329
30330 .section "Ratelimit options for handling fast clients" "ratoptfast"
30331 .cindex "rate limiting" "strict and leaky modes"
30332 If a client's average rate is greater than the maximum, the rate limiting
30333 engine can react in two possible ways, depending on the presence of the
30334 &%strict%& or &%leaky%& update modes. This is independent of the other
30335 counter-measures (such as rejecting the message) that may be specified by the
30336 rest of the ACL.
30337
30338 The &%leaky%& (default) option means that the client's recorded rate is not
30339 updated if it is above the limit. The effect of this is that Exim measures the
30340 client's average rate of successfully sent email, which cannot be greater than
30341 the maximum allowed. If the client is over the limit it may suffer some
30342 counter-measures (as specified in the ACL), but it will still be able to send
30343 email at the configured maximum rate, whatever the rate of its attempts. This
30344 is generally the better choice if you have clients that retry automatically.
30345 For example, it does not prevent a sender with an over-aggressive retry rate
30346 from getting any email through.
30347
30348 The &%strict%& option means that the client's recorded rate is always
30349 updated. The effect of this is that Exim measures the client's average rate
30350 of attempts to send email, which can be much higher than the maximum it is
30351 actually allowed. If the client is over the limit it may be subjected to
30352 counter-measures by the ACL. It must slow down and allow sufficient time to
30353 pass that its computed rate falls below the maximum before it can send email
30354 again. The time (the number of smoothing periods) it must wait and not
30355 attempt to send mail can be calculated with this formula:
30356 .code
30357         ln(peakrate/maxrate)
30358 .endd
30359
30360
30361 .section "Limiting the rate of different events" "ratoptuniq"
30362 .cindex "rate limiting" "counting unique events"
30363 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30364 rate of different events. For example, the &%per_addr%& option uses this
30365 mechanism to count the number of different recipients that the client has
30366 sent messages to in the last time period; it is equivalent to
30367 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30368 measure the rate that a client uses different sender addresses with the
30369 options &`per_mail/unique=$sender_address`&.
30370
30371 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30372 has seen for that key. The whole set is thrown away when it is older than the
30373 rate smoothing period &'p'&, so each different event is counted at most once
30374 per period. In the &%leaky%& update mode, an event that causes the client to
30375 go over the limit is not added to the set, in the same way that the client's
30376 recorded rate is not updated in the same situation.
30377
30378 When you combine the &%unique=%& and &%readonly%& options, the specific
30379 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30380 rate.
30381
30382 The &%unique=%& mechanism needs more space in the ratelimit database than the
30383 other &%ratelimit%& options in order to store the event set. The number of
30384 unique values is potentially as large as the rate limit, so the extra space
30385 required increases with larger limits.
30386
30387 The uniqueification is not perfect: there is a small probability that Exim
30388 will think a new event has happened before. If the sender's rate is less than
30389 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30390 the measured rate can go above the limit, in which case Exim may under-count
30391 events by a significant margin. Fortunately, if the rate is high enough (2.7
30392 times the limit) that the false positive rate goes above 9%, then Exim will
30393 throw away the over-full event set before the measured rate falls below the
30394 limit. Therefore the only harm should be that exceptionally high sending rates
30395 are logged incorrectly; any countermeasures you configure will be as effective
30396 as intended.
30397
30398
30399 .section "Using rate limiting" "useratlim"
30400 Exim's other ACL facilities are used to define what counter-measures are taken
30401 when the rate limit is exceeded. This might be anything from logging a warning
30402 (for example, while measuring existing sending rates in order to define
30403 policy), through time delays to slow down fast senders, up to rejecting the
30404 message. For example:
30405 .code
30406 # Log all senders' rates
30407 warn ratelimit = 0 / 1h / strict
30408      log_message = Sender rate $sender_rate / $sender_rate_period
30409
30410 # Slow down fast senders; note the need to truncate $sender_rate
30411 # at the decimal point.
30412 warn ratelimit = 100 / 1h / per_rcpt / strict
30413      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30414                    $sender_rate_limit }s
30415
30416 # Keep authenticated users under control
30417 deny authenticated = *
30418      ratelimit = 100 / 1d / strict / $authenticated_id
30419
30420 # System-wide rate limit
30421 defer message = Sorry, too busy. Try again later.
30422      ratelimit = 10 / 1s / $primary_hostname
30423
30424 # Restrict incoming rate from each host, with a default
30425 # set using a macro and special cases looked up in a table.
30426 defer message = Sender rate exceeds $sender_rate_limit \
30427                messages per $sender_rate_period
30428      ratelimit = ${lookup {$sender_host_address} \
30429                    cdb {DB/ratelimits.cdb} \
30430                    {$value} {RATELIMIT} }
30431 .endd
30432 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30433 especially with the &%per_rcpt%& option, you may suffer from a performance
30434 bottleneck caused by locking on the ratelimit hints database. Apart from
30435 making your ACLs less complicated, you can reduce the problem by using a
30436 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30437 this means that Exim will lose its hints data after a reboot (including retry
30438 hints, the callout cache, and ratelimit data).
30439
30440
30441
30442 .section "Address verification" "SECTaddressverification"
30443 .cindex "verifying address" "options for"
30444 .cindex "policy control" "address verification"
30445 Several of the &%verify%& conditions described in section
30446 &<<SECTaclconditions>>& cause addresses to be verified. Section
30447 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30448 The verification conditions can be followed by options that modify the
30449 verification process. The options are separated from the keyword and from each
30450 other by slashes, and some of them contain parameters. For example:
30451 .code
30452 verify = sender/callout
30453 verify = recipient/defer_ok/callout=10s,defer_ok
30454 .endd
30455 The first stage of address verification, which always happens, is to run the
30456 address through the routers, in &"verify mode"&. Routers can detect the
30457 difference between verification and routing for delivery, and their actions can
30458 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30459 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30460 The available options are as follows:
30461
30462 .ilist
30463 If the &%callout%& option is specified, successful routing to one or more
30464 remote hosts is followed by a &"callout"& to those hosts as an additional
30465 check. Callouts and their sub-options are discussed in the next section.
30466 .next
30467 If there is a defer error while doing verification routing, the ACL
30468 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30469 options, the condition is forced to be true instead. Note that this is a main
30470 verification option as well as a suboption for callouts.
30471 .next
30472 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30473 discusses the reporting of sender address verification failures.
30474 .next
30475 The &%success_on_redirect%& option causes verification always to succeed
30476 immediately after a successful redirection. By default, if a redirection
30477 generates just one address, that address is also verified. See further
30478 discussion in section &<<SECTredirwhilveri>>&.
30479 .endlist
30480
30481 .cindex "verifying address" "differentiating failures"
30482 .vindex "&$recipient_verify_failure$&"
30483 .vindex "&$sender_verify_failure$&"
30484 .vindex "&$acl_verify_message$&"
30485 After an address verification failure, &$acl_verify_message$& contains the
30486 error message that is associated with the failure. It can be preserved by
30487 coding like this:
30488 .code
30489 warn  !verify = sender
30490        set acl_m0 = $acl_verify_message
30491 .endd
30492 If you are writing your own custom rejection message or log message when
30493 denying access, you can use this variable to include information about the
30494 verification failure.
30495
30496 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30497 appropriate) contains one of the following words:
30498
30499 .ilist
30500 &%qualify%&: The address was unqualified (no domain), and the message
30501 was neither local nor came from an exempted host.
30502 .next
30503 &%route%&: Routing failed.
30504 .next
30505 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30506 occurred at or before the MAIL command (that is, on initial
30507 connection, HELO, or MAIL).
30508 .next
30509 &%recipient%&: The RCPT command in a callout was rejected.
30510 .next
30511 &%postmaster%&: The postmaster check in a callout was rejected.
30512 .endlist
30513
30514 The main use of these variables is expected to be to distinguish between
30515 rejections of MAIL and rejections of RCPT in callouts.
30516
30517
30518
30519
30520 .section "Callout verification" "SECTcallver"
30521 .cindex "verifying address" "by callout"
30522 .cindex "callout" "verification"
30523 .cindex "SMTP" "callout verification"
30524 For non-local addresses, routing verifies the domain, but is unable to do any
30525 checking of the local part. There are situations where some means of verifying
30526 the local part is desirable. One way this can be done is to make an SMTP
30527 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30528 a subsequent host for a recipient address, to see if the host accepts the
30529 address. We use the term &'callout'& to cover both cases. Note that for a
30530 sender address, the callback is not to the client host that is trying to
30531 deliver the message, but to one of the hosts that accepts incoming mail for the
30532 sender's domain.
30533
30534 Exim does not do callouts by default. If you want them to happen, you must
30535 request them by setting appropriate options on the &%verify%& condition, as
30536 described below. This facility should be used with care, because it can add a
30537 lot of resource usage to the cost of verifying an address. However, Exim does
30538 cache the results of callouts, which helps to reduce the cost. Details of
30539 caching are in section &<<SECTcallvercache>>&.
30540
30541 Recipient callouts are usually used only between hosts that are controlled by
30542 the same administration. For example, a corporate gateway host could use
30543 callouts to check for valid recipients on an internal mailserver. A successful
30544 callout does not guarantee that a real delivery to the address would succeed;
30545 on the other hand, a failing callout does guarantee that a delivery would fail.
30546
30547 If the &%callout%& option is present on a condition that verifies an address, a
30548 second stage of verification occurs if the address is successfully routed to
30549 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30550 &(manualroute)& router, where the router specifies the hosts. However, if a
30551 router that does not set up hosts routes to an &(smtp)& transport with a
30552 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30553 &%hosts_override%& set, its hosts are always used, whether or not the router
30554 supplies a host list.
30555 Callouts are only supported on &(smtp)& transports.
30556
30557 The port that is used is taken from the transport, if it is specified and is a
30558 remote transport. (For routers that do verification only, no transport need be
30559 specified.) Otherwise, the default SMTP port is used. If a remote transport
30560 specifies an outgoing interface, this is used; otherwise the interface is not
30561 specified. Likewise, the text that is used for the HELO command is taken from
30562 the transport's &%helo_data%& option; if there is no transport, the value of
30563 &$smtp_active_hostname$& is used.
30564
30565 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30566 test whether a bounce message could be delivered to the sender address. The
30567 following SMTP commands are sent:
30568 .display
30569 &`HELO `&<&'local host name'&>
30570 &`MAIL FROM:<>`&
30571 &`RCPT TO:`&<&'the address to be tested'&>
30572 &`QUIT`&
30573 .endd
30574 LHLO is used instead of HELO if the transport's &%protocol%& option is
30575 set to &"lmtp"&.
30576
30577 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30578 settings.
30579
30580 A recipient callout check is similar. By default, it also uses an empty address
30581 for the sender. This default is chosen because most hosts do not make use of
30582 the sender address when verifying a recipient. Using the same address means
30583 that a single cache entry can be used for each recipient. Some sites, however,
30584 do make use of the sender address when verifying. These are catered for by the
30585 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30586
30587 If the response to the RCPT command is a 2&'xx'& code, the verification
30588 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30589 Exim tries the next host, if any. If there is a problem with all the remote
30590 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30591 &%callout%& option is given, in which case the condition is forced to succeed.
30592
30593 .cindex "SMTP" "output flushing, disabling for callout"
30594 A callout may take a little time. For this reason, Exim normally flushes SMTP
30595 output before performing a callout in an ACL, to avoid unexpected timeouts in
30596 clients when the SMTP PIPELINING extension is in use. The flushing can be
30597 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30598
30599
30600
30601
30602 .section "Additional parameters for callouts" "CALLaddparcall"
30603 .cindex "callout" "additional parameters for"
30604 The &%callout%& option can be followed by an equals sign and a number of
30605 optional parameters, separated by commas. For example:
30606 .code
30607 verify = recipient/callout=10s,defer_ok
30608 .endd
30609 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30610 separate verify options, is retained for backwards compatibility, but is now
30611 deprecated. The additional parameters for &%callout%& are as follows:
30612
30613
30614 .vlist
30615 .vitem <&'a&~time&~interval'&>
30616 .cindex "callout" "timeout, specifying"
30617 This specifies the timeout that applies for the callout attempt to each host.
30618 For example:
30619 .code
30620 verify = sender/callout=5s
30621 .endd
30622 The default is 30 seconds. The timeout is used for each response from the
30623 remote host. It is also used for the initial connection, unless overridden by
30624 the &%connect%& parameter.
30625
30626
30627 .vitem &*connect&~=&~*&<&'time&~interval'&>
30628 .cindex "callout" "connection timeout, specifying"
30629 This parameter makes it possible to set a different (usually smaller) timeout
30630 for making the SMTP connection. For example:
30631 .code
30632 verify = sender/callout=5s,connect=1s
30633 .endd
30634 If not specified, this timeout defaults to the general timeout value.
30635
30636 .vitem &*defer_ok*&
30637 .cindex "callout" "defer, action on"
30638 When this parameter is present, failure to contact any host, or any other kind
30639 of temporary error, is treated as success by the ACL. However, the cache is not
30640 updated in this circumstance.
30641
30642 .vitem &*fullpostmaster*&
30643 .cindex "callout" "full postmaster check"
30644 This operates like the &%postmaster%& option (see below), but if the check for
30645 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30646 accordance with the specification in RFC 2821. The RFC states that the
30647 unqualified address &'postmaster'& should be accepted.
30648
30649
30650 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30651 .cindex "callout" "sender when verifying header"
30652 When verifying addresses in header lines using the &%header_sender%&
30653 verification option, Exim behaves by default as if the addresses are envelope
30654 sender addresses from a message. Callout verification therefore tests to see
30655 whether a bounce message could be delivered, by using an empty address in the
30656 MAIL command. However, it is arguable that these addresses might never be used
30657 as envelope senders, and could therefore justifiably reject bounce messages
30658 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30659 address to use in the MAIL command. For example:
30660 .code
30661 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30662 .endd
30663 This parameter is available only for the &%header_sender%& verification option.
30664
30665
30666 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30667 .cindex "callout" "overall timeout, specifying"
30668 This parameter sets an overall timeout for performing a callout verification.
30669 For example:
30670 .code
30671 verify = sender/callout=5s,maxwait=30s
30672 .endd
30673 This timeout defaults to four times the callout timeout for individual SMTP
30674 commands. The overall timeout applies when there is more than one host that can
30675 be tried. The timeout is checked before trying the next host. This prevents
30676 very long delays if there are a large number of hosts and all are timing out
30677 (for example, when network connections are timing out).
30678
30679
30680 .vitem &*no_cache*&
30681 .cindex "callout" "cache, suppressing"
30682 .cindex "caching callout, suppressing"
30683 When this parameter is given, the callout cache is neither read nor updated.
30684
30685 .vitem &*postmaster*&
30686 .cindex "callout" "postmaster; checking"
30687 When this parameter is set, a successful callout check is followed by a similar
30688 check for the local part &'postmaster'& at the same domain. If this address is
30689 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30690 the postmaster check is recorded in a cache record; if it is a failure, this is
30691 used to fail subsequent callouts for the domain without a connection being
30692 made, until the cache record expires.
30693
30694 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30695 The postmaster check uses an empty sender in the MAIL command by default.
30696 You can use this parameter to do a postmaster check using a different address.
30697 For example:
30698 .code
30699 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30700 .endd
30701 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30702 one overrides. The &%postmaster%& parameter is equivalent to this example:
30703 .code
30704 require  verify = sender/callout=postmaster_mailfrom=
30705 .endd
30706 &*Warning*&: The caching arrangements for postmaster checking do not take
30707 account of the sender address. It is assumed that either the empty address or
30708 a fixed non-empty address will be used. All that Exim remembers is that the
30709 postmaster check for the domain succeeded or failed.
30710
30711
30712 .vitem &*random*&
30713 .cindex "callout" "&""random""& check"
30714 When this parameter is set, before doing the normal callout check, Exim does a
30715 check for a &"random"& local part at the same domain. The local part is not
30716 really random &-- it is defined by the expansion of the option
30717 &%callout_random_local_part%&, which defaults to
30718 .code
30719 $primary_hostname-$tod_epoch-testing
30720 .endd
30721 The idea here is to try to determine whether the remote host accepts all local
30722 parts without checking. If it does, there is no point in doing callouts for
30723 specific local parts. If the &"random"& check succeeds, the result is saved in
30724 a cache record, and used to force the current and subsequent callout checks to
30725 succeed without a connection being made, until the cache record expires.
30726
30727 .vitem &*use_postmaster*&
30728 .cindex "callout" "sender for recipient check"
30729 This parameter applies to recipient callouts only. For example:
30730 .code
30731 deny  !verify = recipient/callout=use_postmaster
30732 .endd
30733 .vindex "&$qualify_domain$&"
30734 It causes a non-empty postmaster address to be used in the MAIL command when
30735 performing the callout for the recipient, and also for a &"random"& check if
30736 that is configured. The local part of the address is &`postmaster`& and the
30737 domain is the contents of &$qualify_domain$&.
30738
30739 .vitem &*use_sender*&
30740 This option applies to recipient callouts only. For example:
30741 .code
30742 require  verify = recipient/callout=use_sender
30743 .endd
30744 It causes the message's actual sender address to be used in the MAIL
30745 command when performing the callout, instead of an empty address. There is no
30746 need to use this option unless you know that the called hosts make use of the
30747 sender when checking recipients. If used indiscriminately, it reduces the
30748 usefulness of callout caching.
30749 .endlist
30750
30751 If you use any of the parameters that set a non-empty sender for the MAIL
30752 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30753 &%use_sender%&), you should think about possible loops. Recipient checking is
30754 usually done between two hosts that are under the same management, and the host
30755 that receives the callouts is not normally configured to do callouts itself.
30756 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30757 these circumstances.
30758
30759 However, if you use a non-empty sender address for a callout to an arbitrary
30760 host, there is the likelihood that the remote host will itself initiate a
30761 callout check back to your host. As it is checking what appears to be a message
30762 sender, it is likely to use an empty address in MAIL, thus avoiding a
30763 callout loop. However, to be on the safe side it would be best to set up your
30764 own ACLs so that they do not do sender verification checks when the recipient
30765 is the address you use for header sender or postmaster callout checking.
30766
30767 Another issue to think about when using non-empty senders for callouts is
30768 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30769 by the sender/recipient combination; thus, for any given recipient, many more
30770 actual callouts are performed than when an empty sender or postmaster is used.
30771
30772
30773
30774
30775 .section "Callout caching" "SECTcallvercache"
30776 .cindex "hints database" "callout cache"
30777 .cindex "callout" "cache, description of"
30778 .cindex "caching" "callout"
30779 Exim caches the results of callouts in order to reduce the amount of resources
30780 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30781 option. A hints database called &"callout"& is used for the cache. Two
30782 different record types are used: one records the result of a callout check for
30783 a specific address, and the other records information that applies to the
30784 entire domain (for example, that it accepts the local part &'postmaster'&).
30785
30786 When an original callout fails, a detailed SMTP error message is given about
30787 the failure. However, for subsequent failures use the cache data, this message
30788 is not available.
30789
30790 The expiry times for negative and positive address cache records are
30791 independent, and can be set by the global options &%callout_negative_expire%&
30792 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30793
30794 If a host gives a negative response to an SMTP connection, or rejects any
30795 commands up to and including
30796 .code
30797 MAIL FROM:<>
30798 .endd
30799 (but not including the MAIL command with a non-empty address),
30800 any callout attempt is bound to fail. Exim remembers such failures in a
30801 domain cache record, which it uses to fail callouts for the domain without
30802 making new connections, until the domain record times out. There are two
30803 separate expiry times for domain cache records:
30804 &%callout_domain_negative_expire%& (default 3h) and
30805 &%callout_domain_positive_expire%& (default 7d).
30806
30807 Domain records expire when the negative expiry time is reached if callouts
30808 cannot be made for the domain, or if the postmaster check failed.
30809 Otherwise, they expire when the positive expiry time is reached. This
30810 ensures that, for example, a host that stops accepting &"random"& local parts
30811 will eventually be noticed.
30812
30813 The callout caching mechanism is based on the domain of the address that is
30814 being tested. If the domain routes to several hosts, it is assumed that their
30815 behaviour will be the same.
30816
30817
30818
30819 .section "Sender address verification reporting" "SECTsenaddver"
30820 .cindex "verifying" "suppressing error details"
30821 See section &<<SECTaddressverification>>& for a general discussion of
30822 verification. When sender verification fails in an ACL, the details of the
30823 failure are given as additional output lines before the 550 response to the
30824 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30825 you might see:
30826 .code
30827 MAIL FROM:<xyz@abc.example>
30828 250 OK
30829 RCPT TO:<pqr@def.example>
30830 550-Verification failed for <xyz@abc.example>
30831 550-Called:   192.168.34.43
30832 550-Sent:     RCPT TO:<xyz@abc.example>
30833 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30834 550 Sender verification failed
30835 .endd
30836 If more than one RCPT command fails in the same way, the details are given
30837 only for the first of them. However, some administrators do not want to send
30838 out this much information. You can suppress the details by adding
30839 &`/no_details`& to the ACL statement that requests sender verification. For
30840 example:
30841 .code
30842 verify = sender/no_details
30843 .endd
30844
30845 .section "Redirection while verifying" "SECTredirwhilveri"
30846 .cindex "verifying" "redirection while"
30847 .cindex "address redirection" "while verifying"
30848 A dilemma arises when a local address is redirected by aliasing or forwarding
30849 during verification: should the generated addresses themselves be verified,
30850 or should the successful expansion of the original address be enough to verify
30851 it? By default, Exim takes the following pragmatic approach:
30852
30853 .ilist
30854 When an incoming address is redirected to just one child address, verification
30855 continues with the child address, and if that fails to verify, the original
30856 verification also fails.
30857 .next
30858 When an incoming address is redirected to more than one child address,
30859 verification does not continue. A success result is returned.
30860 .endlist
30861
30862 This seems the most reasonable behaviour for the common use of aliasing as a
30863 way of redirecting different local parts to the same mailbox. It means, for
30864 example, that a pair of alias entries of the form
30865 .code
30866 A.Wol:   aw123
30867 aw123:   :fail: Gone away, no forwarding address
30868 .endd
30869 work as expected, with both local parts causing verification failure. When a
30870 redirection generates more than one address, the behaviour is more like a
30871 mailing list, where the existence of the alias itself is sufficient for
30872 verification to succeed.
30873
30874 It is possible, however, to change the default behaviour so that all successful
30875 redirections count as successful verifications, however many new addresses are
30876 generated. This is specified by the &%success_on_redirect%& verification
30877 option. For example:
30878 .code
30879 require verify = recipient/success_on_redirect/callout=10s
30880 .endd
30881 In this example, verification succeeds if a router generates a new address, and
30882 the callout does not occur, because no address was routed to a remote host.
30883
30884 When verification is being tested via the &%-bv%& option, the treatment of
30885 redirections is as just described, unless the &%-v%& or any debugging option is
30886 also specified. In that case, full verification is done for every generated
30887 address and a report is output for each of them.
30888
30889
30890
30891 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30892 .cindex "CSA" "verifying"
30893 Client SMTP Authorization is a system that allows a site to advertise
30894 which machines are and are not permitted to send email. This is done by placing
30895 special SRV records in the DNS; these are looked up using the client's HELO
30896 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30897 Authorization checks in Exim are performed by the ACL condition:
30898 .code
30899 verify = csa
30900 .endd
30901 This fails if the client is not authorized. If there is a DNS problem, or if no
30902 valid CSA SRV record is found, or if the client is authorized, the condition
30903 succeeds. These three cases can be distinguished using the expansion variable
30904 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30905 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30906 be likely to cause problems for legitimate email.
30907
30908 The error messages produced by the CSA code include slightly more
30909 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30910 looking up the CSA SRV record, or problems looking up the CSA target
30911 address record. There are four reasons for &$csa_status$& being &"fail"&:
30912
30913 .ilist
30914 The client's host name is explicitly not authorized.
30915 .next
30916 The client's IP address does not match any of the CSA target IP addresses.
30917 .next
30918 The client's host name is authorized but it has no valid target IP addresses
30919 (for example, the target's addresses are IPv6 and the client is using IPv4).
30920 .next
30921 The client's host name has no CSA SRV record but a parent domain has asserted
30922 that all subdomains must be explicitly authorized.
30923 .endlist
30924
30925 The &%csa%& verification condition can take an argument which is the domain to
30926 use for the DNS query. The default is:
30927 .code
30928 verify = csa/$sender_helo_name
30929 .endd
30930 This implementation includes an extension to CSA. If the query domain
30931 is an address literal such as [192.0.2.95], or if it is a bare IP
30932 address, Exim searches for CSA SRV records in the reverse DNS as if
30933 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30934 meaningful to say:
30935 .code
30936 verify = csa/$sender_host_address
30937 .endd
30938 In fact, this is the check that Exim performs if the client does not say HELO.
30939 This extension can be turned off by setting the main configuration option
30940 &%dns_csa_use_reverse%& to be false.
30941
30942 If a CSA SRV record is not found for the domain itself, a search
30943 is performed through its parent domains for a record which might be
30944 making assertions about subdomains. The maximum depth of this search is limited
30945 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30946 default. Exim does not look for CSA SRV records in a top level domain, so the
30947 default settings handle HELO domains as long as seven
30948 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30949 of legitimate HELO domains.
30950
30951 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30952 direct SRV lookups, this is not sufficient because of the extra parent domain
30953 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30954 addresses into lookups in the reverse DNS space. The result of a successful
30955 lookup such as:
30956 .code
30957 ${lookup dnsdb {csa=$sender_helo_name}}
30958 .endd
30959 has two space-separated fields: an authorization code and a target host name.
30960 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30961 authorization required but absent, or &"?"& for unknown.
30962
30963
30964
30965
30966 .section "Bounce address tag validation" "SECTverifyPRVS"
30967 .cindex "BATV, verifying"
30968 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30969 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30970 Genuine incoming bounce messages should therefore always be addressed to
30971 recipients that have a valid tag. This scheme is a way of detecting unwanted
30972 bounce messages caused by sender address forgeries (often called &"collateral
30973 spam"&), because the recipients of such messages do not include valid tags.
30974
30975 There are two expansion items to help with the implementation of the BATV
30976 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30977 the original envelope sender address by using a simple key to add a hash of the
30978 address and some time-based randomizing information. The &%prvs%& expansion
30979 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30980 The syntax of these expansion items is described in section
30981 &<<SECTexpansionitems>>&.
30982
30983 As an example, suppose the secret per-address keys are stored in an MySQL
30984 database. A query to look up the key for an address could be defined as a macro
30985 like this:
30986 .code
30987 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30988                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30989                 }{$value}}
30990 .endd
30991 Suppose also that the senders who make use of BATV are defined by an address
30992 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30993 use this:
30994 .code
30995 # Bounces: drop unsigned addresses for BATV senders
30996 deny message = This address does not send an unsigned reverse path
30997      senders = :
30998      recipients = +batv_senders
30999
31000 # Bounces: In case of prvs-signed address, check signature.
31001 deny message = Invalid reverse path signature.
31002      senders = :
31003      condition  = ${prvscheck {$local_part@$domain}\
31004                   {PRVSCHECK_SQL}{1}}
31005      !condition = $prvscheck_result
31006 .endd
31007 The first statement rejects recipients for bounce messages that are addressed
31008 to plain BATV sender addresses, because it is known that BATV senders do not
31009 send out messages with plain sender addresses. The second statement rejects
31010 recipients that are prvs-signed, but with invalid signatures (either because
31011 the key is wrong, or the signature has timed out).
31012
31013 A non-prvs-signed address is not rejected by the second statement, because the
31014 &%prvscheck%& expansion yields an empty string if its first argument is not a
31015 prvs-signed address, thus causing the &%condition%& condition to be false. If
31016 the first argument is a syntactically valid prvs-signed address, the yield is
31017 the third string (in this case &"1"&), whether or not the cryptographic and
31018 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31019 of the checks (empty for failure, &"1"& for success).
31020
31021 There is one more issue you must consider when implementing prvs-signing:
31022 you have to ensure that the routers accept prvs-signed addresses and
31023 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31024 router to remove the signature with a configuration along these lines:
31025 .code
31026 batv_redirect:
31027   driver = redirect
31028   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31029 .endd
31030 This works because, if the third argument of &%prvscheck%& is empty, the result
31031 of the expansion of a prvs-signed address is the decoded value of the original
31032 address. This router should probably be the first of your routers that handles
31033 local addresses.
31034
31035 To create BATV-signed addresses in the first place, a transport of this form
31036 can be used:
31037 .code
31038 external_smtp_batv:
31039   driver = smtp
31040   return_path = ${prvs {$return_path} \
31041                        {${lookup mysql{SELECT \
31042                        secret FROM batv_prvs WHERE \
31043                        sender='${quote_mysql:$sender_address}'} \
31044                        {$value}fail}}}
31045 .endd
31046 If no key can be found for the existing return path, no signing takes place.
31047
31048
31049
31050 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31051 .cindex "&ACL;" "relay control"
31052 .cindex "relaying" "control by ACL"
31053 .cindex "policy control" "relay control"
31054 An MTA is said to &'relay'& a message if it receives it from some host and
31055 delivers it directly to another host as a result of a remote address contained
31056 within it. Redirecting a local address via an alias or forward file and then
31057 passing the message on to another host is not relaying,
31058 .cindex "&""percent hack""&"
31059 but a redirection as a result of the &"percent hack"& is.
31060
31061 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31062 A host which is acting as a gateway or an MX backup is concerned with incoming
31063 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31064 a host which is acting as a smart host for a number of clients is concerned
31065 with outgoing relaying from those clients to the Internet at large. Often the
31066 same host is fulfilling both functions,
31067 . ///
31068 . as illustrated in the diagram below,
31069 . ///
31070 but in principle these two kinds of relaying are entirely independent. What is
31071 not wanted is the transmission of mail from arbitrary remote hosts through your
31072 system to arbitrary domains.
31073
31074
31075 You can implement relay control by means of suitable statements in the ACL that
31076 runs for each RCPT command. For convenience, it is often easiest to use
31077 Exim's named list facility to define the domains and hosts involved. For
31078 example, suppose you want to do the following:
31079
31080 .ilist
31081 Deliver a number of domains to mailboxes on the local host (or process them
31082 locally in some other way). Let's say these are &'my.dom1.example'& and
31083 &'my.dom2.example'&.
31084 .next
31085 Relay mail for a number of other domains for which you are the secondary MX.
31086 These might be &'friend1.example'& and &'friend2.example'&.
31087 .next
31088 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31089 Suppose your LAN is 192.168.45.0/24.
31090 .endlist
31091
31092
31093 In the main part of the configuration, you put the following definitions:
31094 .code
31095 domainlist local_domains    = my.dom1.example : my.dom2.example
31096 domainlist relay_to_domains = friend1.example : friend2.example
31097 hostlist   relay_from_hosts = 192.168.45.0/24
31098 .endd
31099 Now you can use these definitions in the ACL that is run for every RCPT
31100 command:
31101 .code
31102 acl_check_rcpt:
31103   accept domains = +local_domains : +relay_to_domains
31104   accept hosts   = +relay_from_hosts
31105 .endd
31106 The first statement accepts any RCPT command that contains an address in
31107 the local or relay domains. For any other domain, control passes to the second
31108 statement, which accepts the command only if it comes from one of the relay
31109 hosts. In practice, you will probably want to make your ACL more sophisticated
31110 than this, for example, by including sender and recipient verification. The
31111 default configuration includes a more comprehensive example, which is described
31112 in chapter &<<CHAPdefconfil>>&.
31113
31114
31115
31116 .section "Checking a relay configuration" "SECTcheralcon"
31117 .cindex "relaying" "checking control of"
31118 You can check the relay characteristics of your configuration in the same way
31119 that you can test any ACL behaviour for an incoming SMTP connection, by using
31120 the &%-bh%& option to run a fake SMTP session with which you interact.
31121 .ecindex IIDacl
31122
31123
31124
31125 . ////////////////////////////////////////////////////////////////////////////
31126 . ////////////////////////////////////////////////////////////////////////////
31127
31128 .chapter "Content scanning at ACL time" "CHAPexiscan"
31129 .scindex IIDcosca "content scanning" "at ACL time"
31130 The extension of Exim to include content scanning at ACL time, formerly known
31131 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31132 was integrated into the main source for Exim release 4.50, and Tom continues to
31133 maintain it. Most of the wording of this chapter is taken from Tom's
31134 specification.
31135
31136 It is also possible to scan the content of messages at other times. The
31137 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31138 scanning after all the ACLs have run. A transport filter can be used to scan
31139 messages at delivery time (see the &%transport_filter%& option, described in
31140 chapter &<<CHAPtransportgeneric>>&).
31141
31142 If you want to include the ACL-time content-scanning features when you compile
31143 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31144 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31145
31146 .ilist
31147 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31148 for all MIME parts for SMTP and non-SMTP messages, respectively.
31149 .next
31150 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31151 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31152 run at the end of message reception (the &%acl_smtp_data%& ACL).
31153 .next
31154 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31155 of messages, or parts of messages, for debugging purposes.
31156 .next
31157 Additional expansion variables that are set in the new ACL and by the new
31158 conditions.
31159 .next
31160 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31161 .endlist
31162
31163 Content-scanning is continually evolving, and new features are still being
31164 added. While such features are still unstable and liable to incompatible
31165 changes, they are made available in Exim by setting options whose names begin
31166 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31167 this manual. You can find out about them by reading the file called
31168 &_doc/experimental.txt_&.
31169
31170 All the content-scanning facilities work on a MBOX copy of the message that is
31171 temporarily created in a file called:
31172 .display
31173 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31174 .endd
31175 The &_.eml_& extension is a friendly hint to virus scanners that they can
31176 expect an MBOX-like structure inside that file. The file is created when the
31177 first content scanning facility is called. Subsequent calls to content
31178 scanning conditions open the same file again. The directory is recursively
31179 removed when the &%acl_smtp_data%& ACL has finished running, unless
31180 .code
31181 control = no_mbox_unspool
31182 .endd
31183 has been encountered. When the MIME ACL decodes files, they are put into the
31184 same directory by default.
31185
31186
31187
31188 .section "Scanning for viruses" "SECTscanvirus"
31189 .cindex "virus scanning"
31190 .cindex "content scanning" "for viruses"
31191 .cindex "content scanning" "the &%malware%& condition"
31192 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31193 It supports a &"generic"& interface to scanners called via the shell, and
31194 specialized interfaces for &"daemon"& type virus scanners, which are resident
31195 in memory and thus are much faster.
31196
31197 A timeout of 2 minutes is applied to a scanner call (by default);
31198 if it expires then a defer action is taken.
31199
31200 .oindex "&%av_scanner%&"
31201 You can set the &%av_scanner%& option in the main part of the configuration
31202 to specify which scanner to use, together with any additional options that
31203 are needed. The basic syntax is as follows:
31204 .display
31205 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31206 .endd
31207 If you do not set &%av_scanner%&, it defaults to
31208 .code
31209 av_scanner = sophie:/var/run/sophie
31210 .endd
31211 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31212 before use.
31213 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31214 The following scanner types are supported in this release:
31215
31216 .vlist
31217 .vitem &%avast%&
31218 .cindex "virus scanners" "avast"
31219 This is the scanner daemon of Avast. It has been tested with Avast Core
31220 Security (currently at version 1.1.7).
31221 You can get a trial version at &url(http://www.avast.com) or for Linux
31222 at &url(http://www.avast.com/linux-server-antivirus).
31223 This scanner type takes one option,
31224 which can be either a full path to a UNIX socket,
31225 or host and port specifiers separated by white space.
31226 The host may be a name or an IP address; the port is either a
31227 single number or a pair of numbers with a dash between.
31228 Any further options are given, on separate lines,
31229 to the daemon as options before the main scan command.
31230 For example:
31231 .code
31232 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31233 av_scanner = avast:192.168.2.22 5036
31234 .endd
31235 If you omit the argument, the default path
31236 &_/var/run/avast/scan.sock_&
31237 is used.
31238 If you use a remote host,
31239 you need to make Exim's spool directory available to it,
31240 as the scanner is passed a file path, not file contents.
31241 For information about available commands and their options you may use
31242 .code
31243 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31244     FLAGS
31245     SENSITIVITY
31246     PACK
31247 .endd
31248
31249
31250 .vitem &%aveserver%&
31251 .cindex "virus scanners" "Kaspersky"
31252 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31253 at &url(http://www.kaspersky.com). This scanner type takes one option,
31254 which is the path to the daemon's UNIX socket. The default is shown in this
31255 example:
31256 .code
31257 av_scanner = aveserver:/var/run/aveserver
31258 .endd
31259
31260
31261 .vitem &%clamd%&
31262 .cindex "virus scanners" "clamd"
31263 This daemon-type scanner is GPL and free. You can get it at
31264 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31265 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31266 in the MIME ACL. This is no longer believed to be necessary.
31267
31268 The options are a list of server specifiers, which may be
31269 a UNIX socket specification,
31270 a TCP socket specification,
31271 or a (global) option.
31272
31273 A socket specification consists of a space-separated list.
31274 For a Unix socket the first element is a full path for the socket,
31275 for a TCP socket the first element is the IP address
31276 and the second a port number,
31277 Any further elements are per-server (non-global) options.
31278 These per-server options are supported:
31279 .code
31280 retry=<timespec>        Retry on connect fail
31281 .endd
31282
31283 The &`retry`& option specifies a time after which a single retry for
31284 a failed connect is made.  The default is to not retry.
31285
31286 If a Unix socket file is specified, only one server is supported.
31287
31288 Examples:
31289 .code
31290 av_scanner = clamd:/opt/clamd/socket
31291 av_scanner = clamd:192.0.2.3 1234
31292 av_scanner = clamd:192.0.2.3 1234:local
31293 av_scanner = clamd:192.0.2.3 1234 retry=10s
31294 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31295 .endd
31296 If the value of av_scanner points to a UNIX socket file or contains the
31297 &`local`&
31298 option, then the ClamAV interface will pass a filename containing the data
31299 to be scanned, which will should normally result in less I/O happening and be
31300 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31301 Exim does not assume that there is a common filesystem with the remote host.
31302 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31303 you be running a version of ClamAV prior to 0.95.
31304
31305 The final example shows that multiple TCP targets can be specified.  Exim will
31306 randomly use one for each incoming email (i.e. it load balances them).  Note
31307 that only TCP targets may be used if specifying a list of scanners; a UNIX
31308 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31309 unavailable, Exim will try the remaining one(s) until it finds one that works.
31310 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31311 not keep track of scanner state between multiple messages, and the scanner
31312 selection is random, so the message will get logged in the mainlog for each
31313 email that the down scanner gets chosen first (message wrapped to be readable):
31314 .code
31315 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31316    clamd: connection to localhost, port 3310 failed
31317    (Connection refused)
31318 .endd
31319
31320 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31321 contributing the code for this scanner.
31322
31323 .vitem &%cmdline%&
31324 .cindex "virus scanners" "command line interface"
31325 This is the keyword for the generic command line scanner interface. It can be
31326 used to attach virus scanners that are invoked from the shell. This scanner
31327 type takes 3 mandatory options:
31328
31329 .olist
31330 The full path and name of the scanner binary, with all command line options,
31331 and a placeholder (&`%s`&) for the directory to scan.
31332
31333 .next
31334 A regular expression to match against the STDOUT and STDERR output of the
31335 virus scanner. If the expression matches, a virus was found. You must make
31336 absolutely sure that this expression matches on &"virus found"&. This is called
31337 the &"trigger"& expression.
31338
31339 .next
31340 Another regular expression, containing exactly one pair of parentheses, to
31341 match the name of the virus found in the scanners output. This is called the
31342 &"name"& expression.
31343 .endlist olist
31344
31345 For example, Sophos Sweep reports a virus on a line like this:
31346 .code
31347 Virus 'W32/Magistr-B' found in file ./those.bat
31348 .endd
31349 For the trigger expression, we can match the phrase &"found in file"&. For the
31350 name expression, we want to extract the W32/Magistr-B string, so we can match
31351 for the single quotes left and right of it. Altogether, this makes the
31352 configuration setting:
31353 .code
31354 av_scanner = cmdline:\
31355              /path/to/sweep -ss -all -rec -archive %s:\
31356              found in file:'(.+)'
31357 .endd
31358 .vitem &%drweb%&
31359 .cindex "virus scanners" "DrWeb"
31360 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31361 takes one option,
31362 either a full path to a UNIX socket,
31363 or host and port specifiers separated by white space.
31364 The host may be a name or an IP address; the port is either a
31365 single number or a pair of numbers with a dash between.
31366 For example:
31367 .code
31368 av_scanner = drweb:/var/run/drwebd.sock
31369 av_scanner = drweb:192.168.2.20 31337
31370 .endd
31371 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31372 is used. Thanks to Alex Miller for contributing the code for this scanner.
31373
31374 .vitem &%f-protd%&
31375 .cindex "virus scanners" "f-protd"
31376 The f-protd scanner is accessed via HTTP over TCP.
31377 One argument is taken, being a space-separated hostname and port number
31378 (or port-range).
31379 For example:
31380 .code
31381 av_scanner = f-protd:localhost 10200-10204
31382 .endd
31383 If you omit the argument, the default values show above are used.
31384
31385 .vitem &%fsecure%&
31386 .cindex "virus scanners" "F-Secure"
31387 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31388 argument which is the path to a UNIX socket. For example:
31389 .code
31390 av_scanner = fsecure:/path/to/.fsav
31391 .endd
31392 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31393 Thelmen for contributing the code for this scanner.
31394
31395 .vitem &%kavdaemon%&
31396 .cindex "virus scanners" "Kaspersky"
31397 This is the scanner daemon of Kaspersky Version 4. This version of the
31398 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31399 scanner type takes one option, which is the path to the daemon's UNIX socket.
31400 For example:
31401 .code
31402 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31403 .endd
31404 The default path is &_/var/run/AvpCtl_&.
31405
31406 .vitem &%mksd%&
31407 .cindex "virus scanners" "mksd"
31408 This is a daemon type scanner that is aimed mainly at Polish users, though some
31409 parts of documentation are now available in English. You can get it at
31410 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31411 the maximum number of processes used simultaneously to scan the attachments,
31412 provided that mksd has
31413 been run with at least the same number of child processes. For example:
31414 .code
31415 av_scanner = mksd:2
31416 .endd
31417 You can safely omit this option (the default value is 1).
31418
31419 .vitem &%sock%&
31420 .cindex "virus scanners" "simple socket-connected"
31421 This is a general-purpose way of talking to simple scanner daemons
31422 running on the local machine.
31423 There are four options:
31424 an address (which may be an IP address and port, or the path of a Unix socket),
31425 a commandline to send (may include a single %s which will be replaced with
31426 the path to the mail file to be scanned),
31427 an RE to trigger on from the returned data,
31428 an RE to extract malware_name from the returned data.
31429 For example:
31430 .code
31431 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31432 .endd
31433 Default for the socket specifier is &_/tmp/malware.sock_&.
31434 Default for the commandline is &_%s\n_&.
31435 Both regular-expressions are required.
31436
31437 .vitem &%sophie%&
31438 .cindex "virus scanners" "Sophos and Sophie"
31439 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31440 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31441 for this scanner type is the path to the UNIX socket that Sophie uses for
31442 client communication. For example:
31443 .code
31444 av_scanner = sophie:/tmp/sophie
31445 .endd
31446 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31447 the option.
31448 .endlist
31449
31450 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31451 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31452 ACL.
31453
31454 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31455 makes it possible to use different scanners. See further below for an example.
31456 The &%malware%& condition caches its results, so when you use it multiple times
31457 for the same message, the actual scanning process is only carried out once.
31458 However, using expandable items in &%av_scanner%& disables this caching, in
31459 which case each use of the &%malware%& condition causes a new scan of the
31460 message.
31461
31462 The &%malware%& condition takes a right-hand argument that is expanded before
31463 use and taken as a list, slash-separated by default.
31464 The first element can then be one of
31465
31466 .ilist
31467 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31468 The condition succeeds if a virus was found, and fail otherwise. This is the
31469 recommended usage.
31470 .next
31471 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31472 the condition fails immediately.
31473 .next
31474 A regular expression, in which case the message is scanned for viruses. The
31475 condition succeeds if a virus is found and its name matches the regular
31476 expression. This allows you to take special actions on certain types of virus.
31477 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31478 unless the separator is changed (in the usual way).
31479 .endlist
31480
31481 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31482 messages even if there is a problem with the virus scanner.
31483 Otherwise, such a problem causes the ACL to defer.
31484
31485 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31486 specify a non-default timeout.  The default is two minutes.
31487 For example:
31488 .code
31489 malware = * / defer_ok / tmo=10s
31490 .endd
31491 A timeout causes the ACL to defer.
31492
31493 .vindex "&$callout_address$&"
31494 When a connection is made to the scanner the expansion variable &$callout_address$&
31495 is set to record the actual address used.
31496
31497 .vindex "&$malware_name$&"
31498 When a virus is found, the condition sets up an expansion variable called
31499 &$malware_name$& that contains the name of the virus. You can use it in a
31500 &%message%& modifier that specifies the error returned to the sender, and/or in
31501 logging data.
31502
31503 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31504 imposed by your anti-virus scanner.
31505
31506 Here is a very simple scanning example:
31507 .code
31508 deny message = This message contains malware ($malware_name)
31509      malware = *
31510 .endd
31511 The next example accepts messages when there is a problem with the scanner:
31512 .code
31513 deny message = This message contains malware ($malware_name)
31514      malware = */defer_ok
31515 .endd
31516 The next example shows how to use an ACL variable to scan with both sophie and
31517 aveserver. It assumes you have set:
31518 .code
31519 av_scanner = $acl_m0
31520 .endd
31521 in the main Exim configuration.
31522 .code
31523 deny message = This message contains malware ($malware_name)
31524      set acl_m0 = sophie
31525      malware = *
31526
31527 deny message = This message contains malware ($malware_name)
31528      set acl_m0 = aveserver
31529      malware = *
31530 .endd
31531
31532
31533 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31534 .cindex "content scanning" "for spam"
31535 .cindex "spam scanning"
31536 .cindex "SpamAssassin"
31537 .cindex "Rspamd"
31538 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31539 score and a report for the message.
31540 Support is also provided for Rspamd.
31541
31542 For more information about installation and configuration of SpamAssassin or
31543 Rspamd refer to their respective websites at
31544 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31545
31546 SpamAssassin can be installed with CPAN by running:
31547 .code
31548 perl -MCPAN -e 'install Mail::SpamAssassin'
31549 .endd
31550 SpamAssassin has its own set of configuration files. Please review its
31551 documentation to see how you can tweak it. The default installation should work
31552 nicely, however.
31553
31554 .oindex "&%spamd_address%&"
31555 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31556 intend to use an instance running on the local host you do not need to set
31557 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31558 you must set the &%spamd_address%& option in the global part of the Exim
31559 configuration as follows (example):
31560 .code
31561 spamd_address = 192.168.99.45 387
31562 .endd
31563
31564 To use Rspamd (which by default listens on all local addresses
31565 on TCP port 11333)
31566 you should add &%variant=rspamd%& after the address/port pair, for example:
31567 .code
31568 spamd_address = 127.0.0.1 11333 variant=rspamd
31569 .endd
31570
31571 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31572 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31573 file name instead of an address/port pair:
31574 .code
31575 spamd_address = /var/run/spamd_socket
31576 .endd
31577 You can have multiple &%spamd%& servers to improve scalability. These can
31578 reside on other hardware reachable over the network. To specify multiple
31579 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31580 option, separated with colons (the separator can be changed in the usual way):
31581 .code
31582 spamd_address = 192.168.2.10 783 : \
31583                 192.168.2.11 783 : \
31584                 192.168.2.12 783
31585 .endd
31586 Up to 32 &%spamd%& servers are supported.
31587 When a server fails to respond to the connection attempt, all other
31588 servers are tried until one succeeds. If no server responds, the &%spam%&
31589 condition defers.
31590
31591 Unix and TCP socket specifications may be mixed in any order.
31592 Each element of the list is a list itself, space-separated by default
31593 and changeable in the usual way; take care to not double the separator.
31594
31595 For TCP socket specifications a host name or IP (v4 or v6, but
31596 subject to list-separator quoting rules) address can be used,
31597 and the port can be one or a dash-separated pair.
31598 In the latter case, the range is tried in strict order.
31599
31600 Elements after the first for Unix sockets, or second for TCP socket,
31601 are options.
31602 The supported options are:
31603 .code
31604 pri=<priority>      Selection priority
31605 weight=<value>      Selection bias
31606 time=<start>-<end>  Use only between these times of day
31607 retry=<timespec>    Retry on connect fail
31608 tmo=<timespec>      Connection time limit
31609 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31610 .endd
31611
31612 The &`pri`& option specifies a priority for the server within the list,
31613 higher values being tried first.
31614 The default priority is 1.
31615
31616 The &`weight`& option specifies a selection bias.
31617 Within a priority set
31618 servers are queried in a random fashion, weighted by this value.
31619 The default value for selection bias is 1.
31620
31621 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31622 in the local time zone; each element being one or more digits.
31623 Either the seconds or both minutes and seconds, plus the leading &`.`&
31624 characters, may be omitted and will be taken as zero.
31625
31626 Timeout specifications for the &`retry`& and &`tmo`& options
31627 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31628
31629 The &`tmo`& option specifies an overall timeout for communication.
31630 The default value is two minutes.
31631
31632 The &`retry`& option specifies a time after which a single retry for
31633 a failed connect is made.
31634 The default is to not retry.
31635
31636 The &%spamd_address%& variable is expanded before use if it starts with
31637 a dollar sign. In this case, the expansion may return a string that is
31638 used as the list so that multiple spamd servers can be the result of an
31639 expansion.
31640
31641 .vindex "&$callout_address$&"
31642 When a connection is made to the server the expansion variable &$callout_address$&
31643 is set to record the actual address used.
31644
31645 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31646 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31647 .code
31648 deny message = This message was classified as SPAM
31649      spam = joe
31650 .endd
31651 The right-hand side of the &%spam%& condition specifies a name. This is
31652 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31653 to scan using a specific profile, but rather use the SpamAssassin system-wide
31654 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31655 Rspamd does not use this setting. However, you must put something on the
31656 right-hand side.
31657
31658 The name allows you to use per-domain or per-user antispam profiles in
31659 principle, but this is not straightforward in practice, because a message may
31660 have multiple recipients, not necessarily all in the same domain. Because the
31661 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31662 read the contents of the message, the variables &$local_part$& and &$domain$&
31663 are not set.
31664 Careful enforcement of single-recipient messages
31665 (e.g. by responding with defer in the recipient ACL for all recipients
31666 after the first),
31667 or the use of PRDR,
31668 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31669 are needed to use this feature.
31670
31671 The right-hand side of the &%spam%& condition is expanded before being used, so
31672 you can put lookups or conditions there. When the right-hand side evaluates to
31673 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31674
31675
31676 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31677 large ones may cause significant performance degradation. As most spam messages
31678 are quite small, it is recommended that you do not scan the big ones. For
31679 example:
31680 .code
31681 deny message = This message was classified as SPAM
31682      condition = ${if < {$message_size}{10K}}
31683      spam = nobody
31684 .endd
31685
31686 The &%spam%& condition returns true if the threshold specified in the user's
31687 SpamAssassin profile has been matched or exceeded. If you want to use the
31688 &%spam%& condition for its side effects (see the variables below), you can make
31689 it always return &"true"& by appending &`:true`& to the username.
31690
31691 .cindex "spam scanning" "returned variables"
31692 When the &%spam%& condition is run, it sets up a number of expansion
31693 variables.
31694 Except for &$spam_report$&,
31695 these variables are saved with the received message so are
31696 available for use at delivery time.
31697
31698 .vlist
31699 .vitem &$spam_score$&
31700 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31701 for inclusion in log or reject messages.
31702
31703 .vitem &$spam_score_int$&
31704 The spam score of the message, multiplied by ten, as an integer value. For
31705 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31706 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31707 The integer value is useful for numeric comparisons in conditions.
31708
31709 .vitem &$spam_bar$&
31710 A string consisting of a number of &"+"& or &"-"& characters, representing the
31711 integer part of the spam score value. A spam score of 4.4 would have a
31712 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31713 headers, since MUAs can match on such strings. The maximum length of the
31714 spam bar is 50 characters.
31715
31716 .vitem &$spam_report$&
31717 A multiline text table, containing the full SpamAssassin report for the
31718 message. Useful for inclusion in headers or reject messages.
31719 This variable is only usable in a DATA-time ACL.
31720 .new
31721 Beware that SpamAssassin may return non-ASCII characters, especially
31722 when running in country-specific locales, which are not legal
31723 unencoded in headers.
31724 .wen
31725
31726 .vitem &$spam_action$&
31727 For SpamAssassin either 'reject' or 'no action' depending on the
31728 spam score versus threshold.
31729 For Rspamd, the recommended action.
31730
31731 .endlist
31732
31733 The &%spam%& condition caches its results unless expansion in
31734 spamd_address was used. If you call it again with the same user name, it
31735 does not scan again, but rather returns the same values as before.
31736
31737 The &%spam%& condition returns DEFER if there is any error while running
31738 the message through SpamAssassin or if the expansion of spamd_address
31739 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31740 statement block), append &`/defer_ok`& to the right-hand side of the
31741 spam condition, like this:
31742 .code
31743 deny message = This message was classified as SPAM
31744      spam    = joe/defer_ok
31745 .endd
31746 This causes messages to be accepted even if there is a problem with &%spamd%&.
31747
31748 Here is a longer, commented example of the use of the &%spam%&
31749 condition:
31750 .code
31751 # put headers in all messages (no matter if spam or not)
31752 warn  spam = nobody:true
31753       add_header = X-Spam-Score: $spam_score ($spam_bar)
31754       add_header = X-Spam-Report: $spam_report
31755
31756 # add second subject line with *SPAM* marker when message
31757 # is over threshold
31758 warn  spam = nobody
31759       add_header = Subject: *SPAM* $h_Subject:
31760
31761 # reject spam at high scores (> 12)
31762 deny  message = This message scored $spam_score spam points.
31763       spam = nobody:true
31764       condition = ${if >{$spam_score_int}{120}{1}{0}}
31765 .endd
31766
31767
31768
31769 .section "Scanning MIME parts" "SECTscanmimepart"
31770 .cindex "content scanning" "MIME parts"
31771 .cindex "MIME content scanning"
31772 .oindex "&%acl_smtp_mime%&"
31773 .oindex "&%acl_not_smtp_mime%&"
31774 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31775 each MIME part of an SMTP message, including multipart types, in the sequence
31776 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31777 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31778 options may both refer to the same ACL if you want the same processing in both
31779 cases.
31780
31781 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31782 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31783 the case of a non-SMTP message. However, a MIME ACL is called only if the
31784 message contains a &'Content-Type:'& header line. When a call to a MIME
31785 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31786 result code is sent to the client. In the case of an SMTP message, the
31787 &%acl_smtp_data%& ACL is not called when this happens.
31788
31789 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31790 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31791 condition to match against the raw MIME part. You can also use the
31792 &%mime_regex%& condition to match against the decoded MIME part (see section
31793 &<<SECTscanregex>>&).
31794
31795 At the start of a MIME ACL, a number of variables are set from the header
31796 information for the relevant MIME part. These are described below. The contents
31797 of the MIME part are not by default decoded into a disk file except for MIME
31798 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31799 part into a disk file, you can use the &%decode%& condition. The general
31800 syntax is:
31801 .display
31802 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31803 .endd
31804 The right hand side is expanded before use. After expansion,
31805 the value can be:
31806
31807 .olist
31808 &"0"& or &"false"&, in which case no decoding is done.
31809 .next
31810 The string &"default"&. In that case, the file is put in the temporary
31811 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31812 a sequential file name consisting of the message id and a sequence number. The
31813 full path and name is available in &$mime_decoded_filename$& after decoding.
31814 .next
31815 A full path name starting with a slash. If the full name is an existing
31816 directory, it is used as a replacement for the default directory. The filename
31817 is then sequentially assigned. If the path does not exist, it is used as
31818 the full path and file name.
31819 .next
31820 If the string does not start with a slash, it is used as the
31821 filename, and the default path is then used.
31822 .endlist
31823 The &%decode%& condition normally succeeds. It is only false for syntax
31824 errors or unusual circumstances such as memory shortages. You can easily decode
31825 a file with its original, proposed filename using
31826 .code
31827 decode = $mime_filename
31828 .endd
31829 However, you should keep in mind that &$mime_filename$& might contain
31830 anything. If you place files outside of the default path, they are not
31831 automatically unlinked.
31832
31833 For RFC822 attachments (these are messages attached to messages, with a
31834 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31835 as for the primary message, only that the &$mime_is_rfc822$& expansion
31836 variable is set (see below). Attached messages are always decoded to disk
31837 before being checked, and the files are unlinked once the check is done.
31838
31839 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31840 used to match regular expressions against raw and decoded MIME parts,
31841 respectively. They are described in section &<<SECTscanregex>>&.
31842
31843 .cindex "MIME content scanning" "returned variables"
31844 The following list describes all expansion variables that are
31845 available in the MIME ACL:
31846
31847 .vlist
31848 .vitem &$mime_boundary$&
31849 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31850 have a boundary string, which is stored in this variable. If the current part
31851 has no boundary parameter in the &'Content-Type:'& header, this variable
31852 contains the empty string.
31853
31854 .vitem &$mime_charset$&
31855 This variable contains the character set identifier, if one was found in the
31856 &'Content-Type:'& header. Examples for charset identifiers are:
31857 .code
31858 us-ascii
31859 gb2312 (Chinese)
31860 iso-8859-1
31861 .endd
31862 Please note that this value is not normalized, so you should do matches
31863 case-insensitively.
31864
31865 .vitem &$mime_content_description$&
31866 This variable contains the normalized content of the &'Content-Description:'&
31867 header. It can contain a human-readable description of the parts content. Some
31868 implementations repeat the filename for attachments here, but they are usually
31869 only used for display purposes.
31870
31871 .vitem &$mime_content_disposition$&
31872 This variable contains the normalized content of the &'Content-Disposition:'&
31873 header. You can expect strings like &"attachment"& or &"inline"& here.
31874
31875 .vitem &$mime_content_id$&
31876 This variable contains the normalized content of the &'Content-ID:'& header.
31877 This is a unique ID that can be used to reference a part from another part.
31878
31879 .vitem &$mime_content_size$&
31880 This variable is set only after the &%decode%& modifier (see above) has been
31881 successfully run. It contains the size of the decoded part in kilobytes. The
31882 size is always rounded up to full kilobytes, so only a completely empty part
31883 has a &$mime_content_size$& of zero.
31884
31885 .vitem &$mime_content_transfer_encoding$&
31886 This variable contains the normalized content of the
31887 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31888 type. Typical values are &"base64"& and &"quoted-printable"&.
31889
31890 .vitem &$mime_content_type$&
31891 If the MIME part has a &'Content-Type:'& header, this variable contains its
31892 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31893 are some examples of popular MIME types, as they may appear in this variable:
31894 .code
31895 text/plain
31896 text/html
31897 application/octet-stream
31898 image/jpeg
31899 audio/midi
31900 .endd
31901 If the MIME part has no &'Content-Type:'& header, this variable contains the
31902 empty string.
31903
31904 .vitem &$mime_decoded_filename$&
31905 This variable is set only after the &%decode%& modifier (see above) has been
31906 successfully run. It contains the full path and file name of the file
31907 containing the decoded data.
31908 .endlist
31909
31910 .cindex "RFC 2047"
31911 .vlist
31912 .vitem &$mime_filename$&
31913 This is perhaps the most important of the MIME variables. It contains a
31914 proposed filename for an attachment, if one was found in either the
31915 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31916 RFC2047
31917 or RFC2231
31918 decoded, but no additional sanity checks are done.
31919  If no filename was
31920 found, this variable contains the empty string.
31921
31922 .vitem &$mime_is_coverletter$&
31923 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31924 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31925 content in the cover letter, while not restricting attachments at all.
31926
31927 The variable contains 1 (true) for a MIME part believed to be part of the
31928 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31929 follows:
31930
31931 .olist
31932 The outermost MIME part of a message is always a cover letter.
31933
31934 .next
31935 If a multipart/alternative or multipart/related MIME part is a cover letter,
31936 so are all MIME subparts within that multipart.
31937
31938 .next
31939 If any other multipart is a cover letter, the first subpart is a cover letter,
31940 and the rest are attachments.
31941
31942 .next
31943 All parts contained within an attachment multipart are attachments.
31944 .endlist olist
31945
31946 As an example, the following will ban &"HTML mail"& (including that sent with
31947 alternative plain text), while allowing HTML files to be attached. HTML
31948 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31949 .code
31950 deny message = HTML mail is not accepted here
31951 !condition = $mime_is_rfc822
31952 condition = $mime_is_coverletter
31953 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31954 .endd
31955 .vitem &$mime_is_multipart$&
31956 This variable has the value 1 (true) when the current part has the main type
31957 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31958 Since multipart entities only serve as containers for other parts, you may not
31959 want to carry out specific actions on them.
31960
31961 .vitem &$mime_is_rfc822$&
31962 This variable has the value 1 (true) if the current part is not a part of the
31963 checked message itself, but part of an attached message. Attached message
31964 decoding is fully recursive.
31965
31966 .vitem &$mime_part_count$&
31967 This variable is a counter that is raised for each processed MIME part. It
31968 starts at zero for the very first part (which is usually a multipart). The
31969 counter is per-message, so it is reset when processing RFC822 attachments (see
31970 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31971 complete, so you can use it in the DATA ACL to determine the number of MIME
31972 parts of a message. For non-MIME messages, this variable contains the value -1.
31973 .endlist
31974
31975
31976
31977 .section "Scanning with regular expressions" "SECTscanregex"
31978 .cindex "content scanning" "with regular expressions"
31979 .cindex "regular expressions" "content scanning with"
31980 You can specify your own custom regular expression matches on the full body of
31981 the message, or on individual MIME parts.
31982
31983 The &%regex%& condition takes one or more regular expressions as arguments and
31984 matches them against the full message (when called in the DATA ACL) or a raw
31985 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31986 linewise, with a maximum line length of 32K characters. That means you cannot
31987 have multiline matches with the &%regex%& condition.
31988
31989 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31990 to 32K of decoded content (the whole content at once, not linewise). If the
31991 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31992 is decoded automatically when &%mime_regex%& is executed (using default path
31993 and filename values). If the decoded data is larger than  32K, only the first
31994 32K characters are checked.
31995
31996 The regular expressions are passed as a colon-separated list. To include a
31997 literal colon, you must double it. Since the whole right-hand side string is
31998 expanded before being used, you must also escape dollar signs and backslashes
31999 with more backslashes, or use the &`\N`& facility to disable expansion.
32000 Here is a simple example that contains two regular expressions:
32001 .code
32002 deny message = contains blacklisted regex ($regex_match_string)
32003      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32004 .endd
32005 The conditions returns true if any one of the regular expressions matches. The
32006 &$regex_match_string$& expansion variable is then set up and contains the
32007 matching regular expression.
32008 The expansion variables &$regex1$& &$regex2$& etc
32009 are set to any substrings captured by the regular expression.
32010
32011 &*Warning*&: With large messages, these conditions can be fairly
32012 CPU-intensive.
32013
32014 .ecindex IIDcosca
32015
32016
32017
32018
32019 . ////////////////////////////////////////////////////////////////////////////
32020 . ////////////////////////////////////////////////////////////////////////////
32021
32022 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32023          "Local scan function"
32024 .scindex IIDlosca "&[local_scan()]& function" "description of"
32025 .cindex "customizing" "input scan using C function"
32026 .cindex "policy control" "by local scan function"
32027 In these days of email worms, viruses, and ever-increasing spam, some sites
32028 want to apply a lot of checking to messages before accepting them.
32029
32030 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32031 passing messages to external virus and spam scanning software. You can also do
32032 a certain amount in Exim itself through string expansions and the &%condition%&
32033 condition in the ACL that runs after the SMTP DATA command or the ACL for
32034 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32035
32036 To allow for further customization to a site's own requirements, there is the
32037 possibility of linking Exim with a private message scanning function, written
32038 in C. If you want to run code that is written in something other than C, you
32039 can of course use a little C stub to call it.
32040
32041 The local scan function is run once for every incoming message, at the point
32042 when Exim is just about to accept the message.
32043 It can therefore be used to control non-SMTP messages from local processes as
32044 well as messages arriving via SMTP.
32045
32046 Exim applies a timeout to calls of the local scan function, and there is an
32047 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32048 Zero means &"no timeout"&.
32049 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32050 before calling the local scan function, so that the most common types of crash
32051 are caught. If the timeout is exceeded or one of those signals is caught, the
32052 incoming message is rejected with a temporary error if it is an SMTP message.
32053 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32054 code. The incident is logged on the main and reject logs.
32055
32056
32057
32058 .section "Building Exim to use a local scan function" "SECID207"
32059 .cindex "&[local_scan()]& function" "building Exim to use"
32060 To make use of the local scan function feature, you must tell Exim where your
32061 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32062 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32063 directory, so you might set
32064 .code
32065 LOCAL_SCAN_SOURCE=Local/local_scan.c
32066 .endd
32067 for example. The function must be called &[local_scan()]&. It is called by
32068 Exim after it has received a message, when the success return code is about to
32069 be sent. This is after all the ACLs have been run. The return code from your
32070 function controls whether the message is actually accepted or not. There is a
32071 commented template function (that just accepts the message) in the file
32072 _src/local_scan.c_.
32073
32074 If you want to make use of Exim's run time configuration file to set options
32075 for your &[local_scan()]& function, you must also set
32076 .code
32077 LOCAL_SCAN_HAS_OPTIONS=yes
32078 .endd
32079 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32080
32081
32082
32083
32084 .section "API for local_scan()" "SECTapiforloc"
32085 .cindex "&[local_scan()]& function" "API description"
32086 You must include this line near the start of your code:
32087 .code
32088 #include "local_scan.h"
32089 .endd
32090 This header file defines a number of variables and other values, and the
32091 prototype for the function itself. Exim is coded to use unsigned char values
32092 almost exclusively, and one of the things this header defines is a shorthand
32093 for &`unsigned char`& called &`uschar`&.
32094 It also contains the following macro definitions, to simplify casting character
32095 strings and pointers to character strings:
32096 .code
32097 #define CS   (char *)
32098 #define CCS  (const char *)
32099 #define CSS  (char **)
32100 #define US   (unsigned char *)
32101 #define CUS  (const unsigned char *)
32102 #define USS  (unsigned char **)
32103 .endd
32104 The function prototype for &[local_scan()]& is:
32105 .code
32106 extern int local_scan(int fd, uschar **return_text);
32107 .endd
32108 The arguments are as follows:
32109
32110 .ilist
32111 &%fd%& is a file descriptor for the file that contains the body of the message
32112 (the -D file). The file is open for reading and writing, but updating it is not
32113 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32114
32115 The descriptor is positioned at character 19 of the file, which is the first
32116 character of the body itself, because the first 19 characters are the message
32117 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32118 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32119 case this changes in some future version.
32120 .next
32121 &%return_text%& is an address which you can use to return a pointer to a text
32122 string at the end of the function. The value it points to on entry is NULL.
32123 .endlist
32124
32125 The function must return an &%int%& value which is one of the following macros:
32126
32127 .vlist
32128 .vitem &`LOCAL_SCAN_ACCEPT`&
32129 .vindex "&$local_scan_data$&"
32130 The message is accepted. If you pass back a string of text, it is saved with
32131 the message, and made available in the variable &$local_scan_data$&. No
32132 newlines are permitted (if there are any, they are turned into spaces) and the
32133 maximum length of text is 1000 characters.
32134
32135 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32136 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32137 queued without immediate delivery, and is frozen.
32138
32139 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32140 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32141 queued without immediate delivery.
32142
32143 .vitem &`LOCAL_SCAN_REJECT`&
32144 The message is rejected; the returned text is used as an error message which is
32145 passed back to the sender and which is also logged. Newlines are permitted &--
32146 they cause a multiline response for SMTP rejections, but are converted to
32147 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32148 used.
32149
32150 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32151 The message is temporarily rejected; the returned text is used as an error
32152 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32153 problem"& is used.
32154
32155 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32156 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32157 message is not written to the reject log. It has the effect of unsetting the
32158 &%rejected_header%& log selector for just this rejection. If
32159 &%rejected_header%& is already unset (see the discussion of the
32160 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32161 same as LOCAL_SCAN_REJECT.
32162
32163 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32164 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32165 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32166 .endlist
32167
32168 If the message is not being received by interactive SMTP, rejections are
32169 reported by writing to &%stderr%& or by sending an email, as configured by the
32170 &%-oe%& command line options.
32171
32172
32173
32174 .section "Configuration options for local_scan()" "SECTconoptloc"
32175 .cindex "&[local_scan()]& function" "configuration options"
32176 It is possible to have option settings in the main configuration file
32177 that set values in static variables in the &[local_scan()]& module. If you
32178 want to do this, you must have the line
32179 .code
32180 LOCAL_SCAN_HAS_OPTIONS=yes
32181 .endd
32182 in your &_Local/Makefile_& when you build Exim. (This line is in
32183 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32184 file, you must define static variables to hold the option values, and a table
32185 to define them.
32186
32187 The table must be a vector called &%local_scan_options%&, of type
32188 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32189 and a pointer to the variable that holds the value. The entries must appear in
32190 alphabetical order. Following &%local_scan_options%& you must also define a
32191 variable called &%local_scan_options_count%& that contains the number of
32192 entries in the table. Here is a short example, showing two kinds of option:
32193 .code
32194 static int my_integer_option = 42;
32195 static uschar *my_string_option = US"a default string";
32196
32197 optionlist local_scan_options[] = {
32198   { "my_integer", opt_int,       &my_integer_option },
32199   { "my_string",  opt_stringptr, &my_string_option }
32200 };
32201
32202 int local_scan_options_count =
32203   sizeof(local_scan_options)/sizeof(optionlist);
32204 .endd
32205 The values of the variables can now be changed from Exim's runtime
32206 configuration file by including a local scan section as in this example:
32207 .code
32208 begin local_scan
32209 my_integer = 99
32210 my_string = some string of text...
32211 .endd
32212 The available types of option data are as follows:
32213
32214 .vlist
32215 .vitem &*opt_bool*&
32216 This specifies a boolean (true/false) option. The address should point to a
32217 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32218 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32219 whether such a variable has been set at all, you can initialize it to
32220 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32221 values.)
32222
32223 .vitem &*opt_fixed*&
32224 This specifies a fixed point number, such as is used for load averages.
32225 The address should point to a variable of type &`int`&. The value is stored
32226 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32227
32228 .vitem &*opt_int*&
32229 This specifies an integer; the address should point to a variable of type
32230 &`int`&. The value may be specified in any of the integer formats accepted by
32231 Exim.
32232
32233 .vitem &*opt_mkint*&
32234 This is the same as &%opt_int%&, except that when such a value is output in a
32235 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32236 printed with the suffix K or M.
32237
32238 .vitem &*opt_octint*&
32239 This also specifies an integer, but the value is always interpreted as an
32240 octal integer, whether or not it starts with the digit zero, and it is
32241 always output in octal.
32242
32243 .vitem &*opt_stringptr*&
32244 This specifies a string value; the address must be a pointer to a
32245 variable that points to a string (for example, of type &`uschar *`&).
32246
32247 .vitem &*opt_time*&
32248 This specifies a time interval value. The address must point to a variable of
32249 type &`int`&. The value that is placed there is a number of seconds.
32250 .endlist
32251
32252 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32253 out the values of all the &[local_scan()]& options.
32254
32255
32256
32257 .section "Available Exim variables" "SECID208"
32258 .cindex "&[local_scan()]& function" "available Exim variables"
32259 The header &_local_scan.h_& gives you access to a number of C variables. These
32260 are the only ones that are guaranteed to be maintained from release to release.
32261 Note, however, that you can obtain the value of any Exim expansion variable,
32262 including &$recipients$&, by calling &'expand_string()'&. The exported
32263 C variables are as follows:
32264
32265 .vlist
32266 .vitem &*int&~body_linecount*&
32267 This variable contains the number of lines in the message's body.
32268
32269 .vitem &*int&~body_zerocount*&
32270 This variable contains the number of binary zero bytes in the message's body.
32271
32272 .vitem &*unsigned&~int&~debug_selector*&
32273 This variable is set to zero when no debugging is taking place. Otherwise, it
32274 is a bitmap of debugging selectors. Two bits are identified for use in
32275 &[local_scan()]&; they are defined as macros:
32276
32277 .ilist
32278 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32279 testing option that is not privileged &-- any caller may set it. All the
32280 other selector bits can be set only by admin users.
32281
32282 .next
32283 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32284 by the &`+local_scan`& debug selector. It is not included in the default set
32285 of debugging bits.
32286 .endlist ilist
32287
32288 Thus, to write to the debugging output only when &`+local_scan`& has been
32289 selected, you should use code like this:
32290 .code
32291 if ((debug_selector & D_local_scan) != 0)
32292   debug_printf("xxx", ...);
32293 .endd
32294 .vitem &*uschar&~*expand_string_message*&
32295 After a failing call to &'expand_string()'& (returned value NULL), the
32296 variable &%expand_string_message%& contains the error message, zero-terminated.
32297
32298 .vitem &*header_line&~*header_list*&
32299 A pointer to a chain of header lines. The &%header_line%& structure is
32300 discussed below.
32301
32302 .vitem &*header_line&~*header_last*&
32303 A pointer to the last of the header lines.
32304
32305 .vitem &*uschar&~*headers_charset*&
32306 The value of the &%headers_charset%& configuration option.
32307
32308 .vitem &*BOOL&~host_checking*&
32309 This variable is TRUE during a host checking session that is initiated by the
32310 &%-bh%& command line option.
32311
32312 .vitem &*uschar&~*interface_address*&
32313 The IP address of the interface that received the message, as a string. This
32314 is NULL for locally submitted messages.
32315
32316 .vitem &*int&~interface_port*&
32317 The port on which this message was received. When testing with the &%-bh%&
32318 command line option, the value of this variable is -1 unless a port has been
32319 specified via the &%-oMi%& option.
32320
32321 .vitem &*uschar&~*message_id*&
32322 This variable contains Exim's message id for the incoming message (the value of
32323 &$message_exim_id$&) as a zero-terminated string.
32324
32325 .vitem &*uschar&~*received_protocol*&
32326 The name of the protocol by which the message was received.
32327
32328 .vitem &*int&~recipients_count*&
32329 The number of accepted recipients.
32330
32331 .vitem &*recipient_item&~*recipients_list*&
32332 .cindex "recipient" "adding in local scan"
32333 .cindex "recipient" "removing in local scan"
32334 The list of accepted recipients, held in a vector of length
32335 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32336 can add additional recipients by calling &'receive_add_recipient()'& (see
32337 below). You can delete recipients by removing them from the vector and
32338 adjusting the value in &%recipients_count%&. In particular, by setting
32339 &%recipients_count%& to zero you remove all recipients. If you then return the
32340 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32341 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32342 and then call &'receive_add_recipient()'& as often as needed.
32343
32344 .vitem &*uschar&~*sender_address*&
32345 The envelope sender address. For bounce messages this is the empty string.
32346
32347 .vitem &*uschar&~*sender_host_address*&
32348 The IP address of the sending host, as a string. This is NULL for
32349 locally-submitted messages.
32350
32351 .vitem &*uschar&~*sender_host_authenticated*&
32352 The name of the authentication mechanism that was used, or NULL if the message
32353 was not received over an authenticated SMTP connection.
32354
32355 .vitem &*uschar&~*sender_host_name*&
32356 The name of the sending host, if known.
32357
32358 .vitem &*int&~sender_host_port*&
32359 The port on the sending host.
32360
32361 .vitem &*BOOL&~smtp_input*&
32362 This variable is TRUE for all SMTP input, including BSMTP.
32363
32364 .vitem &*BOOL&~smtp_batched_input*&
32365 This variable is TRUE for BSMTP input.
32366
32367 .vitem &*int&~store_pool*&
32368 The contents of this variable control which pool of memory is used for new
32369 requests. See section &<<SECTmemhanloc>>& for details.
32370 .endlist
32371
32372
32373 .section "Structure of header lines" "SECID209"
32374 The &%header_line%& structure contains the members listed below.
32375 You can add additional header lines by calling the &'header_add()'& function
32376 (see below). You can cause header lines to be ignored (deleted) by setting
32377 their type to *.
32378
32379
32380 .vlist
32381 .vitem &*struct&~header_line&~*next*&
32382 A pointer to the next header line, or NULL for the last line.
32383
32384 .vitem &*int&~type*&
32385 A code identifying certain headers that Exim recognizes. The codes are printing
32386 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32387 Notice in particular that any header line whose type is * is not transmitted
32388 with the message. This flagging is used for header lines that have been
32389 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32390 lines.) Effectively, * means &"deleted"&.
32391
32392 .vitem &*int&~slen*&
32393 The number of characters in the header line, including the terminating and any
32394 internal newlines.
32395
32396 .vitem &*uschar&~*text*&
32397 A pointer to the text of the header. It always ends with a newline, followed by
32398 a zero byte. Internal newlines are preserved.
32399 .endlist
32400
32401
32402
32403 .section "Structure of recipient items" "SECID210"
32404 The &%recipient_item%& structure contains these members:
32405
32406 .vlist
32407 .vitem &*uschar&~*address*&
32408 This is a pointer to the recipient address as it was received.
32409
32410 .vitem &*int&~pno*&
32411 This is used in later Exim processing when top level addresses are created by
32412 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32413 and must always contain -1 at this stage.
32414
32415 .vitem &*uschar&~*errors_to*&
32416 If this value is not NULL, bounce messages caused by failing to deliver to the
32417 recipient are sent to the address it contains. In other words, it overrides the
32418 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32419 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32420 an unqualified address, Exim qualifies it using the domain from
32421 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32422 is NULL for all recipients.
32423 .endlist
32424
32425
32426
32427 .section "Available Exim functions" "SECID211"
32428 .cindex "&[local_scan()]& function" "available Exim functions"
32429 The header &_local_scan.h_& gives you access to a number of Exim functions.
32430 These are the only ones that are guaranteed to be maintained from release to
32431 release:
32432
32433 .vlist
32434 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32435        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32436
32437 This function creates a child process that runs the command specified by
32438 &%argv%&. The environment for the process is specified by &%envp%&, which can
32439 be NULL if no environment variables are to be passed. A new umask is supplied
32440 for the process in &%newumask%&.
32441
32442 Pipes to the standard input and output of the new process are set up
32443 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32444 standard error is cloned to the standard output. If there are any file
32445 descriptors &"in the way"& in the new process, they are closed. If the final
32446 argument is TRUE, the new process is made into a process group leader.
32447
32448 The function returns the pid of the new process, or -1 if things go wrong.
32449
32450 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32451 This function waits for a child process to terminate, or for a timeout (in
32452 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32453 return value is as follows:
32454
32455 .ilist
32456 >= 0
32457
32458 The process terminated by a normal exit and the value is the process
32459 ending status.
32460
32461 .next
32462 < 0 and > &--256
32463
32464 The process was terminated by a signal and the value is the negation of the
32465 signal number.
32466
32467 .next
32468 &--256
32469
32470 The process timed out.
32471 .next
32472 &--257
32473
32474 The was some other error in wait(); &%errno%& is still set.
32475 .endlist
32476
32477 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32478 This function provide you with a means of submitting a new message to
32479 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32480 want, but this packages it all up for you.) The function creates a pipe,
32481 forks a subprocess that is running
32482 .code
32483 exim -t -oem -oi -f <>
32484 .endd
32485 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32486 that is connected to the standard input. The yield of the function is the PID
32487 of the subprocess. You can then write a message to the file descriptor, with
32488 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32489
32490 When you have finished, call &'child_close()'& to wait for the process to
32491 finish and to collect its ending status. A timeout value of zero is usually
32492 fine in this circumstance. Unless you have made a mistake with the recipient
32493 addresses, you should get a return code of zero.
32494
32495
32496 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32497        *sender_authentication)*&
32498 This function is a more sophisticated version of &'child_open()'&. The command
32499 that it runs is:
32500 .display
32501 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32502 .endd
32503 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32504
32505
32506 .vitem &*void&~debug_printf(char&~*,&~...)*&
32507 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32508 output is written to the standard error stream. If no debugging is selected,
32509 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32510 conditional on the &`local_scan`& debug selector by coding like this:
32511 .code
32512 if ((debug_selector & D_local_scan) != 0)
32513   debug_printf("xxx", ...);
32514 .endd
32515
32516 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32517 This is an interface to Exim's string expansion code. The return value is the
32518 expanded string, or NULL if there was an expansion failure.
32519 The C variable &%expand_string_message%& contains an error message after an
32520 expansion failure. If expansion does not change the string, the return value is
32521 the pointer to the input string. Otherwise, the return value points to a new
32522 block of memory that was obtained by a call to &'store_get()'&. See section
32523 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32524
32525 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32526 This function allows you to an add additional header line at the end of the
32527 existing ones. The first argument is the type, and should normally be a space
32528 character. The second argument is a format string and any number of
32529 substitution arguments as for &[sprintf()]&. You may include internal newlines
32530 if you want, and you must ensure that the string ends with a newline.
32531
32532 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32533         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32534 This function adds a new header line at a specified point in the header
32535 chain. The header itself is specified as for &'header_add()'&.
32536
32537 If &%name%& is NULL, the new header is added at the end of the chain if
32538 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32539 NULL, the header lines are searched for the first non-deleted header that
32540 matches the name. If one is found, the new header is added before it if
32541 &%after%& is false. If &%after%& is true, the new header is added after the
32542 found header and any adjacent subsequent ones with the same name (even if
32543 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32544 option controls where the header is added. If it is true, addition is at the
32545 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32546 headers, or at the top if there are no &'Received:'& headers, you could use
32547 .code
32548 header_add_at_position(TRUE, US"Received", TRUE,
32549   ' ', "X-xxx: ...");
32550 .endd
32551 Normally, there is always at least one non-deleted &'Received:'& header, but
32552 there may not be if &%received_header_text%& expands to an empty string.
32553
32554
32555 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32556 This function removes header lines. If &%occurrence%& is zero or negative, all
32557 occurrences of the header are removed. If occurrence is greater than zero, that
32558 particular instance of the header is removed. If no header(s) can be found that
32559 match the specification, the function does nothing.
32560
32561
32562 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32563         int&~length,&~BOOL&~notdel)*&"
32564 This function tests whether the given header has the given name. It is not just
32565 a string comparison, because white space is permitted between the name and the
32566 colon. If the &%notdel%& argument is true, a false return is forced for all
32567 &"deleted"& headers; otherwise they are not treated specially. For example:
32568 .code
32569 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32570 .endd
32571 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32572 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32573 This function base64-encodes a string, which is passed by address and length.
32574 The text may contain bytes of any value, including zero. The result is passed
32575 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32576 zero-terminated.
32577
32578 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32579 This function decodes a base64-encoded string. Its arguments are a
32580 zero-terminated base64-encoded string and the address of a variable that is set
32581 to point to the result, which is in dynamic memory. The length of the decoded
32582 string is the yield of the function. If the input is invalid base64 data, the
32583 yield is -1. A zero byte is added to the end of the output string to make it
32584 easy to interpret as a C string (assuming it contains no zeros of its own). The
32585 added zero byte is not included in the returned count.
32586
32587 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32588 This function checks for a match in a domain list. Domains are always
32589 matched caselessly. The return value is one of the following:
32590 .display
32591 &`OK     `& match succeeded
32592 &`FAIL   `& match failed
32593 &`DEFER  `& match deferred
32594 .endd
32595 DEFER is usually caused by some kind of lookup defer, such as the
32596 inability to contact a database.
32597
32598 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32599         BOOL&~caseless)*&"
32600 This function checks for a match in a local part list. The third argument
32601 controls case-sensitivity. The return values are as for
32602 &'lss_match_domain()'&.
32603
32604 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32605         BOOL&~caseless)*&"
32606 This function checks for a match in an address list. The third argument
32607 controls the case-sensitivity of the local part match. The domain is always
32608 matched caselessly. The return values are as for &'lss_match_domain()'&.
32609
32610 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32611         uschar&~*list)*&"
32612 This function checks for a match in a host list. The most common usage is
32613 expected to be
32614 .code
32615 lss_match_host(sender_host_name, sender_host_address, ...)
32616 .endd
32617 .vindex "&$sender_host_address$&"
32618 An empty address field matches an empty item in the host list. If the host name
32619 is NULL, the name corresponding to &$sender_host_address$& is automatically
32620 looked up if a host name is required to match an item in the list. The return
32621 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32622 returns ERROR in the case when it had to look up a host name, but the lookup
32623 failed.
32624
32625 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32626         *format,&~...)*&"
32627 This function writes to Exim's log files. The first argument should be zero (it
32628 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32629 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32630 them. It specifies to which log or logs the message is written. The remaining
32631 arguments are a format and relevant insertion arguments. The string should not
32632 contain any newlines, not even at the end.
32633
32634
32635 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32636 This function adds an additional recipient to the message. The first argument
32637 is the recipient address. If it is unqualified (has no domain), it is qualified
32638 with the &%qualify_recipient%& domain. The second argument must always be -1.
32639
32640 This function does not allow you to specify a private &%errors_to%& address (as
32641 described with the structure of &%recipient_item%& above), because it pre-dates
32642 the addition of that field to the structure. However, it is easy to add such a
32643 value afterwards. For example:
32644 .code
32645  receive_add_recipient(US"monitor@mydom.example", -1);
32646  recipients_list[recipients_count-1].errors_to =
32647    US"postmaster@mydom.example";
32648 .endd
32649
32650 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32651 This is a convenience function to remove a named recipient from the list of
32652 recipients. It returns true if a recipient was removed, and false if no
32653 matching recipient could be found. The argument must be a complete email
32654 address.
32655 .endlist
32656
32657
32658 .cindex "RFC 2047"
32659 .vlist
32660 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32661   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32662 This function decodes strings that are encoded according to RFC 2047. Typically
32663 these are the contents of header lines. First, each &"encoded word"& is decoded
32664 from the Q or B encoding into a byte-string. Then, if provided with the name of
32665 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32666 made  to translate the result to the named character set. If this fails, the
32667 binary string is returned with an error message.
32668
32669 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32670 maximum MIME word length is enforced. The third argument is the target
32671 encoding, or NULL if no translation is wanted.
32672
32673 .cindex "binary zero" "in RFC 2047 decoding"
32674 .cindex "RFC 2047" "binary zero in"
32675 If a binary zero is encountered in the decoded string, it is replaced by the
32676 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32677 not be 0 because header lines are handled as zero-terminated strings.
32678
32679 The function returns the result of processing the string, zero-terminated; if
32680 &%lenptr%& is not NULL, the length of the result is set in the variable to
32681 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32682
32683 If an error is encountered, the function returns NULL and uses the &%error%&
32684 argument to return an error message. The variable pointed to by &%error%& is
32685 set to NULL if there is no error; it may be set non-NULL even when the function
32686 returns a non-NULL value if decoding was successful, but there was a problem
32687 with translation.
32688
32689
32690 .vitem &*int&~smtp_fflush(void)*&
32691 This function is used in conjunction with &'smtp_printf()'&, as described
32692 below.
32693
32694 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32695 The arguments of this function are like &[printf()]&; it writes to the SMTP
32696 output stream. You should use this function only when there is an SMTP output
32697 stream, that is, when the incoming message is being received via interactive
32698 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32699 is FALSE. If you want to test for an incoming message from another host (as
32700 opposed to a local process that used the &%-bs%& command line option), you can
32701 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32702 is involved.
32703
32704 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32705 output function, so it can be used for all forms of SMTP connection.
32706
32707 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32708 must start with an appropriate response code: 550 if you are going to return
32709 LOCAL_SCAN_REJECT, 451 if you are going to return
32710 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32711 initial lines of a multi-line response, the code must be followed by a hyphen
32712 to indicate that the line is not the final response line. You must also ensure
32713 that the lines you write terminate with CRLF. For example:
32714 .code
32715 smtp_printf("550-this is some extra info\r\n");
32716 return LOCAL_SCAN_REJECT;
32717 .endd
32718 Note that you can also create multi-line responses by including newlines in
32719 the data returned via the &%return_text%& argument. The added value of using
32720 &'smtp_printf()'& is that, for instance, you could introduce delays between
32721 multiple output lines.
32722
32723 The &'smtp_printf()'& function does not return any error indication, because it
32724 does not automatically flush pending output, and therefore does not test
32725 the state of the stream. (In the main code of Exim, flushing and error
32726 detection is done when Exim is ready for the next SMTP input command.) If
32727 you want to flush the output and check for an error (for example, the
32728 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32729 arguments. It flushes the output stream, and returns a non-zero value if there
32730 is an error.
32731
32732 .vitem &*void&~*store_get(int)*&
32733 This function accesses Exim's internal store (memory) manager. It gets a new
32734 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32735 runs out of memory. See the next section for a discussion of memory handling.
32736
32737 .vitem &*void&~*store_get_perm(int)*&
32738 This function is like &'store_get()'&, but it always gets memory from the
32739 permanent pool. See the next section for a discussion of memory handling.
32740
32741 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32742 See below.
32743
32744 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32745 See below.
32746
32747 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32748 These three functions create strings using Exim's dynamic memory facilities.
32749 The first makes a copy of an entire string. The second copies up to a maximum
32750 number of characters, indicated by the second argument. The third uses a format
32751 and insertion arguments to create a new string. In each case, the result is a
32752 pointer to a new string in the current memory pool. See the next section for
32753 more discussion.
32754 .endlist
32755
32756
32757
32758 .section "More about Exim's memory handling" "SECTmemhanloc"
32759 .cindex "&[local_scan()]& function" "memory handling"
32760 No function is provided for freeing memory, because that is never needed.
32761 The dynamic memory that Exim uses when receiving a message is automatically
32762 recycled if another message is received by the same process (this applies only
32763 to incoming SMTP connections &-- other input methods can supply only one
32764 message at a time). After receiving the last message, a reception process
32765 terminates.
32766
32767 Because it is recycled, the normal dynamic memory cannot be used for holding
32768 data that must be preserved over a number of incoming messages on the same SMTP
32769 connection. However, Exim in fact uses two pools of dynamic memory; the second
32770 one is not recycled, and can be used for this purpose.
32771
32772 If you want to allocate memory that remains available for subsequent messages
32773 in the same SMTP connection, you should set
32774 .code
32775 store_pool = POOL_PERM
32776 .endd
32777 before calling the function that does the allocation. There is no need to
32778 restore the value if you do not need to; however, if you do want to revert to
32779 the normal pool, you can either restore the previous value of &%store_pool%& or
32780 set it explicitly to POOL_MAIN.
32781
32782 The pool setting applies to all functions that get dynamic memory, including
32783 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32784 There is also a convenience function called &'store_get_perm()'& that gets a
32785 block of memory from the permanent pool while preserving the value of
32786 &%store_pool%&.
32787 .ecindex IIDlosca
32788
32789
32790
32791
32792 . ////////////////////////////////////////////////////////////////////////////
32793 . ////////////////////////////////////////////////////////////////////////////
32794
32795 .chapter "System-wide message filtering" "CHAPsystemfilter"
32796 .scindex IIDsysfil1 "filter" "system filter"
32797 .scindex IIDsysfil2 "filtering all mail"
32798 .scindex IIDsysfil3 "system filter"
32799 The previous chapters (on ACLs and the local scan function) describe checks
32800 that can be applied to messages before they are accepted by a host. There is
32801 also a mechanism for checking messages once they have been received, but before
32802 they are delivered. This is called the &'system filter'&.
32803
32804 The system filter operates in a similar manner to users' filter files, but it
32805 is run just once per message (however many recipients the message has).
32806 It should not normally be used as a substitute for routing, because &%deliver%&
32807 commands in a system router provide new envelope recipient addresses.
32808 The system filter must be an Exim filter. It cannot be a Sieve filter.
32809
32810 The system filter is run at the start of a delivery attempt, before any routing
32811 is done. If a message fails to be completely delivered at the first attempt,
32812 the system filter is run again at the start of every retry.
32813 If you want your filter to do something only once per message, you can make use
32814 of the &%first_delivery%& condition in an &%if%& command in the filter to
32815 prevent it happening on retries.
32816
32817 .vindex "&$domain$&"
32818 .vindex "&$local_part$&"
32819 &*Warning*&: Because the system filter runs just once, variables that are
32820 specific to individual recipient addresses, such as &$local_part$& and
32821 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32822 you want to run a centrally-specified filter for each recipient address
32823 independently, you can do so by setting up a suitable &(redirect)& router, as
32824 described in section &<<SECTperaddfil>>& below.
32825
32826
32827 .section "Specifying a system filter" "SECID212"
32828 .cindex "uid (user id)" "system filter"
32829 .cindex "gid (group id)" "system filter"
32830 The name of the file that contains the system filter must be specified by
32831 setting &%system_filter%&. If you want the filter to run under a uid and gid
32832 other than root, you must also set &%system_filter_user%& and
32833 &%system_filter_group%& as appropriate. For example:
32834 .code
32835 system_filter = /etc/mail/exim.filter
32836 system_filter_user = exim
32837 .endd
32838 If a system filter generates any deliveries directly to files or pipes (via the
32839 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32840 specified by setting &%system_filter_file_transport%& and
32841 &%system_filter_pipe_transport%&, respectively. Similarly,
32842 &%system_filter_reply_transport%& must be set to handle any messages generated
32843 by the &%reply%& command.
32844
32845
32846 .section "Testing a system filter" "SECID213"
32847 You can run simple tests of a system filter in the same way as for a user
32848 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32849 are permitted only in system filters are recognized.
32850
32851 If you want to test the combined effect of a system filter and a user filter,
32852 you can use both &%-bF%& and &%-bf%& on the same command line.
32853
32854
32855
32856 .section "Contents of a system filter" "SECID214"
32857 The language used to specify system filters is the same as for users' filter
32858 files. It is described in the separate end-user document &'Exim's interface to
32859 mail filtering'&. However, there are some additional features that are
32860 available only in system filters; these are described in subsequent sections.
32861 If they are encountered in a user's filter file or when testing with &%-bf%&,
32862 they cause errors.
32863
32864 .cindex "frozen messages" "manual thaw; testing in filter"
32865 There are two special conditions which, though available in users' filter
32866 files, are designed for use in system filters. The condition &%first_delivery%&
32867 is true only for the first attempt at delivering a message, and
32868 &%manually_thawed%& is true only if the message has been frozen, and
32869 subsequently thawed by an admin user. An explicit forced delivery counts as a
32870 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32871
32872 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32873 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32874 succeed, it will not be tried again.
32875 If you want Exim to retry an unseen delivery until it succeeds, you should
32876 arrange to set it up every time the filter runs.
32877
32878 When a system filter finishes running, the values of the variables &$n0$& &--
32879 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32880 users' filter files. Thus a system filter can, for example, set up &"scores"&
32881 to which users' filter files can refer.
32882
32883
32884
32885 .section "Additional variable for system filters" "SECID215"
32886 .vindex "&$recipients$&"
32887 The expansion variable &$recipients$&, containing a list of all the recipients
32888 of the message (separated by commas and white space), is available in system
32889 filters. It is not available in users' filters for privacy reasons.
32890
32891
32892
32893 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32894 .cindex "freezing messages"
32895 .cindex "message" "freezing"
32896 .cindex "message" "forced failure"
32897 .cindex "&%fail%&" "in system filter"
32898 .cindex "&%freeze%& in system filter"
32899 .cindex "&%defer%& in system filter"
32900 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32901 always available in system filters, but are not normally enabled in users'
32902 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32903 for the &(redirect)& router.) These commands can optionally be followed by the
32904 word &%text%& and a string containing an error message, for example:
32905 .code
32906 fail text "this message looks like spam to me"
32907 .endd
32908 The keyword &%text%& is optional if the next character is a double quote.
32909
32910 The &%defer%& command defers delivery of the original recipients of the
32911 message. The &%fail%& command causes all the original recipients to be failed,
32912 and a bounce message to be created. The &%freeze%& command suspends all
32913 delivery attempts for the original recipients. In all cases, any new deliveries
32914 that are specified by the filter are attempted as normal after the filter has
32915 run.
32916
32917 The &%freeze%& command is ignored if the message has been manually unfrozen and
32918 not manually frozen since. This means that automatic freezing by a system
32919 filter can be used as a way of checking out suspicious messages. If a message
32920 is found to be all right, manually unfreezing it allows it to be delivered.
32921
32922 .cindex "log" "&%fail%& command log line"
32923 .cindex "&%fail%&" "log line; reducing"
32924 The text given with a fail command is used as part of the bounce message as
32925 well as being written to the log. If the message is quite long, this can fill
32926 up a lot of log space when such failures are common. To reduce the size of the
32927 log message, Exim interprets the text in a special way if it starts with the
32928 two characters &`<<`& and contains &`>>`& later. The text between these two
32929 strings is written to the log, and the rest of the text is used in the bounce
32930 message. For example:
32931 .code
32932 fail "<<filter test 1>>Your message is rejected \
32933      because it contains attachments that we are \
32934      not prepared to receive."
32935 .endd
32936
32937 .cindex "loop" "caused by &%fail%&"
32938 Take great care with the &%fail%& command when basing the decision to fail on
32939 the contents of the message, because the bounce message will of course include
32940 the contents of the original message and will therefore trigger the &%fail%&
32941 command again (causing a mail loop) unless steps are taken to prevent this.
32942 Testing the &%error_message%& condition is one way to prevent this. You could
32943 use, for example
32944 .code
32945 if $message_body contains "this is spam" and not error_message
32946 then fail text "spam is not wanted here" endif
32947 .endd
32948 though of course that might let through unwanted bounce messages. The
32949 alternative is clever checking of the body and/or headers to detect bounces
32950 generated by the filter.
32951
32952 The interpretation of a system filter file ceases after a
32953 &%defer%&,
32954 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32955 set up earlier in the filter file are honoured, so you can use a sequence such
32956 as
32957 .code
32958 mail ...
32959 freeze
32960 .endd
32961 to send a specified message when the system filter is freezing (or deferring or
32962 failing) a message. The normal deliveries for the message do not, of course,
32963 take place.
32964
32965
32966
32967 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32968 .cindex "header lines" "adding; in system filter"
32969 .cindex "header lines" "removing; in system filter"
32970 .cindex "filter" "header lines; adding/removing"
32971 Two filter commands that are available only in system filters are:
32972 .code
32973 headers add <string>
32974 headers remove <string>
32975 .endd
32976 The argument for the &%headers add%& is a string that is expanded and then
32977 added to the end of the message's headers. It is the responsibility of the
32978 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32979 space is ignored, and if the string is otherwise empty, or if the expansion is
32980 forced to fail, the command has no effect.
32981
32982 You can use &"\n"& within the string, followed by white space, to specify
32983 continued header lines. More than one header may be added in one command by
32984 including &"\n"& within the string without any following white space. For
32985 example:
32986 .code
32987 headers add "X-header-1: ....\n  \
32988              continuation of X-header-1 ...\n\
32989              X-header-2: ...."
32990 .endd
32991 Note that the header line continuation white space after the first newline must
32992 be placed before the backslash that continues the input string, because white
32993 space after input continuations is ignored.
32994
32995 The argument for &%headers remove%& is a colon-separated list of header names.
32996 This command applies only to those headers that are stored with the message;
32997 those that are added at delivery time (such as &'Envelope-To:'& and
32998 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32999 header with the same name, they are all removed.
33000
33001 The &%headers%& command in a system filter makes an immediate change to the set
33002 of header lines that was received with the message (with possible additions
33003 from ACL processing). Subsequent commands in the system filter operate on the
33004 modified set, which also forms the basis for subsequent message delivery.
33005 Unless further modified during routing or transporting, this set of headers is
33006 used for all recipients of the message.
33007
33008 During routing and transporting, the variables that refer to the contents of
33009 header lines refer only to those lines that are in this set. Thus, header lines
33010 that are added by a system filter are visible to users' filter files and to all
33011 routers and transports. This contrasts with the manipulation of header lines by
33012 routers and transports, which is not immediate, but which instead is saved up
33013 until the message is actually being written (see section
33014 &<<SECTheadersaddrem>>&).
33015
33016 If the message is not delivered at the first attempt, header lines that were
33017 added by the system filter are stored with the message, and so are still
33018 present at the next delivery attempt. Header lines that were removed are still
33019 present, but marked &"deleted"& so that they are not transported with the
33020 message. For this reason, it is usual to make the &%headers%& command
33021 conditional on &%first_delivery%& so that the set of header lines is not
33022 modified more than once.
33023
33024 Because header modification in a system filter acts immediately, you have to
33025 use an indirect approach if you want to modify the contents of a header line.
33026 For example:
33027 .code
33028 headers add "Old-Subject: $h_subject:"
33029 headers remove "Subject"
33030 headers add "Subject: new subject (was: $h_old-subject:)"
33031 headers remove "Old-Subject"
33032 .endd
33033
33034
33035
33036 .section "Setting an errors address in a system filter" "SECID217"
33037 .cindex "envelope sender"
33038 In a system filter, if a &%deliver%& command is followed by
33039 .code
33040 errors_to <some address>
33041 .endd
33042 in order to change the envelope sender (and hence the error reporting) for that
33043 delivery, any address may be specified. (In a user filter, only the current
33044 user's address can be set.) For example, if some mail is being monitored, you
33045 might use
33046 .code
33047 unseen deliver monitor@spying.example errors_to root@local.example
33048 .endd
33049 to take a copy which would not be sent back to the normal error reporting
33050 address if its delivery failed.
33051
33052
33053
33054 .section "Per-address filtering" "SECTperaddfil"
33055 .vindex "&$domain$&"
33056 .vindex "&$local_part$&"
33057 In contrast to the system filter, which is run just once per message for each
33058 delivery attempt, it is also possible to set up a system-wide filtering
33059 operation that runs once for each recipient address. In this case, variables
33060 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33061 filter file could be made dependent on them. This is an example of a router
33062 which implements such a filter:
33063 .code
33064 central_filter:
33065   check_local_user
33066   driver = redirect
33067   domains = +local_domains
33068   file = /central/filters/$local_part
33069   no_verify
33070   allow_filter
33071   allow_freeze
33072 .endd
33073 The filter is run in a separate process under its own uid. Therefore, either
33074 &%check_local_user%& must be set (as above), in which case the filter is run as
33075 the local user, or the &%user%& option must be used to specify which user to
33076 use. If both are set, &%user%& overrides.
33077
33078 Care should be taken to ensure that none of the commands in the filter file
33079 specify a significant delivery if the message is to go on to be delivered to
33080 its intended recipient. The router will not then claim to have dealt with the
33081 address, so it will be passed on to subsequent routers to be delivered in the
33082 normal way.
33083 .ecindex IIDsysfil1
33084 .ecindex IIDsysfil2
33085 .ecindex IIDsysfil3
33086
33087
33088
33089
33090
33091
33092 . ////////////////////////////////////////////////////////////////////////////
33093 . ////////////////////////////////////////////////////////////////////////////
33094
33095 .chapter "Message processing" "CHAPmsgproc"
33096 .scindex IIDmesproc "message" "general processing"
33097 Exim performs various transformations on the sender and recipient addresses of
33098 all messages that it handles, and also on the messages' header lines. Some of
33099 these are optional and configurable, while others always take place. All of
33100 this processing, except rewriting as a result of routing, and the addition or
33101 removal of header lines while delivering, happens when a message is received,
33102 before it is placed on Exim's queue.
33103
33104 Some of the automatic processing takes place by default only for
33105 &"locally-originated"& messages. This adjective is used to describe messages
33106 that are not received over TCP/IP, but instead are passed to an Exim process on
33107 its standard input. This includes the interactive &"local SMTP"& case that is
33108 set up by the &%-bs%& command line option.
33109
33110 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33111 or ::1) are not considered to be locally-originated. Exim does not treat the
33112 loopback interface specially in any way.
33113
33114 If you want the loopback interface to be treated specially, you must ensure
33115 that there are appropriate entries in your ACLs.
33116
33117
33118
33119
33120 .section "Submission mode for non-local messages" "SECTsubmodnon"
33121 .cindex "message" "submission"
33122 .cindex "submission mode"
33123 Processing that happens automatically for locally-originated messages (unless
33124 &%suppress_local_fixups%& is set) can also be requested for messages that are
33125 received over TCP/IP. The term &"submission mode"& is used to describe this
33126 state. Submission mode is set by the modifier
33127 .code
33128 control = submission
33129 .endd
33130 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33131 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33132 a local submission, and is normally used when the source of the message is
33133 known to be an MUA running on a client host (as opposed to an MTA). For
33134 example, to set submission mode for messages originating on the IPv4 loopback
33135 interface, you could include the following in the MAIL ACL:
33136 .code
33137 warn  hosts = 127.0.0.1
33138       control = submission
33139 .endd
33140 .cindex "&%sender_retain%& submission option"
33141 There are some options that can be used when setting submission mode. A slash
33142 is used to separate options. For example:
33143 .code
33144 control = submission/sender_retain
33145 .endd
33146 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33147 true and &%local_from_check%& false for the current incoming message. The first
33148 of these allows an existing &'Sender:'& header in the message to remain, and
33149 the second suppresses the check to ensure that &'From:'& matches the
33150 authenticated sender. With this setting, Exim still fixes up messages by adding
33151 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33152 attempt to check sender authenticity in header lines.
33153
33154 When &%sender_retain%& is not set, a submission mode setting may specify a
33155 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33156 example:
33157 .code
33158 control = submission/domain=some.domain
33159 .endd
33160 The domain may be empty. How this value is used is described in sections
33161 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33162 that allows you to specify the user's full name for inclusion in a created
33163 &'Sender:'& or &'From:'& header line. For example:
33164 .code
33165 accept authenticated = *
33166        control = submission/domain=wonderland.example/\
33167                             name=${lookup {$authenticated_id} \
33168                                    lsearch {/etc/exim/namelist}}
33169 .endd
33170 Because the name may contain any characters, including slashes, the &%name%&
33171 option must be given last. The remainder of the string is used as the name. For
33172 the example above, if &_/etc/exim/namelist_& contains:
33173 .code
33174 bigegg:  Humpty Dumpty
33175 .endd
33176 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33177 line would be:
33178 .code
33179 Sender: Humpty Dumpty <bigegg@wonderland.example>
33180 .endd
33181 .cindex "return path" "in submission mode"
33182 By default, submission mode forces the return path to the same address as is
33183 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33184 specified, the return path is also left unchanged.
33185
33186 &*Note*&: The changes caused by submission mode take effect after the predata
33187 ACL. This means that any sender checks performed before the fix-ups use the
33188 untrusted sender address specified by the user, not the trusted sender address
33189 specified by submission mode. Although this might be slightly unexpected, it
33190 does mean that you can configure ACL checks to spot that a user is trying to
33191 spoof another's address.
33192
33193 .section "Line endings" "SECTlineendings"
33194 .cindex "line endings"
33195 .cindex "carriage return"
33196 .cindex "linefeed"
33197 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33198 linefeed) is the line ending for messages transmitted over the Internet using
33199 SMTP over TCP/IP. However, within individual operating systems, different
33200 conventions are used. For example, Unix-like systems use just LF, but others
33201 use CRLF or just CR.
33202
33203 Exim was designed for Unix-like systems, and internally, it stores messages
33204 using the system's convention of a single LF as a line terminator. When
33205 receiving a message, all line endings are translated to this standard format.
33206 Originally, it was thought that programs that passed messages directly to an
33207 MTA within an operating system would use that system's convention. Experience
33208 has shown that this is not the case; for example, there are Unix applications
33209 that use CRLF in this circumstance. For this reason, and for compatibility with
33210 other MTAs, the way Exim handles line endings for all messages is now as
33211 follows:
33212
33213 .ilist
33214 LF not preceded by CR is treated as a line ending.
33215 .next
33216 CR is treated as a line ending; if it is immediately followed by LF, the LF
33217 is ignored.
33218 .next
33219 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33220 nor a local message in the state where a line containing only a dot is a
33221 terminator.
33222 .next
33223 If a bare CR is encountered within a header line, an extra space is added after
33224 the line terminator so as not to end the header line. The reasoning behind this
33225 is that bare CRs in header lines are most likely either to be mistakes, or
33226 people trying to play silly games.
33227 .next
33228 If the first header line received in a message ends with CRLF, a subsequent
33229 bare LF in a header line is treated in the same way as a bare CR in a header
33230 line.
33231 .endlist
33232
33233
33234
33235
33236
33237 .section "Unqualified addresses" "SECID218"
33238 .cindex "unqualified addresses"
33239 .cindex "address" "qualification"
33240 By default, Exim expects every envelope address it receives from an external
33241 host to be fully qualified. Unqualified addresses cause negative responses to
33242 SMTP commands. However, because SMTP is used as a means of transporting
33243 messages from MUAs running on personal workstations, there is sometimes a
33244 requirement to accept unqualified addresses from specific hosts or IP networks.
33245
33246 Exim has two options that separately control which hosts may send unqualified
33247 sender or recipient addresses in SMTP commands, namely
33248 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33249 cases, if an unqualified address is accepted, it is qualified by adding the
33250 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33251
33252 .oindex "&%qualify_domain%&"
33253 .oindex "&%qualify_recipient%&"
33254 Unqualified addresses in header lines are automatically qualified for messages
33255 that are locally originated, unless the &%-bnq%& option is given on the command
33256 line. For messages received over SMTP, unqualified addresses in header lines
33257 are qualified only if unqualified addresses are permitted in SMTP commands. In
33258 other words, such qualification is also controlled by
33259 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33260
33261
33262
33263
33264 .section "The UUCP From line" "SECID219"
33265 .cindex "&""From""& line"
33266 .cindex "UUCP" "&""From""& line"
33267 .cindex "sender" "address"
33268 .oindex "&%uucp_from_pattern%&"
33269 .oindex "&%uucp_from_sender%&"
33270 .cindex "envelope sender"
33271 .cindex "Sendmail compatibility" "&""From""& line"
33272 Messages that have come from UUCP (and some other applications) often begin
33273 with a line containing the envelope sender and a timestamp, following the word
33274 &"From"&. Examples of two common formats are:
33275 .code
33276 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33277 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33278 .endd
33279 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33280 Exim recognizes such lines at the start of messages that are submitted to it
33281 via the command line (that is, on the standard input). It does not recognize
33282 such lines in incoming SMTP messages, unless the sending host matches
33283 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33284 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33285 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33286 default value matches the two common cases shown above and puts the address
33287 that follows &"From"& into &$1$&.
33288
33289 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33290 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33291 a trusted user, the message's sender address is constructed by expanding the
33292 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33293 then parsed as an RFC 2822 address. If there is no domain, the local part is
33294 qualified with &%qualify_domain%& unless it is the empty string. However, if
33295 the command line &%-f%& option is used, it overrides the &"From"& line.
33296
33297 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33298 sender address is not changed. This is also the case for incoming SMTP messages
33299 that are permitted to contain &"From"& lines.
33300
33301 Only one &"From"& line is recognized. If there is more than one, the second is
33302 treated as a data line that starts the body of the message, as it is not valid
33303 as a header line. This also happens if a &"From"& line is present in an
33304 incoming SMTP message from a source that is not permitted to send them.
33305
33306
33307
33308 .section "Resent- header lines" "SECID220"
33309 .cindex "&%Resent-%& header lines"
33310 .cindex "header lines" "Resent-"
33311 RFC 2822 makes provision for sets of header lines starting with the string
33312 &`Resent-`& to be added to a message when it is resent by the original
33313 recipient to somebody else. These headers are &'Resent-Date:'&,
33314 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33315 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33316
33317 .blockquote
33318 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33319 processing of replies or other such automatic actions on messages.'&
33320 .endblockquote
33321
33322 This leaves things a bit vague as far as other processing actions such as
33323 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33324 follows:
33325
33326 .ilist
33327 A &'Resent-From:'& line that just contains the login id of the submitting user
33328 is automatically rewritten in the same way as &'From:'& (see below).
33329 .next
33330 If there's a rewriting rule for a particular header line, it is also applied to
33331 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33332 &'From:'& also rewrites &'Resent-From:'&.
33333 .next
33334 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33335 also removed.
33336 .next
33337 For a locally-submitted message,
33338 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33339 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33340 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33341 included in log lines in this case.
33342 .next
33343 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33344 &%Resent-%& header lines are present.
33345 .endlist
33346
33347
33348
33349
33350 .section "The Auto-Submitted: header line" "SECID221"
33351 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33352 includes the header line:
33353 .code
33354 Auto-Submitted: auto-replied
33355 .endd
33356
33357 .section "The Bcc: header line" "SECID222"
33358 .cindex "&'Bcc:'& header line"
33359 If Exim is called with the &%-t%& option, to take recipient addresses from a
33360 message's header, it removes any &'Bcc:'& header line that may exist (after
33361 extracting its addresses). If &%-t%& is not present on the command line, any
33362 existing &'Bcc:'& is not removed.
33363
33364
33365 .section "The Date: header line" "SECID223"
33366 .cindex "&'Date:'& header line"
33367 .cindex "header lines" "Date:"
33368 If a locally-generated or submission-mode message has no &'Date:'& header line,
33369 Exim adds one, using the current date and time, unless the
33370 &%suppress_local_fixups%& control has been specified.
33371
33372 .section "The Delivery-date: header line" "SECID224"
33373 .cindex "&'Delivery-date:'& header line"
33374 .oindex "&%delivery_date_remove%&"
33375 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33376 set. Exim can be configured to add them to the final delivery of messages. (See
33377 the generic &%delivery_date_add%& transport option.) They should not be present
33378 in messages in transit. If the &%delivery_date_remove%& configuration option is
33379 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33380 messages.
33381
33382
33383 .section "The Envelope-to: header line" "SECID225"
33384 .cindex "&'Envelope-to:'& header line"
33385 .cindex "header lines" "Envelope-to:"
33386 .oindex "&%envelope_to_remove%&"
33387 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33388 Exim can be configured to add them to the final delivery of messages. (See the
33389 generic &%envelope_to_add%& transport option.) They should not be present in
33390 messages in transit. If the &%envelope_to_remove%& configuration option is set
33391 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33392 messages.
33393
33394
33395 .section "The From: header line" "SECTthefrohea"
33396 .cindex "&'From:'& header line"
33397 .cindex "header lines" "From:"
33398 .cindex "Sendmail compatibility" "&""From""& line"
33399 .cindex "message" "submission"
33400 .cindex "submission mode"
33401 If a submission-mode message does not contain a &'From:'& header line, Exim
33402 adds one if either of the following conditions is true:
33403
33404 .ilist
33405 The envelope sender address is not empty (that is, this is not a bounce
33406 message). The added header line copies the envelope sender address.
33407 .next
33408 .vindex "&$authenticated_id$&"
33409 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33410 .olist
33411 .vindex "&$qualify_domain$&"
33412 If no domain is specified by the submission control, the local part is
33413 &$authenticated_id$& and the domain is &$qualify_domain$&.
33414 .next
33415 If a non-empty domain is specified by the submission control, the local
33416 part is &$authenticated_id$&, and the domain is the specified domain.
33417 .next
33418 If an empty domain is specified by the submission control,
33419 &$authenticated_id$& is assumed to be the complete address.
33420 .endlist
33421 .endlist
33422
33423 A non-empty envelope sender takes precedence.
33424
33425 If a locally-generated incoming message does not contain a &'From:'& header
33426 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33427 containing the sender's address. The calling user's login name and full name
33428 are used to construct the address, as described in section &<<SECTconstr>>&.
33429 They are obtained from the password data by calling &[getpwuid()]& (but see the
33430 &%unknown_login%& configuration option). The address is qualified with
33431 &%qualify_domain%&.
33432
33433 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33434 &'From:'& header line containing just the unqualified login name of the calling
33435 user, this is replaced by an address containing the user's login name and full
33436 name as described in section &<<SECTconstr>>&.
33437
33438
33439 .section "The Message-ID: header line" "SECID226"
33440 .cindex "&'Message-ID:'& header line"
33441 .cindex "header lines" "Message-ID:"
33442 .cindex "message" "submission"
33443 .oindex "&%message_id_header_text%&"
33444 If a locally-generated or submission-mode incoming message does not contain a
33445 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33446 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33447 to the message. If there are any &'Resent-:'& headers in the message, it
33448 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33449 message id, preceded by the letter E to ensure it starts with a letter, and
33450 followed by @ and the primary host name. Additional information can be included
33451 in this header line by setting the &%message_id_header_text%& and/or
33452 &%message_id_header_domain%& options.
33453
33454
33455 .section "The Received: header line" "SECID227"
33456 .cindex "&'Received:'& header line"
33457 .cindex "header lines" "Received:"
33458 A &'Received:'& header line is added at the start of every message. The
33459 contents are defined by the &%received_header_text%& configuration option, and
33460 Exim automatically adds a semicolon and a timestamp to the configured string.
33461
33462 The &'Received:'& header is generated as soon as the message's header lines
33463 have been received. At this stage, the timestamp in the &'Received:'& header
33464 line is the time that the message started to be received. This is the value
33465 that is seen by the DATA ACL and by the &[local_scan()]& function.
33466
33467 Once a message is accepted, the timestamp in the &'Received:'& header line is
33468 changed to the time of acceptance, which is (apart from a small delay while the
33469 -H spool file is written) the earliest time at which delivery could start.
33470
33471
33472 .section "The References: header line" "SECID228"
33473 .cindex "&'References:'& header line"
33474 .cindex "header lines" "References:"
33475 Messages created by the &(autoreply)& transport include a &'References:'&
33476 header line. This is constructed according to the rules that are described in
33477 section 3.64 of RFC 2822 (which states that replies should contain such a
33478 header line), and section 3.14 of RFC 3834 (which states that automatic
33479 responses are not different in this respect). However, because some mail
33480 processing software does not cope well with very long header lines, no more
33481 than 12 message IDs are copied from the &'References:'& header line in the
33482 incoming message. If there are more than 12, the first one and then the final
33483 11 are copied, before adding the message ID of the incoming message.
33484
33485
33486
33487 .section "The Return-path: header line" "SECID229"
33488 .cindex "&'Return-path:'& header line"
33489 .cindex "header lines" "Return-path:"
33490 .oindex "&%return_path_remove%&"
33491 &'Return-path:'& header lines are defined as something an MTA may insert when
33492 it does the final delivery of messages. (See the generic &%return_path_add%&
33493 transport option.) Therefore, they should not be present in messages in
33494 transit. If the &%return_path_remove%& configuration option is set (the
33495 default), Exim removes &'Return-path:'& header lines from incoming messages.
33496
33497
33498
33499 .section "The Sender: header line" "SECTthesenhea"
33500 .cindex "&'Sender:'& header line"
33501 .cindex "message" "submission"
33502 .cindex "header lines" "Sender:"
33503 For a locally-originated message from an untrusted user, Exim may remove an
33504 existing &'Sender:'& header line, and it may add a new one. You can modify
33505 these actions by setting the &%local_sender_retain%& option true, the
33506 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33507 control setting.
33508
33509 When a local message is received from an untrusted user and
33510 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33511 control has not been set, a check is made to see if the address given in the
33512 &'From:'& header line is the correct (local) sender of the message. The address
33513 that is expected has the login name as the local part and the value of
33514 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33515 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33516 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33517 line is added to the message.
33518
33519 If you set &%local_from_check%& false, this checking does not occur. However,
33520 the removal of an existing &'Sender:'& line still happens, unless you also set
33521 &%local_sender_retain%& to be true. It is not possible to set both of these
33522 options true at the same time.
33523
33524 .cindex "submission mode"
33525 By default, no processing of &'Sender:'& header lines is done for messages
33526 received over TCP/IP or for messages submitted by trusted users. However, when
33527 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33528 not specified on the submission control, the following processing takes place:
33529
33530 .vindex "&$authenticated_id$&"
33531 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33532 authenticated, and &$authenticated_id$& is not empty, a sender address is
33533 created as follows:
33534
33535 .ilist
33536 .vindex "&$qualify_domain$&"
33537 If no domain is specified by the submission control, the local part is
33538 &$authenticated_id$& and the domain is &$qualify_domain$&.
33539 .next
33540 If a non-empty domain is specified by the submission control, the local part
33541 is &$authenticated_id$&, and the domain is the specified domain.
33542 .next
33543 If an empty domain is specified by the submission control,
33544 &$authenticated_id$& is assumed to be the complete address.
33545 .endlist
33546
33547 This address is compared with the address in the &'From:'& header line. If they
33548 are different, a &'Sender:'& header line containing the created address is
33549 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33550 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33551
33552 .cindex "return path" "created from &'Sender:'&"
33553 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33554 the message (the envelope sender address) is changed to be the same address,
33555 except in the case of submission mode when &%sender_retain%& is specified.
33556
33557
33558
33559 .section "Adding and removing header lines in routers and transports" &&&
33560          "SECTheadersaddrem"
33561 .cindex "header lines" "adding; in router or transport"
33562 .cindex "header lines" "removing; in router or transport"
33563 When a message is delivered, the addition and removal of header lines can be
33564 specified in a system filter, or on any of the routers and transports that
33565 process the message. Section &<<SECTaddremheasys>>& contains details about
33566 modifying headers in a system filter. Header lines can also be added in an ACL
33567 as a message is received (see section &<<SECTaddheadacl>>&).
33568
33569 In contrast to what happens in a system filter, header modifications that are
33570 specified on routers and transports apply only to the particular recipient
33571 addresses that are being processed by those routers and transports. These
33572 changes do not actually take place until a copy of the message is being
33573 transported. Therefore, they do not affect the basic set of header lines, and
33574 they do not affect the values of the variables that refer to header lines.
33575
33576 &*Note*&: In particular, this means that any expansions in the configuration of
33577 the transport cannot refer to the modified header lines, because such
33578 expansions all occur before the message is actually transported.
33579
33580 For both routers and transports, the argument of a &%headers_add%&
33581 option must be in the form of one or more RFC 2822 header lines, separated by
33582 newlines (coded as &"\n"&). For example:
33583 .code
33584 headers_add = X-added-header: added by $primary_hostname\n\
33585               X-added-second: another added header line
33586 .endd
33587 Exim does not check the syntax of these added header lines.
33588
33589 Multiple &%headers_add%& options for a single router or transport can be
33590 specified; the values will append to a single list of header lines.
33591 Each header-line is separately expanded.
33592
33593 The argument of a &%headers_remove%& option must consist of a colon-separated
33594 list of header names. This is confusing, because header names themselves are
33595 often terminated by colons. In this case, the colons are the list separators,
33596 not part of the names. For example:
33597 .code
33598 headers_remove = return-receipt-to:acknowledge-to
33599 .endd
33600
33601 Multiple &%headers_remove%& options for a single router or transport can be
33602 specified; the arguments will append to a single header-names list.
33603 Each item is separately expanded.
33604 Note that colons in complex expansions which are used to
33605 form all or part of a &%headers_remove%& list
33606 will act as list separators.
33607
33608 When &%headers_add%& or &%headers_remove%& is specified on a router,
33609 items are expanded at routing time,
33610 and then associated with all addresses that are
33611 accepted by that router, and also with any new addresses that it generates. If
33612 an address passes through several routers as a result of aliasing or
33613 forwarding, the changes are cumulative.
33614
33615 .oindex "&%unseen%&"
33616 However, this does not apply to multiple routers that result from the use of
33617 the &%unseen%& option. Any header modifications that were specified by the
33618 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33619
33620 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33621 settings cannot be delivered together in a batch, so a transport is always
33622 dealing with a set of addresses that have the same header-processing
33623 requirements.
33624
33625 The transport starts by writing the original set of header lines that arrived
33626 with the message, possibly modified by the system filter. As it writes out
33627 these lines, it consults the list of header names that were attached to the
33628 recipient address(es) by &%headers_remove%& options in routers, and it also
33629 consults the transport's own &%headers_remove%& option. Header lines whose
33630 names are on either of these lists are not written out. If there are multiple
33631 instances of any listed header, they are all skipped.
33632
33633 After the remaining original header lines have been written, new header
33634 lines that were specified by routers' &%headers_add%& options are written, in
33635 the order in which they were attached to the address. These are followed by any
33636 header lines specified by the transport's &%headers_add%& option.
33637
33638 This way of handling header line modifications in routers and transports has
33639 the following consequences:
33640
33641 .ilist
33642 The original set of header lines, possibly modified by the system filter,
33643 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33644 to it, at all times.
33645 .next
33646 Header lines that are added by a router's
33647 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33648 expansion syntax in subsequent routers or the transport.
33649 .next
33650 Conversely, header lines that are specified for removal by &%headers_remove%&
33651 in a router remain visible to subsequent routers and the transport.
33652 .next
33653 Headers added to an address by &%headers_add%& in a router cannot be removed by
33654 a later router or by a transport.
33655 .next
33656 An added header can refer to the contents of an original header that is to be
33657 removed, even it has the same name as the added header. For example:
33658 .code
33659 headers_remove = subject
33660 headers_add = Subject: new subject (was: $h_subject:)
33661 .endd
33662 .endlist
33663
33664 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33665 for a &(redirect)& router that has the &%one_time%& option set.
33666
33667
33668
33669
33670
33671 .section "Constructed addresses" "SECTconstr"
33672 .cindex "address" "constructed"
33673 .cindex "constructed address"
33674 When Exim constructs a sender address for a locally-generated message, it uses
33675 the form
33676 .display
33677 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33678 .endd
33679 For example:
33680 .code
33681 Zaphod Beeblebrox <zaphod@end.univ.example>
33682 .endd
33683 The user name is obtained from the &%-F%& command line option if set, or
33684 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33685 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33686 ampersand character, this is replaced by the login name with the first letter
33687 upper cased, as is conventional in a number of operating systems. See the
33688 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33689 The &%unknown_username%& option can be used to specify user names in cases when
33690 there is no password file entry.
33691
33692 .cindex "RFC 2047"
33693 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33694 parts of it if necessary. In addition, if it contains any non-printing
33695 characters, it is encoded as described in RFC 2047, which defines a way of
33696 including non-ASCII characters in header lines. The value of the
33697 &%headers_charset%& option specifies the name of the encoding that is used (the
33698 characters are assumed to be in this encoding). The setting of
33699 &%print_topbitchars%& controls whether characters with the top bit set (that
33700 is, with codes greater than 127) count as printing characters or not.
33701
33702
33703
33704 .section "Case of local parts" "SECID230"
33705 .cindex "case of local parts"
33706 .cindex "local part" "case of"
33707 RFC 2822 states that the case of letters in the local parts of addresses cannot
33708 be assumed to be non-significant. Exim preserves the case of local parts of
33709 addresses, but by default it uses a lower-cased form when it is routing,
33710 because on most Unix systems, usernames are in lower case and case-insensitive
33711 routing is required. However, any particular router can be made to use the
33712 original case for local parts by setting the &%caseful_local_part%& generic
33713 router option.
33714
33715 .cindex "mixed-case login names"
33716 If you must have mixed-case user names on your system, the best way to proceed,
33717 assuming you want case-independent handling of incoming email, is to set up
33718 your first router to convert incoming local parts in your domains to the
33719 correct case by means of a file lookup. For example:
33720 .code
33721 correct_case:
33722   driver = redirect
33723   domains = +local_domains
33724   data = ${lookup{$local_part}cdb\
33725               {/etc/usercased.cdb}{$value}fail}\
33726               @$domain
33727 .endd
33728 For this router, the local part is forced to lower case by the default action
33729 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33730 up a new local part in the correct case. If you then set &%caseful_local_part%&
33731 on any subsequent routers which process your domains, they will operate on
33732 local parts with the correct case in a case-sensitive manner.
33733
33734
33735
33736 .section "Dots in local parts" "SECID231"
33737 .cindex "dot" "in local part"
33738 .cindex "local part" "dots in"
33739 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33740 part may not begin or end with a dot, nor have two consecutive dots in the
33741 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33742 empty components for compatibility.
33743
33744
33745
33746 .section "Rewriting addresses" "SECID232"
33747 .cindex "rewriting" "addresses"
33748 Rewriting of sender and recipient addresses, and addresses in headers, can
33749 happen automatically, or as the result of configuration options, as described
33750 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33751 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33752
33753 Automatic rewriting includes qualification, as mentioned above. The other case
33754 in which it can happen is when an incomplete non-local domain is given. The
33755 routing process may cause this to be expanded into the full domain name. For
33756 example, a header such as
33757 .code
33758 To: hare@teaparty
33759 .endd
33760 might get rewritten as
33761 .code
33762 To: hare@teaparty.wonderland.fict.example
33763 .endd
33764 Rewriting as a result of routing is the one kind of message processing that
33765 does not happen at input time, as it cannot be done until the address has
33766 been routed.
33767
33768 Strictly, one should not do &'any'& deliveries of a message until all its
33769 addresses have been routed, in case any of the headers get changed as a
33770 result of routing. However, doing this in practice would hold up many
33771 deliveries for unreasonable amounts of time, just because one address could not
33772 immediately be routed. Exim therefore does not delay other deliveries when
33773 routing of one or more addresses is deferred.
33774 .ecindex IIDmesproc
33775
33776
33777
33778 . ////////////////////////////////////////////////////////////////////////////
33779 . ////////////////////////////////////////////////////////////////////////////
33780
33781 .chapter "SMTP processing" "CHAPSMTP"
33782 .scindex IIDsmtpproc1 "SMTP" "processing details"
33783 .scindex IIDsmtpproc2 "LMTP" "processing details"
33784 Exim supports a number of different ways of using the SMTP protocol, and its
33785 LMTP variant, which is an interactive protocol for transferring messages into a
33786 closed mail store application. This chapter contains details of how SMTP is
33787 processed. For incoming mail, the following are available:
33788
33789 .ilist
33790 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33791 .next
33792 SMTP over the standard input and output (the &%-bs%& option);
33793 .next
33794 Batched SMTP on the standard input (the &%-bS%& option).
33795 .endlist
33796
33797 For mail delivery, the following are available:
33798
33799 .ilist
33800 SMTP over TCP/IP (the &(smtp)& transport);
33801 .next
33802 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33803 &"lmtp"&);
33804 .next
33805 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33806 transport);
33807 .next
33808 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33809 the &%use_bsmtp%& option set).
33810 .endlist
33811
33812 &'Batched SMTP'& is the name for a process in which batches of messages are
33813 stored in or read from files (or pipes), in a format in which SMTP commands are
33814 used to contain the envelope information.
33815
33816
33817
33818 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33819 .cindex "SMTP" "outgoing over TCP/IP"
33820 .cindex "outgoing SMTP over TCP/IP"
33821 .cindex "LMTP" "over TCP/IP"
33822 .cindex "outgoing LMTP over TCP/IP"
33823 .cindex "EHLO"
33824 .cindex "HELO"
33825 .cindex "SIZE option on MAIL command"
33826 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33827 The &%protocol%& option selects which protocol is to be used, but the actual
33828 processing is the same in both cases.
33829
33830 If, in response to its EHLO command, Exim is told that the SIZE
33831 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33832 command. The value of <&'n'&> is the message size plus the value of the
33833 &%size_addition%& option (default 1024) to allow for additions to the message
33834 such as per-transport header lines, or changes made in a
33835 .cindex "transport" "filter"
33836 .cindex "filter" "transport filter"
33837 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33838 suppressed.
33839
33840 If the remote server advertises support for PIPELINING, Exim uses the
33841 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33842 required for the transaction.
33843
33844 If the remote server advertises support for the STARTTLS command, and Exim
33845 was built to support TLS encryption, it tries to start a TLS session unless the
33846 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33847 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33848 is called for verification.
33849
33850 If the remote server advertises support for the AUTH command, Exim scans
33851 the authenticators configuration for any suitable client settings, as described
33852 in chapter &<<CHAPSMTPAUTH>>&.
33853
33854 .cindex "carriage return"
33855 .cindex "linefeed"
33856 Responses from the remote host are supposed to be terminated by CR followed by
33857 LF. However, there are known to be hosts that do not send CR characters, so in
33858 order to be able to interwork with such hosts, Exim treats LF on its own as a
33859 line terminator.
33860
33861 If a message contains a number of different addresses, all those with the same
33862 characteristics (for example, the same envelope sender) that resolve to the
33863 same set of hosts, in the same order, are sent in a single SMTP transaction,
33864 even if they are for different domains, unless there are more than the setting
33865 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33866 they are split into groups containing no more than &%max_rcpt%&s addresses
33867 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33868 in parallel sessions. The order of hosts with identical MX values is not
33869 significant when checking whether addresses can be batched in this way.
33870
33871 When the &(smtp)& transport suffers a temporary failure that is not
33872 message-related, Exim updates its transport-specific database, which contains
33873 records indexed by host name that remember which messages are waiting for each
33874 particular host. It also updates the retry database with new retry times.
33875
33876 .cindex "hints database" "retry keys"
33877 Exim's retry hints are based on host name plus IP address, so if one address of
33878 a multi-homed host is broken, it will soon be skipped most of the time.
33879 See the next section for more detail about error handling.
33880
33881 .cindex "SMTP" "passed connection"
33882 .cindex "SMTP" "batching over TCP/IP"
33883 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33884 looks in the hints database for the transport to see if there are any queued
33885 messages waiting for the host to which it is connected. If it finds one, it
33886 creates a new Exim process using the &%-MC%& option (which can only be used by
33887 a process running as root or the Exim user) and passes the TCP/IP socket to it
33888 so that it can deliver another message using the same socket. The new process
33889 does only those deliveries that are routed to the connected host, and may in
33890 turn pass the socket on to a third process, and so on.
33891
33892 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33893 limit the number of messages sent down a single TCP/IP connection.
33894
33895 .cindex "asterisk" "after IP address"
33896 The second and subsequent messages delivered down an existing connection are
33897 identified in the main log by the addition of an asterisk after the closing
33898 square bracket of the IP address.
33899
33900
33901
33902
33903 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33904 .cindex "error" "in outgoing SMTP"
33905 .cindex "SMTP" "errors in outgoing"
33906 .cindex "host" "error"
33907 Three different kinds of error are recognized for outgoing SMTP: host errors,
33908 message errors, and recipient errors.
33909
33910 .vlist
33911 .vitem "&*Host errors*&"
33912 A host error is not associated with a particular message or with a
33913 particular recipient of a message. The host errors are:
33914
33915 .ilist
33916 Connection refused or timed out,
33917 .next
33918 Any error response code on connection,
33919 .next
33920 Any error response code to EHLO or HELO,
33921 .next
33922 Loss of connection at any time, except after &"."&,
33923 .next
33924 I/O errors at any time,
33925 .next
33926 Timeouts during the session, other than in response to MAIL, RCPT or
33927 the &"."& at the end of the data.
33928 .endlist ilist
33929
33930 For a host error, a permanent error response on connection, or in response to
33931 EHLO, causes all addresses routed to the host to be failed. Any other host
33932 error causes all addresses to be deferred, and retry data to be created for the
33933 host. It is not tried again, for any message, until its retry time arrives. If
33934 the current set of addresses are not all delivered in this run (to some
33935 alternative host), the message is added to the list of those waiting for this
33936 host, so if it is still undelivered when a subsequent successful delivery is
33937 made to the host, it will be sent down the same SMTP connection.
33938
33939 .vitem "&*Message errors*&"
33940 .cindex "message" "error"
33941 A message error is associated with a particular message when sent to a
33942 particular host, but not with a particular recipient of the message. The
33943 message errors are:
33944
33945 .ilist
33946 Any error response code to MAIL, DATA, or the &"."& that terminates
33947 the data,
33948 .next
33949 Timeout after MAIL,
33950 .next
33951 Timeout or loss of connection after the &"."& that terminates the data. A
33952 timeout after the DATA command itself is treated as a host error, as is loss of
33953 connection at any other time.
33954 .endlist ilist
33955
33956 For a message error, a permanent error response (5&'xx'&) causes all addresses
33957 to be failed, and a delivery error report to be returned to the sender. A
33958 temporary error response (4&'xx'&), or one of the timeouts, causes all
33959 addresses to be deferred. Retry data is not created for the host, but instead,
33960 a retry record for the combination of host plus message id is created. The
33961 message is not added to the list of those waiting for this host. This ensures
33962 that the failing message will not be sent to this host again until the retry
33963 time arrives. However, other messages that are routed to the host are not
33964 affected, so if it is some property of the message that is causing the error,
33965 it will not stop the delivery of other mail.
33966
33967 If the remote host specified support for the SIZE parameter in its response
33968 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33969 over-large message will cause a message error because the error arrives as a
33970 response to MAIL.
33971
33972 .vitem "&*Recipient errors*&"
33973 .cindex "recipient" "error"
33974 A recipient error is associated with a particular recipient of a message. The
33975 recipient errors are:
33976
33977 .ilist
33978 Any error response to RCPT,
33979 .next
33980 Timeout after RCPT.
33981 .endlist
33982
33983 For a recipient error, a permanent error response (5&'xx'&) causes the
33984 recipient address to be failed, and a bounce message to be returned to the
33985 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33986 address to be deferred, and routing retry data to be created for it. This is
33987 used to delay processing of the address in subsequent queue runs, until its
33988 routing retry time arrives. This applies to all messages, but because it
33989 operates only in queue runs, one attempt will be made to deliver a new message
33990 to the failing address before the delay starts to operate. This ensures that,
33991 if the failure is really related to the message rather than the recipient
33992 (&"message too big for this recipient"& is a possible example), other messages
33993 have a chance of getting delivered. If a delivery to the address does succeed,
33994 the retry information gets cleared, so all stuck messages get tried again, and
33995 the retry clock is reset.
33996
33997 The message is not added to the list of those waiting for this host. Use of the
33998 host for other messages is unaffected, and except in the case of a timeout,
33999 other recipients are processed independently, and may be successfully delivered
34000 in the current SMTP session. After a timeout it is of course impossible to
34001 proceed with the session, so all addresses get deferred. However, those other
34002 than the one that failed do not suffer any subsequent retry delays. Therefore,
34003 if one recipient is causing trouble, the others have a chance of getting
34004 through when a subsequent delivery attempt occurs before the failing
34005 recipient's retry time.
34006 .endlist
34007
34008 In all cases, if there are other hosts (or IP addresses) available for the
34009 current set of addresses (for example, from multiple MX records), they are
34010 tried in this run for any undelivered addresses, subject of course to their
34011 own retry data. In other words, recipient error retry data does not take effect
34012 until the next delivery attempt.
34013
34014 Some hosts have been observed to give temporary error responses to every
34015 MAIL command at certain times (&"insufficient space"& has been seen). It
34016 would be nice if such circumstances could be recognized, and defer data for the
34017 host itself created, but this is not possible within the current Exim design.
34018 What actually happens is that retry data for every (host, message) combination
34019 is created.
34020
34021 The reason that timeouts after MAIL and RCPT are treated specially is that
34022 these can sometimes arise as a result of the remote host's verification
34023 procedures. Exim makes this assumption, and treats them as if a temporary error
34024 response had been received. A timeout after &"."& is treated specially because
34025 it is known that some broken implementations fail to recognize the end of the
34026 message if the last character of the last line is a binary zero. Thus, it is
34027 helpful to treat this case as a message error.
34028
34029 Timeouts at other times are treated as host errors, assuming a problem with the
34030 host, or the connection to it. If a timeout after MAIL, RCPT,
34031 or &"."& is really a connection problem, the assumption is that at the next try
34032 the timeout is likely to occur at some other point in the dialogue, causing it
34033 then to be treated as a host error.
34034
34035 There is experimental evidence that some MTAs drop the connection after the
34036 terminating &"."& if they do not like the contents of the message for some
34037 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34038 should be given. That is why Exim treats this case as a message rather than a
34039 host error, in order not to delay other messages to the same host.
34040
34041
34042
34043
34044 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34045 .cindex "SMTP" "incoming over TCP/IP"
34046 .cindex "incoming SMTP over TCP/IP"
34047 .cindex "inetd"
34048 .cindex "daemon"
34049 Incoming SMTP messages can be accepted in one of two ways: by running a
34050 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34051 &_/etc/inetd.conf_& should be like this:
34052 .code
34053 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34054 .endd
34055 Exim distinguishes between this case and the case of a locally running user
34056 agent using the &%-bs%& option by checking whether or not the standard input is
34057 a socket. When it is, either the port must be privileged (less than 1024), or
34058 the caller must be root or the Exim user. If any other user passes a socket
34059 with an unprivileged port number, Exim prints a message on the standard error
34060 stream and exits with an error code.
34061
34062 By default, Exim does not make a log entry when a remote host connects or
34063 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34064 unexpected. It can be made to write such log entries by setting the
34065 &%smtp_connection%& log selector.
34066
34067 .cindex "carriage return"
34068 .cindex "linefeed"
34069 Commands from the remote host are supposed to be terminated by CR followed by
34070 LF. However, there are known to be hosts that do not send CR characters. In
34071 order to be able to interwork with such hosts, Exim treats LF on its own as a
34072 line terminator.
34073 Furthermore, because common code is used for receiving messages from all
34074 sources, a CR on its own is also interpreted as a line terminator. However, the
34075 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34076
34077 .cindex "EHLO" "invalid data"
34078 .cindex "HELO" "invalid data"
34079 One area that sometimes gives rise to problems concerns the EHLO or
34080 HELO commands. Some clients send syntactically invalid versions of these
34081 commands, which Exim rejects by default. (This is nothing to do with verifying
34082 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34083 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34084 match the broken hosts that send invalid commands.
34085
34086 .cindex "SIZE option on MAIL command"
34087 .cindex "MAIL" "SIZE option"
34088 The amount of disk space available is checked whenever SIZE is received on
34089 a MAIL command, independently of whether &%message_size_limit%& or
34090 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34091 false. A temporary error is given if there is not enough space. If
34092 &%check_spool_space%& is set, the check is for that amount of space plus the
34093 value given with SIZE, that is, it checks that the addition of the incoming
34094 message will not reduce the space below the threshold.
34095
34096 When a message is successfully received, Exim includes the local message id in
34097 its response to the final &"."& that terminates the data. If the remote host
34098 logs this text it can help with tracing what has happened to a message.
34099
34100 The Exim daemon can limit the number of simultaneous incoming connections it is
34101 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34102 number of simultaneous incoming connections from a single remote host (see the
34103 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34104 rejected using the SMTP temporary error code 421.
34105
34106 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34107 subprocess has finished, as this can get lost at busy times. Instead, it looks
34108 for completed subprocesses every time it wakes up. Provided there are other
34109 things happening (new incoming calls, starts of queue runs), completed
34110 processes will be noticed and tidied away. On very quiet systems you may
34111 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34112 it will be noticed when the daemon next wakes up.
34113
34114 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34115 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34116 high system load &-- for details see the &%smtp_accept_reserve%&,
34117 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34118 applies in both the daemon and &'inetd'& cases.
34119
34120 Exim normally starts a delivery process for each message received, though this
34121 can be varied by means of the &%-odq%& command line option and the
34122 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34123 number of simultaneously running delivery processes started in this way from
34124 SMTP input can be limited by the &%smtp_accept_queue%& and
34125 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34126 subsequently received messages are just put on the input queue without starting
34127 a delivery process.
34128
34129 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34130 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34131 started up from the &'inetd'& daemon, because in that case each connection is
34132 handled by an entirely independent Exim process. Control by load average is,
34133 however, available with &'inetd'&.
34134
34135 Exim can be configured to verify addresses in incoming SMTP commands as they
34136 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34137 to rewrite addresses at this time &-- before any syntax checking is done. See
34138 section &<<SECTrewriteS>>&.
34139
34140 Exim can also be configured to limit the rate at which a client host submits
34141 MAIL and RCPT commands in a single SMTP session. See the
34142 &%smtp_ratelimit_hosts%& option.
34143
34144
34145
34146 .section "Unrecognized SMTP commands" "SECID234"
34147 .cindex "SMTP" "unrecognized commands"
34148 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34149 commands during a single SMTP connection, it drops the connection after sending
34150 the error response to the last command. The default value for
34151 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34152 abuse that subvert web servers into making connections to SMTP ports; in these
34153 circumstances, a number of non-SMTP lines are sent first.
34154
34155
34156 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34157 .cindex "SMTP" "syntax errors"
34158 .cindex "SMTP" "protocol errors"
34159 A syntax error is detected if an SMTP command is recognized, but there is
34160 something syntactically wrong with its data, for example, a malformed email
34161 address in a RCPT command. Protocol errors include invalid command
34162 sequencing such as RCPT before MAIL. If Exim receives more than
34163 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34164 drops the connection after sending the error response to the last command. The
34165 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34166 broken clients that loop sending bad commands (yes, it has been seen).
34167
34168
34169
34170 .section "Use of non-mail SMTP commands" "SECID236"
34171 .cindex "SMTP" "non-mail commands"
34172 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34173 DATA. Exim counts such commands, and drops the connection if there are too
34174 many of them in a single SMTP session. This action catches some
34175 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34176 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34177 defines what &"too many"& means. Its default value is 10.
34178
34179 When a new message is expected, one occurrence of RSET is not counted. This
34180 allows a client to send one RSET between messages (this is not necessary,
34181 but some clients do it). Exim also allows one uncounted occurrence of HELO
34182 or EHLO, and one occurrence of STARTTLS between messages. After
34183 starting up a TLS session, another EHLO is expected, and so it too is not
34184 counted.
34185
34186 The first occurrence of AUTH in a connection, or immediately following
34187 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34188 RCPT, DATA, and QUIT are counted.
34189
34190 You can control which hosts are subject to the limit set by
34191 &%smtp_accept_max_nonmail%& by setting
34192 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34193 the limit apply to all hosts. This option means that you can exclude any
34194 specific badly-behaved hosts that you have to live with.
34195
34196
34197
34198
34199 .section "The VRFY and EXPN commands" "SECID237"
34200 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34201 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34202 appropriate) in order to decide whether the command should be accepted or not.
34203
34204 .cindex "VRFY" "processing"
34205 When no ACL is defined for VRFY, or if it rejects without
34206 setting an explicit response code, the command is accepted
34207 (with a 252 SMTP response code)
34208 in order to support awkward clients that do a VRFY before every RCPT.
34209 When VRFY is accepted, it runs exactly the same code as when Exim is
34210 called with the &%-bv%& option, and returns 250/451/550
34211 SMTP response codes.
34212
34213 .cindex "EXPN" "processing"
34214 If no ACL for EXPN is defined, the command is rejected.
34215 When EXPN is accepted, a single-level expansion of the address is done.
34216 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34217 than a verification (the &%-bv%& option). If an unqualified local part is given
34218 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34219 of VRFY and EXPN commands are logged on the main and reject logs, and
34220 VRFY verification failures are logged on the main log for consistency with
34221 RCPT failures.
34222
34223
34224
34225 .section "The ETRN command" "SECTETRN"
34226 .cindex "ETRN" "processing"
34227 RFC 1985 describes an SMTP command called ETRN that is designed to
34228 overcome the security problems of the TURN command (which has fallen into
34229 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34230 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34231 should be accepted or not. If no ACL is defined, the command is rejected.
34232
34233 The ETRN command is concerned with &"releasing"& messages that are awaiting
34234 delivery to certain hosts. As Exim does not organize its message queue by host,
34235 the only form of ETRN that is supported by default is the one where the
34236 text starts with the &"#"& prefix, in which case the remainder of the text is
34237 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34238 the &%-R%& option to happen, with the remainder of the ETRN text as its
34239 argument. For example,
34240 .code
34241 ETRN #brigadoon
34242 .endd
34243 runs the command
34244 .code
34245 exim -R brigadoon
34246 .endd
34247 which causes a delivery attempt on all messages with undelivered addresses
34248 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34249 default), Exim prevents the simultaneous execution of more than one queue run
34250 for the same argument string as a result of an ETRN command. This stops
34251 a misbehaving client from starting more than one queue runner at once.
34252
34253 .cindex "hints database" "ETRN serialization"
34254 Exim implements the serialization by means of a hints database in which a
34255 record is written whenever a process is started by ETRN, and deleted when
34256 the process completes. However, Exim does not keep the SMTP session waiting for
34257 the ETRN process to complete. Once ETRN is accepted, the client is sent
34258 a &"success"& return code. Obviously there is scope for hints records to get
34259 left lying around if there is a system or program crash. To guard against this,
34260 Exim ignores any records that are more than six hours old.
34261
34262 .oindex "&%smtp_etrn_command%&"
34263 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34264 used. This specifies a command that is run whenever ETRN is received,
34265 whatever the form of its argument. For
34266 example:
34267 .code
34268 smtp_etrn_command = /etc/etrn_command $domain \
34269                     $sender_host_address
34270 .endd
34271 .vindex "&$domain$&"
34272 The string is split up into arguments which are independently expanded. The
34273 expansion variable &$domain$& is set to the argument of the ETRN command,
34274 and no syntax checking is done on the contents of this argument. Exim does not
34275 wait for the command to complete, so its status code is not checked. Exim runs
34276 under its own uid and gid when receiving incoming SMTP, so it is not possible
34277 for it to change them before running the command.
34278
34279
34280
34281 .section "Incoming local SMTP" "SECID238"
34282 .cindex "SMTP" "local incoming"
34283 Some user agents use SMTP to pass messages to their local MTA using the
34284 standard input and output, as opposed to passing the envelope on the command
34285 line and writing the message to the standard input. This is supported by the
34286 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34287 messages over TCP/IP (including the use of ACLs), except that the envelope
34288 sender given in a MAIL command is ignored unless the caller is trusted. In
34289 an ACL you can detect this form of SMTP input by testing for an empty host
34290 identification. It is common to have this as the first line in the ACL that
34291 runs for RCPT commands:
34292 .code
34293 accept hosts = :
34294 .endd
34295 This accepts SMTP messages from local processes without doing any other tests.
34296
34297
34298
34299 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34300 .cindex "SMTP" "batched outgoing"
34301 .cindex "batched SMTP output"
34302 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34303 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34304 be output in BSMTP format. No SMTP responses are possible for this form of
34305 delivery. All it is doing is using SMTP commands as a way of transmitting the
34306 envelope along with the message.
34307
34308 The message is written to the file or pipe preceded by the SMTP commands
34309 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34310 the message that start with a dot have an extra dot added. The SMTP command
34311 HELO is not normally used. If it is required, the &%message_prefix%& option
34312 can be used to specify it.
34313
34314 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34315 one recipient address at a time by default. However, you can arrange for them
34316 to handle several addresses at once by setting the &%batch_max%& option. When
34317 this is done for BSMTP, messages may contain multiple RCPT commands. See
34318 chapter &<<CHAPbatching>>& for more details.
34319
34320 .vindex "&$host$&"
34321 When one or more addresses are routed to a BSMTP transport by a router that
34322 sets up a host list, the name of the first host on the list is available to the
34323 transport in the variable &$host$&. Here is an example of such a transport and
34324 router:
34325 .code
34326 begin routers
34327 route_append:
34328   driver = manualroute
34329   transport = smtp_appendfile
34330   route_list = domain.example  batch.host.example
34331
34332 begin transports
34333 smtp_appendfile:
34334   driver = appendfile
34335   directory = /var/bsmtp/$host
34336   batch_max = 1000
34337   use_bsmtp
34338   user = exim
34339 .endd
34340 This causes messages addressed to &'domain.example'& to be written in BSMTP
34341 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34342 message (unless there are more than 1000 recipients).
34343
34344
34345
34346 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34347 .cindex "SMTP" "batched incoming"
34348 .cindex "batched SMTP input"
34349 The &%-bS%& command line option causes Exim to accept one or more messages by
34350 reading SMTP on the standard input, but to generate no responses. If the caller
34351 is trusted, the senders in the MAIL commands are believed; otherwise the
34352 sender is always the caller of Exim. Unqualified senders and receivers are not
34353 rejected (there seems little point) but instead just get qualified. HELO
34354 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34355 as NOOP; QUIT quits.
34356
34357 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34358 ACL is run in the same way as for non-SMTP local input.
34359
34360 If an error is detected while reading a message, including a missing &"."& at
34361 the end, Exim gives up immediately. It writes details of the error to the
34362 standard output in a stylized way that the calling program should be able to
34363 make some use of automatically, for example:
34364 .code
34365 554 Unexpected end of file
34366 Transaction started in line 10
34367 Error detected in line 14
34368 .endd
34369 It writes a more verbose version, for human consumption, to the standard error
34370 file, for example:
34371 .code
34372 An error was detected while processing a file of BSMTP input.
34373 The error message was:
34374
34375 501 '>' missing at end of address
34376
34377 The SMTP transaction started in line 10.
34378 The error was detected in line 12.
34379 The SMTP command at fault was:
34380
34381 rcpt to:<malformed@in.com.plete
34382
34383 1 previous message was successfully processed.
34384 The rest of the batch was abandoned.
34385 .endd
34386 The return code from Exim is zero only if there were no errors. It is 1 if some
34387 messages were accepted before an error was detected, and 2 if no messages were
34388 accepted.
34389 .ecindex IIDsmtpproc1
34390 .ecindex IIDsmtpproc2
34391
34392
34393
34394 . ////////////////////////////////////////////////////////////////////////////
34395 . ////////////////////////////////////////////////////////////////////////////
34396
34397 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34398          "Customizing messages"
34399 When a message fails to be delivered, or remains on the queue for more than a
34400 configured amount of time, Exim sends a message to the original sender, or
34401 to an alternative configured address. The text of these messages is built into
34402 the code of Exim, but it is possible to change it, either by adding a single
34403 string, or by replacing each of the paragraphs by text supplied in a file.
34404
34405 The &'From:'& and &'To:'& header lines are automatically generated; you can
34406 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34407 option. Exim also adds the line
34408 .code
34409 Auto-Submitted: auto-generated
34410 .endd
34411 to all warning and bounce messages,
34412
34413
34414 .section "Customizing bounce messages" "SECID239"
34415 .cindex "customizing" "bounce message"
34416 .cindex "bounce message" "customizing"
34417 If &%bounce_message_text%& is set, its contents are included in the default
34418 message immediately after &"This message was created automatically by mail
34419 delivery software."& The string is not expanded. It is not used if
34420 &%bounce_message_file%& is set.
34421
34422 When &%bounce_message_file%& is set, it must point to a template file for
34423 constructing error messages. The file consists of a series of text items,
34424 separated by lines consisting of exactly four asterisks. If the file cannot be
34425 opened, default text is used and a message is written to the main and panic
34426 logs. If any text item in the file is empty, default text is used for that
34427 item.
34428
34429 .vindex "&$bounce_recipient$&"
34430 .vindex "&$bounce_return_size_limit$&"
34431 Each item of text that is read from the file is expanded, and there are two
34432 expansion variables which can be of use here: &$bounce_recipient$& is set to
34433 the recipient of an error message while it is being created, and
34434 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34435 option, rounded to a whole number.
34436
34437 The items must appear in the file in the following order:
34438
34439 .ilist
34440 The first item is included in the headers, and should include at least a
34441 &'Subject:'& header. Exim does not check the syntax of these headers.
34442 .next
34443 The second item forms the start of the error message. After it, Exim lists the
34444 failing addresses with their error messages.
34445 .next
34446 The third item is used to introduce any text from pipe transports that is to be
34447 returned to the sender. It is omitted if there is no such text.
34448 .next
34449 The fourth, fifth and sixth items will be ignored and may be empty.
34450 The fields exist for back-compatibility
34451 .endlist
34452
34453 The default state (&%bounce_message_file%& unset) is equivalent to the
34454 following file, in which the sixth item is empty. The &'Subject:'& and some
34455 other lines have been split in order to fit them on the page:
34456 .code
34457 Subject: Mail delivery failed
34458   ${if eq{$sender_address}{$bounce_recipient}
34459   {: returning message to sender}}
34460 ****
34461 This message was created automatically by mail delivery software.
34462
34463 A message ${if eq{$sender_address}{$bounce_recipient}
34464   {that you sent }{sent by
34465
34466 <$sender_address>
34467
34468 }}could not be delivered to all of its recipients.
34469 This is a permanent error. The following address(es) failed:
34470 ****
34471 The following text was generated during the delivery attempt(s):
34472 ****
34473 ------ This is a copy of the message, including all the headers.
34474   ------
34475 ****
34476 ------ The body of the message is $message_size characters long;
34477   only the first
34478 ------ $bounce_return_size_limit or so are included here.
34479 ****
34480 .endd
34481 .section "Customizing warning messages" "SECTcustwarn"
34482 .cindex "customizing" "warning message"
34483 .cindex "warning of delay" "customizing the message"
34484 The option &%warn_message_file%& can be pointed at a template file for use when
34485 warnings about message delays are created. In this case there are only three
34486 text sections:
34487
34488 .ilist
34489 The first item is included in the headers, and should include at least a
34490 &'Subject:'& header. Exim does not check the syntax of these headers.
34491 .next
34492 The second item forms the start of the warning message. After it, Exim lists
34493 the delayed addresses.
34494 .next
34495 The third item then ends the message.
34496 .endlist
34497
34498 The default state is equivalent to the following file, except that some lines
34499 have been split here, in order to fit them on the page:
34500 .code
34501 Subject: Warning: message $message_exim_id delayed
34502   $warn_message_delay
34503 ****
34504 This message was created automatically by mail delivery software.
34505
34506 A message ${if eq{$sender_address}{$warn_message_recipients}
34507 {that you sent }{sent by
34508
34509 <$sender_address>
34510
34511 }}has not been delivered to all of its recipients after
34512 more than $warn_message_delay on the queue on $primary_hostname.
34513
34514 The message identifier is:     $message_exim_id
34515 The subject of the message is: $h_subject
34516 The date of the message is:    $h_date
34517
34518 The following address(es) have not yet been delivered:
34519 ****
34520 No action is required on your part. Delivery attempts will
34521 continue for some time, and this warning may be repeated at
34522 intervals if the message remains undelivered. Eventually the
34523 mail delivery software will give up, and when that happens,
34524 the message will be returned to you.
34525 .endd
34526 .vindex "&$warn_message_delay$&"
34527 .vindex "&$warn_message_recipients$&"
34528 However, in the default state the subject and date lines are omitted if no
34529 appropriate headers exist. During the expansion of this file,
34530 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34531 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34532 of recipients for the warning message. There may be more than one if there are
34533 multiple addresses with different &%errors_to%& settings on the routers that
34534 handled them.
34535
34536
34537
34538
34539 . ////////////////////////////////////////////////////////////////////////////
34540 . ////////////////////////////////////////////////////////////////////////////
34541
34542 .chapter "Some common configuration settings" "CHAPcomconreq"
34543 This chapter discusses some configuration settings that seem to be fairly
34544 common. More examples and discussion can be found in the Exim book.
34545
34546
34547
34548 .section "Sending mail to a smart host" "SECID240"
34549 .cindex "smart host" "example router"
34550 If you want to send all mail for non-local domains to a &"smart host"&, you
34551 should replace the default &(dnslookup)& router with a router which does the
34552 routing explicitly:
34553 .code
34554 send_to_smart_host:
34555   driver = manualroute
34556   route_list = !+local_domains smart.host.name
34557   transport = remote_smtp
34558 .endd
34559 You can use the smart host's IP address instead of the name if you wish.
34560 If you are using Exim only to submit messages to a smart host, and not for
34561 receiving incoming messages, you can arrange for it to do the submission
34562 synchronously by setting the &%mua_wrapper%& option (see chapter
34563 &<<CHAPnonqueueing>>&).
34564
34565
34566
34567
34568 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34569 .cindex "mailing lists"
34570 Exim can be used to run simple mailing lists, but for large and/or complicated
34571 requirements, the use of additional specialized mailing list software such as
34572 Majordomo or Mailman is recommended.
34573
34574 The &(redirect)& router can be used to handle mailing lists where each list
34575 is maintained in a separate file, which can therefore be managed by an
34576 independent manager. The &%domains%& router option can be used to run these
34577 lists in a separate domain from normal mail. For example:
34578 .code
34579 lists:
34580   driver = redirect
34581   domains = lists.example
34582   file = /usr/lists/$local_part
34583   forbid_pipe
34584   forbid_file
34585   errors_to = $local_part-request@lists.example
34586   no_more
34587 .endd
34588 This router is skipped for domains other than &'lists.example'&. For addresses
34589 in that domain, it looks for a file that matches the local part. If there is no
34590 such file, the router declines, but because &%no_more%& is set, no subsequent
34591 routers are tried, and so the whole delivery fails.
34592
34593 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34594 expanded into a file name or a pipe delivery, which is usually inappropriate in
34595 a mailing list.
34596
34597 .oindex "&%errors_to%&"
34598 The &%errors_to%& option specifies that any delivery errors caused by addresses
34599 taken from a mailing list are to be sent to the given address rather than the
34600 original sender of the message. However, before acting on this, Exim verifies
34601 the error address, and ignores it if verification fails.
34602
34603 For example, using the configuration above, mail sent to
34604 &'dicts@lists.example'& is passed on to those addresses contained in
34605 &_/usr/lists/dicts_&, with error reports directed to
34606 &'dicts-request@lists.example'&, provided that this address can be verified.
34607 There could be a file called &_/usr/lists/dicts-request_& containing
34608 the address(es) of this particular list's manager(s), but other approaches,
34609 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34610 or &%local_part_suffix%& options) to handle addresses of the form
34611 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34612
34613
34614
34615 .section "Syntax errors in mailing lists" "SECID241"
34616 .cindex "mailing lists" "syntax errors in"
34617 If an entry in redirection data contains a syntax error, Exim normally defers
34618 delivery of the original address. That means that a syntax error in a mailing
34619 list holds up all deliveries to the list. This may not be appropriate when a
34620 list is being maintained automatically from data supplied by users, and the
34621 addresses are not rigorously checked.
34622
34623 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34624 entries that fail to parse, noting the incident in the log. If in addition
34625 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34626 whenever a broken address is skipped. It is usually appropriate to set
34627 &%syntax_errors_to%& to the same address as &%errors_to%&.
34628
34629
34630
34631 .section "Re-expansion of mailing lists" "SECID242"
34632 .cindex "mailing lists" "re-expansion of"
34633 Exim remembers every individual address to which a message has been delivered,
34634 in order to avoid duplication, but it normally stores only the original
34635 recipient addresses with a message. If all the deliveries to a mailing list
34636 cannot be done at the first attempt, the mailing list is re-expanded when the
34637 delivery is next tried. This means that alterations to the list are taken into
34638 account at each delivery attempt, so addresses that have been added to
34639 the list since the message arrived will therefore receive a copy of the
34640 message, even though it pre-dates their subscription.
34641
34642 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34643 on the &(redirect)& router. If this is done, any addresses generated by the
34644 router that fail to deliver at the first attempt are added to the message as
34645 &"top level"& addresses, and the parent address that generated them is marked
34646 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34647 subsequent delivery attempts. The disadvantage of this is that if any of the
34648 failing addresses are incorrect, correcting them in the file has no effect on
34649 pre-existing messages.
34650
34651 The original top-level address is remembered with each of the generated
34652 addresses, and is output in any log messages. However, any intermediate parent
34653 addresses are not recorded. This makes a difference to the log only if the
34654 &%all_parents%& selector is set, but for mailing lists there is normally only
34655 one level of expansion anyway.
34656
34657
34658
34659 .section "Closed mailing lists" "SECID243"
34660 .cindex "mailing lists" "closed"
34661 The examples so far have assumed open mailing lists, to which anybody may
34662 send mail. It is also possible to set up closed lists, where mail is accepted
34663 from specified senders only. This is done by making use of the generic
34664 &%senders%& option to restrict the router that handles the list.
34665
34666 The following example uses the same file as a list of recipients and as a list
34667 of permitted senders. It requires three routers:
34668 .code
34669 lists_request:
34670   driver = redirect
34671   domains = lists.example
34672   local_part_suffix = -request
34673   file = /usr/lists/$local_part$local_part_suffix
34674   no_more
34675
34676 lists_post:
34677   driver = redirect
34678   domains = lists.example
34679   senders = ${if exists {/usr/lists/$local_part}\
34680              {lsearch;/usr/lists/$local_part}{*}}
34681   file = /usr/lists/$local_part
34682   forbid_pipe
34683   forbid_file
34684   errors_to = $local_part-request@lists.example
34685   no_more
34686
34687 lists_closed:
34688   driver = redirect
34689   domains = lists.example
34690   allow_fail
34691   data = :fail: $local_part@lists.example is a closed mailing list
34692 .endd
34693 All three routers have the same &%domains%& setting, so for any other domains,
34694 they are all skipped. The first router runs only if the local part ends in
34695 &%-request%&. It handles messages to the list manager(s) by means of an open
34696 mailing list.
34697
34698 The second router runs only if the &%senders%& precondition is satisfied. It
34699 checks for the existence of a list that corresponds to the local part, and then
34700 checks that the sender is on the list by means of a linear search. It is
34701 necessary to check for the existence of the file before trying to search it,
34702 because otherwise Exim thinks there is a configuration error. If the file does
34703 not exist, the expansion of &%senders%& is *, which matches all senders. This
34704 means that the router runs, but because there is no list, declines, and
34705 &%no_more%& ensures that no further routers are run. The address fails with an
34706 &"unrouteable address"& error.
34707
34708 The third router runs only if the second router is skipped, which happens when
34709 a mailing list exists, but the sender is not on it. This router forcibly fails
34710 the address, giving a suitable error message.
34711
34712
34713
34714
34715 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34716 .cindex "VERP"
34717 .cindex "Variable Envelope Return Paths"
34718 .cindex "envelope sender"
34719 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34720 are a way of helping mailing list administrators discover which subscription
34721 address is the cause of a particular delivery failure. The idea is to encode
34722 the original recipient address in the outgoing envelope sender address, so that
34723 if the message is forwarded by another host and then subsequently bounces, the
34724 original recipient can be extracted from the recipient address of the bounce.
34725
34726 .oindex &%errors_to%&
34727 .oindex &%return_path%&
34728 Envelope sender addresses can be modified by Exim using two different
34729 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34730 list examples), or the &%return_path%& option on a transport. The second of
34731 these is effective only if the message is successfully delivered to another
34732 host; it is not used for errors detected on the local host (see the description
34733 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34734 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34735 .code
34736 verp_smtp:
34737   driver = smtp
34738   max_rcpt = 1
34739   return_path = \
34740     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34741       {$1-request+$local_part=$domain@your.dom.example}fail}
34742 .endd
34743 This has the effect of rewriting the return path (envelope sender) on outgoing
34744 SMTP messages, if the local part of the original return path ends in
34745 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34746 local part and domain of the recipient into the return path. Suppose, for
34747 example, that a message whose return path has been set to
34748 &'somelist-request@your.dom.example'& is sent to
34749 &'subscriber@other.dom.example'&. In the transport, the return path is
34750 rewritten as
34751 .code
34752 somelist-request+subscriber=other.dom.example@your.dom.example
34753 .endd
34754 .vindex "&$local_part$&"
34755 For this to work, you must tell Exim to send multiple copies of messages that
34756 have more than one recipient, so that each copy has just one recipient. This is
34757 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34758 might be sent to several different recipients in the same domain, in which case
34759 &$local_part$& is not available in the transport, because it is not unique.
34760
34761 Unless your host is doing nothing but mailing list deliveries, you should
34762 probably use a separate transport for the VERP deliveries, so as not to use
34763 extra resources in making one-per-recipient copies for other deliveries. This
34764 can easily be done by expanding the &%transport%& option in the router:
34765 .code
34766 dnslookup:
34767   driver = dnslookup
34768   domains = ! +local_domains
34769   transport = \
34770     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34771       {verp_smtp}{remote_smtp}}
34772   no_more
34773 .endd
34774 If you want to change the return path using &%errors_to%& in a router instead
34775 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34776 routers that handle mailing list addresses. This will ensure that all delivery
34777 errors, including those detected on the local host, are sent to the VERP
34778 address.
34779
34780 On a host that does no local deliveries and has no manual routing, only the
34781 &(dnslookup)& router needs to be changed. A special transport is not needed for
34782 SMTP deliveries. Every mailing list recipient has its own return path value,
34783 and so Exim must hand them to the transport one at a time. Here is an example
34784 of a &(dnslookup)& router that implements VERP:
34785 .code
34786 verp_dnslookup:
34787   driver = dnslookup
34788   domains = ! +local_domains
34789   transport = remote_smtp
34790   errors_to = \
34791     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34792      {$1-request+$local_part=$domain@your.dom.example}fail}
34793   no_more
34794 .endd
34795 Before you start sending out messages with VERPed return paths, you must also
34796 configure Exim to accept the bounce messages that come back to those paths.
34797 Typically this is done by setting a &%local_part_suffix%& option for a
34798 router, and using this to route the messages to wherever you want to handle
34799 them.
34800
34801 The overhead incurred in using VERP depends very much on the size of the
34802 message, the number of recipient addresses that resolve to the same remote
34803 host, and the speed of the connection over which the message is being sent. If
34804 a lot of addresses resolve to the same host and the connection is slow, sending
34805 a separate copy of the message for each address may take substantially longer
34806 than sending a single copy with many recipients (for which VERP cannot be
34807 used).
34808
34809
34810
34811
34812
34813
34814 .section "Virtual domains" "SECTvirtualdomains"
34815 .cindex "virtual domains"
34816 .cindex "domain" "virtual"
34817 The phrase &'virtual domain'& is unfortunately used with two rather different
34818 meanings:
34819
34820 .ilist
34821 A domain for which there are no real mailboxes; all valid local parts are
34822 aliases for other email addresses. Common examples are organizational
34823 top-level domains and &"vanity"& domains.
34824 .next
34825 One of a number of independent domains that are all handled by the same host,
34826 with mailboxes on that host, but where the mailbox owners do not necessarily
34827 have login accounts on that host.
34828 .endlist
34829
34830 The first usage is probably more common, and does seem more &"virtual"& than
34831 the second. This kind of domain can be handled in Exim with a straightforward
34832 aliasing router. One approach is to create a separate alias file for each
34833 virtual domain. Exim can test for the existence of the alias file to determine
34834 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34835 to a router of this form:
34836 .code
34837 virtual:
34838   driver = redirect
34839   domains = dsearch;/etc/mail/virtual
34840   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34841   no_more
34842 .endd
34843 The &%domains%& option specifies that the router is to be skipped, unless there
34844 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34845 domain that is being processed. When the router runs, it looks up the local
34846 part in the file to find a new address (or list of addresses). The &%no_more%&
34847 setting ensures that if the lookup fails (leading to &%data%& being an empty
34848 string), Exim gives up on the address without trying any subsequent routers.
34849
34850 This one router can handle all the virtual domains because the alias file names
34851 follow a fixed pattern. Permissions can be arranged so that appropriate people
34852 can edit the different alias files. A successful aliasing operation results in
34853 a new envelope recipient address, which is then routed from scratch.
34854
34855 The other kind of &"virtual"& domain can also be handled in a straightforward
34856 way. One approach is to create a file for each domain containing a list of
34857 valid local parts, and use it in a router like this:
34858 .code
34859 my_domains:
34860   driver = accept
34861   domains = dsearch;/etc/mail/domains
34862   local_parts = lsearch;/etc/mail/domains/$domain
34863   transport = my_mailboxes
34864 .endd
34865 The address is accepted if there is a file for the domain, and the local part
34866 can be found in the file. The &%domains%& option is used to check for the
34867 file's existence because &%domains%& is tested before the &%local_parts%&
34868 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34869 because that option is tested after &%local_parts%&. The transport is as
34870 follows:
34871 .code
34872 my_mailboxes:
34873   driver = appendfile
34874   file = /var/mail/$domain/$local_part
34875   user = mail
34876 .endd
34877 This uses a directory of mailboxes for each domain. The &%user%& setting is
34878 required, to specify which uid is to be used for writing to the mailboxes.
34879
34880 The configuration shown here is just one example of how you might support this
34881 requirement. There are many other ways this kind of configuration can be set
34882 up, for example, by using a database instead of separate files to hold all the
34883 information about the domains.
34884
34885
34886
34887 .section "Multiple user mailboxes" "SECTmulbox"
34888 .cindex "multiple mailboxes"
34889 .cindex "mailbox" "multiple"
34890 .cindex "local part" "prefix"
34891 .cindex "local part" "suffix"
34892 Heavy email users often want to operate with multiple mailboxes, into which
34893 incoming mail is automatically sorted. A popular way of handling this is to
34894 allow users to use multiple sender addresses, so that replies can easily be
34895 identified. Users are permitted to add prefixes or suffixes to their local
34896 parts for this purpose. The wildcard facility of the generic router options
34897 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34898 example, consider this router:
34899 .code
34900 userforward:
34901   driver = redirect
34902   check_local_user
34903   file = $home/.forward
34904   local_part_suffix = -*
34905   local_part_suffix_optional
34906   allow_filter
34907 .endd
34908 .vindex "&$local_part_suffix$&"
34909 It runs a user's &_.forward_& file for all local parts of the form
34910 &'username-*'&. Within the filter file the user can distinguish different
34911 cases by testing the variable &$local_part_suffix$&. For example:
34912 .code
34913 if $local_part_suffix contains -special then
34914 save /home/$local_part/Mail/special
34915 endif
34916 .endd
34917 If the filter file does not exist, or does not deal with such addresses, they
34918 fall through to subsequent routers, and, assuming no subsequent use of the
34919 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34920 control over which suffixes are valid.
34921
34922 Alternatively, a suffix can be used to trigger the use of a different
34923 &_.forward_& file &-- which is the way a similar facility is implemented in
34924 another MTA:
34925 .code
34926 userforward:
34927   driver = redirect
34928   check_local_user
34929   file = $home/.forward$local_part_suffix
34930   local_part_suffix = -*
34931   local_part_suffix_optional
34932   allow_filter
34933 .endd
34934 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34935 example, &_.forward-special_& is used. Once again, if the appropriate file
34936 does not exist, or does not deal with the address, it is passed on to
34937 subsequent routers, which could, if required, look for an unqualified
34938 &_.forward_& file to use as a default.
34939
34940
34941
34942 .section "Simplified vacation processing" "SECID244"
34943 .cindex "vacation processing"
34944 The traditional way of running the &'vacation'& program is for a user to set up
34945 a pipe command in a &_.forward_& file
34946 (see section &<<SECTspecitredli>>& for syntax details).
34947 This is prone to error by inexperienced users. There are two features of Exim
34948 that can be used to make this process simpler for users:
34949
34950 .ilist
34951 A local part prefix such as &"vacation-"& can be specified on a router which
34952 can cause the message to be delivered directly to the &'vacation'& program, or
34953 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34954 &_.forward_& file are then much simpler. For example:
34955 .code
34956 spqr, vacation-spqr
34957 .endd
34958 .next
34959 The &%require_files%& generic router option can be used to trigger a
34960 vacation delivery by checking for the existence of a certain file in the
34961 user's home directory. The &%unseen%& generic option should also be used, to
34962 ensure that the original delivery also proceeds. In this case, all the user has
34963 to do is to create a file called, say, &_.vacation_&, containing a vacation
34964 message.
34965 .endlist
34966
34967 Another advantage of both these methods is that they both work even when the
34968 use of arbitrary pipes by users is locked out.
34969
34970
34971
34972 .section "Taking copies of mail" "SECID245"
34973 .cindex "message" "copying every"
34974 Some installations have policies that require archive copies of all messages to
34975 be made. A single copy of each message can easily be taken by an appropriate
34976 command in a system filter, which could, for example, use a different file for
34977 each day's messages.
34978
34979 There is also a shadow transport mechanism that can be used to take copies of
34980 messages that are successfully delivered by local transports, one copy per
34981 delivery. This could be used, &'inter alia'&, to implement automatic
34982 notification of delivery by sites that insist on doing such things.
34983
34984
34985
34986 .section "Intermittently connected hosts" "SECID246"
34987 .cindex "intermittently connected hosts"
34988 It has become quite common (because it is cheaper) for hosts to connect to the
34989 Internet periodically rather than remain connected all the time. The normal
34990 arrangement is that mail for such hosts accumulates on a system that is
34991 permanently connected.
34992
34993 Exim was designed for use on permanently connected hosts, and so it is not
34994 particularly well-suited to use in an intermittently connected environment.
34995 Nevertheless there are some features that can be used.
34996
34997
34998 .section "Exim on the upstream server host" "SECID247"
34999 It is tempting to arrange for incoming mail for the intermittently connected
35000 host to remain on Exim's queue until the client connects. However, this
35001 approach does not scale very well. Two different kinds of waiting message are
35002 being mixed up in the same queue &-- those that cannot be delivered because of
35003 some temporary problem, and those that are waiting for their destination host
35004 to connect. This makes it hard to manage the queue, as well as wasting
35005 resources, because each queue runner scans the entire queue.
35006
35007 A better approach is to separate off those messages that are waiting for an
35008 intermittently connected host. This can be done by delivering these messages
35009 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35010 format, from where they are transmitted by other software when their
35011 destination connects. This makes it easy to collect all the mail for one host
35012 in a single directory, and to apply local timeout rules on a per-message basis
35013 if required.
35014
35015 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35016 you are doing this, you should configure Exim with a long retry period for the
35017 intermittent host. For example:
35018 .code
35019 cheshire.wonderland.fict.example    *   F,5d,24h
35020 .endd
35021 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35022 which messages it has queued up for that host. Once the intermittent host comes
35023 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35024 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35025 causes all the queued up messages to be delivered, often down a single SMTP
35026 connection. While the host remains connected, any new messages get delivered
35027 immediately.
35028
35029 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35030 issued with a different IP address each time it connects, Exim's retry
35031 mechanisms on the holding host get confused, because the IP address is normally
35032 used as part of the key string for holding retry information. This can be
35033 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35034 Since this has disadvantages for permanently connected hosts, it is best to
35035 arrange a separate transport for the intermittently connected ones.
35036
35037
35038
35039 .section "Exim on the intermittently connected client host" "SECID248"
35040 The value of &%smtp_accept_queue_per_connection%& should probably be
35041 increased, or even set to zero (that is, disabled) on the intermittently
35042 connected host, so that all incoming messages down a single connection get
35043 delivered immediately.
35044
35045 .cindex "SMTP" "passed connection"
35046 .cindex "SMTP" "multiple deliveries"
35047 .cindex "multiple SMTP deliveries"
35048 Mail waiting to be sent from an intermittently connected host will probably
35049 not have been routed, because without a connection DNS lookups are not
35050 possible. This means that if a normal queue run is done at connection time,
35051 each message is likely to be sent in a separate SMTP session. This can be
35052 avoided by starting the queue run with a command line option beginning with
35053 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35054 first pass, routing is done but no deliveries take place. The second pass is a
35055 normal queue run; since all the messages have been previously routed, those
35056 destined for the same host are likely to get sent as multiple deliveries in a
35057 single SMTP connection.
35058
35059
35060
35061 . ////////////////////////////////////////////////////////////////////////////
35062 . ////////////////////////////////////////////////////////////////////////////
35063
35064 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35065          "Exim as a non-queueing client"
35066 .cindex "client, non-queueing"
35067 .cindex "smart host" "suppressing queueing"
35068 On a personal computer, it is a common requirement for all
35069 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35070 configured to operate that way, for all the popular operating systems.
35071 However, there are some MUAs for Unix-like systems that cannot be so
35072 configured: they submit messages using the command line interface of
35073 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35074 messages this way.
35075
35076 If the personal computer runs continuously, there is no problem, because it can
35077 run a conventional MTA that handles delivery to the smart host, and deal with
35078 any delays via its queueing mechanism. However, if the computer does not run
35079 continuously or runs different operating systems at different times, queueing
35080 email is not desirable.
35081
35082 There is therefore a requirement for something that can provide the
35083 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35084 any queueing or retrying facilities. Furthermore, the delivery to the smart
35085 host should be synchronous, so that if it fails, the sending MUA is immediately
35086 informed. In other words, we want something that extends an MUA that submits
35087 to a local MTA via the command line so that it behaves like one that submits
35088 to a remote smart host using TCP/SMTP.
35089
35090 There are a number of applications (for example, there is one called &'ssmtp'&)
35091 that do this job. However, people have found them to be lacking in various
35092 ways. For instance, you might want to allow aliasing and forwarding to be done
35093 before sending a message to the smart host.
35094
35095 Exim already had the necessary infrastructure for doing this job. Just a few
35096 tweaks were needed to make it behave as required, though it is somewhat of an
35097 overkill to use a fully-featured MTA for this purpose.
35098
35099 .oindex "&%mua_wrapper%&"
35100 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35101 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35102 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35103 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35104 compatible router and transport configuration. Typically there will be just one
35105 router and one transport, sending everything to a smart host.
35106
35107 When run in MUA wrapping mode, the behaviour of Exim changes in the
35108 following ways:
35109
35110 .ilist
35111 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35112 In other words, the only way to submit messages is via the command line.
35113 .next
35114 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35115 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35116 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35117 does not finish until the delivery attempt is complete. If the delivery is
35118 successful, a zero return code is given.
35119 .next
35120 Address redirection is permitted, but the final routing for all addresses must
35121 be to the same remote transport, and to the same list of hosts. Furthermore,
35122 the return address (envelope sender) must be the same for all recipients, as
35123 must any added or deleted header lines. In other words, it must be possible to
35124 deliver the message in a single SMTP transaction, however many recipients there
35125 are.
35126 .next
35127 If these conditions are not met, or if routing any address results in a
35128 failure or defer status, or if Exim is unable to deliver all the recipients
35129 successfully to one of the smart hosts, delivery of the entire message fails.
35130 .next
35131 Because no queueing is allowed, all failures are treated as permanent; there
35132 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35133 smart host. Furthermore, because only a single yes/no response can be given to
35134 the caller, it is not possible to deliver to some recipients and not others. If
35135 there is an error (temporary or permanent) for any recipient, all are failed.
35136 .next
35137 If more than one smart host is listed, Exim will try another host after a
35138 connection failure or a timeout, in the normal way. However, if this kind of
35139 failure happens for all the hosts, the delivery fails.
35140 .next
35141 When delivery fails, an error message is written to the standard error stream
35142 (as well as to Exim's log), and Exim exits to the caller with a return code
35143 value 1. The message is expunged from Exim's spool files. No bounce messages
35144 are ever generated.
35145 .next
35146 No retry data is maintained, and any retry rules are ignored.
35147 .next
35148 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35149 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35150 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35151 .endlist
35152
35153 The overall effect is that Exim makes a single synchronous attempt to deliver
35154 the message, failing if there is any kind of problem. Because no local
35155 deliveries are done and no daemon can be run, Exim does not need root
35156 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35157 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35158 the advantages and disadvantages of running without root privilege.
35159
35160
35161
35162
35163 . ////////////////////////////////////////////////////////////////////////////
35164 . ////////////////////////////////////////////////////////////////////////////
35165
35166 .chapter "Log files" "CHAPlog"
35167 .scindex IIDloggen "log" "general description"
35168 .cindex "log" "types of"
35169 Exim writes three different logs, referred to as the main log, the reject log,
35170 and the panic log:
35171
35172 .ilist
35173 .cindex "main log"
35174 The main log records the arrival of each message and each delivery in a single
35175 line in each case. The format is as compact as possible, in an attempt to keep
35176 down the size of log files. Two-character flag sequences make it easy to pick
35177 out these lines. A number of other events are recorded in the main log. Some of
35178 them are optional, in which case the &%log_selector%& option controls whether
35179 they are included or not. A Perl script called &'eximstats'&, which does simple
35180 analysis of main log files, is provided in the Exim distribution (see section
35181 &<<SECTmailstat>>&).
35182 .next
35183 .cindex "reject log"
35184 The reject log records information from messages that are rejected as a result
35185 of a configuration option (that is, for policy reasons).
35186 The first line of each rejection is a copy of the line that is also written to
35187 the main log. Then, if the message's header has been read at the time the log
35188 is written, its contents are written to this log. Only the original header
35189 lines are available; header lines added by ACLs are not logged. You can use the
35190 reject log to check that your policy controls are working correctly; on a busy
35191 host this may be easier than scanning the main log for rejection messages. You
35192 can suppress the writing of the reject log by setting &%write_rejectlog%&
35193 false.
35194 .next
35195 .cindex "panic log"
35196 .cindex "system log"
35197 When certain serious errors occur, Exim writes entries to its panic log. If the
35198 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35199 are usually written to the main log as well, but can get lost amid the mass of
35200 other entries. The panic log should be empty under normal circumstances. It is
35201 therefore a good idea to check it (or to have a &'cron'& script check it)
35202 regularly, in order to become aware of any problems. When Exim cannot open its
35203 panic log, it tries as a last resort to write to the system log (syslog). This
35204 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35205 message itself is written at priority LOG_CRIT.
35206 .endlist
35207
35208 Every log line starts with a timestamp, in the format shown in the following
35209 example. Note that many of the examples shown in this chapter are line-wrapped.
35210 In the log file, this would be all on one line:
35211 .code
35212 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35213   by QUIT
35214 .endd
35215 By default, the timestamps are in the local timezone. There are two
35216 ways of changing this:
35217
35218 .ilist
35219 You can set the &%timezone%& option to a different time zone; in particular, if
35220 you set
35221 .code
35222 timezone = UTC
35223 .endd
35224 the timestamps will be in UTC (aka GMT).
35225 .next
35226 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35227 example:
35228 .code
35229 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35230 .endd
35231 .endlist
35232
35233 .cindex "log" "process ids in"
35234 .cindex "pid (process id)" "in log lines"
35235 Exim does not include its process id in log lines by default, but you can
35236 request that it does so by specifying the &`pid`& log selector (see section
35237 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35238 brackets, immediately after the time and date.
35239
35240
35241
35242
35243 .section "Where the logs are written" "SECTwhelogwri"
35244 .cindex "log" "destination"
35245 .cindex "log" "to file"
35246 .cindex "log" "to syslog"
35247 .cindex "syslog"
35248 The logs may be written to local files, or to syslog, or both. However, it
35249 should be noted that many syslog implementations use UDP as a transport, and
35250 are therefore unreliable in the sense that messages are not guaranteed to
35251 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35252 It has also been reported that on large log files (tens of megabytes) you may
35253 need to tweak syslog to prevent it syncing the file with each write &-- on
35254 Linux this has been seen to make syslog take 90% plus of CPU time.
35255
35256 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35257 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35258 configuration. This latter string is expanded, so it can contain, for example,
35259 references to the host name:
35260 .code
35261 log_file_path = /var/log/$primary_hostname/exim_%slog
35262 .endd
35263 It is generally advisable, however, to set the string in &_Local/Makefile_&
35264 rather than at run time, because then the setting is available right from the
35265 start of Exim's execution. Otherwise, if there's something it wants to log
35266 before it has read the configuration file (for example, an error in the
35267 configuration file) it will not use the path you want, and may not be able to
35268 log at all.
35269
35270 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35271 list, currently limited to at most two items. This is one option where the
35272 facility for changing a list separator may not be used. The list must always be
35273 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35274 otherwise the item must either be an absolute path, containing &`%s`& at the
35275 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35276 implying the use of a default path.
35277
35278 When Exim encounters an empty item in the list, it searches the list defined by
35279 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35280 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35281 mean &"use the path specified at build time"&. It no such item exists, log
35282 files are written in the &_log_& subdirectory of the spool directory. This is
35283 equivalent to the setting:
35284 .code
35285 log_file_path = $spool_directory/log/%slog
35286 .endd
35287 If you do not specify anything at build time or run time,
35288 or if you unset the option at run time (i.e. &`log_file_path = `&),
35289 that is where the logs are written.
35290
35291 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35292 are in use &-- see section &<<SECTdatlogfil>>& below.
35293
35294 Here are some examples of possible settings:
35295 .display
35296 &`LOG_FILE_PATH=syslog                    `& syslog only
35297 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35298 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35299 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35300 .endd
35301 If there are more than two paths in the list, the first is used and a panic
35302 error is logged.
35303
35304
35305
35306 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35307 .cindex "log" "cycling local files"
35308 .cindex "cycling logs"
35309 .cindex "&'exicyclog'&"
35310 .cindex "log" "local files; writing to"
35311 Some operating systems provide centralized and standardized methods for cycling
35312 log files. For those that do not, a utility script called &'exicyclog'& is
35313 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35314 main and reject logs each time it is called. The maximum number of old logs to
35315 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35316
35317 An Exim delivery process opens the main log when it first needs to write to it,
35318 and it keeps the file open in case subsequent entries are required &-- for
35319 example, if a number of different deliveries are being done for the same
35320 message. However, remote SMTP deliveries can take a long time, and this means
35321 that the file may be kept open long after it is renamed if &'exicyclog'& or
35322 something similar is being used to rename log files on a regular basis. To
35323 ensure that a switch of log files is noticed as soon as possible, Exim calls
35324 &[stat()]& on the main log's name before reusing an open file, and if the file
35325 does not exist, or its inode has changed, the old file is closed and Exim
35326 tries to open the main log from scratch. Thus, an old log file may remain open
35327 for quite some time, but no Exim processes should write to it once it has been
35328 renamed.
35329
35330
35331
35332 .section "Datestamped log files" "SECTdatlogfil"
35333 .cindex "log" "datestamped files"
35334 Instead of cycling the main and reject log files by renaming them
35335 periodically, some sites like to use files whose names contain a datestamp,
35336 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35337 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35338 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35339 point where the datestamp is required. For example:
35340 .code
35341 log_file_path = /var/spool/exim/log/%slog-%D
35342 log_file_path = /var/log/exim-%s-%D.log
35343 log_file_path = /var/spool/exim/log/%D-%slog
35344 log_file_path = /var/log/exim/%s.%M
35345 .endd
35346 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35347 examples of names generated by the above examples:
35348 .code
35349 /var/spool/exim/log/mainlog-20021225
35350 /var/log/exim-reject-20021225.log
35351 /var/spool/exim/log/20021225-mainlog
35352 /var/log/exim/main.200212
35353 .endd
35354 When this form of log file is specified, Exim automatically switches to new
35355 files at midnight. It does not make any attempt to compress old logs; you
35356 will need to write your own script if you require this. You should not
35357 run &'exicyclog'& with this form of logging.
35358
35359 The location of the panic log is also determined by &%log_file_path%&, but it
35360 is not datestamped, because rotation of the panic log does not make sense.
35361 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35362 the string. In addition, if it immediately follows a slash, a following
35363 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35364 character is removed. Thus, the four examples above would give these panic
35365 log names:
35366 .code
35367 /var/spool/exim/log/paniclog
35368 /var/log/exim-panic.log
35369 /var/spool/exim/log/paniclog
35370 /var/log/exim/panic
35371 .endd
35372
35373
35374 .section "Logging to syslog" "SECID249"
35375 .cindex "log" "syslog; writing to"
35376 The use of syslog does not change what Exim logs or the format of its messages,
35377 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35378 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35379 that, the same strings are written to syslog as to log files. The syslog
35380 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35381 by default, but you can change these by setting the &%syslog_facility%& and
35382 &%syslog_processname%& options, respectively. If Exim was compiled with
35383 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35384 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35385 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35386 the time and host name to each line.
35387 The three log streams are mapped onto syslog priorities as follows:
35388
35389 .ilist
35390 &'mainlog'& is mapped to LOG_INFO
35391 .next
35392 &'rejectlog'& is mapped to LOG_NOTICE
35393 .next
35394 &'paniclog'& is mapped to LOG_ALERT
35395 .endlist
35396
35397 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35398 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35399 these are routed by syslog to the same place. You can suppress this duplication
35400 by setting &%syslog_duplication%& false.
35401
35402 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35403 entries contain multiple lines when headers are included. To cope with both
35404 these cases, entries written to syslog are split into separate &[syslog()]&
35405 calls at each internal newline, and also after a maximum of
35406 870 data characters. (This allows for a total syslog line length of 1024, when
35407 additions such as timestamps are added.) If you are running a syslog
35408 replacement that can handle lines longer than the 1024 characters allowed by
35409 RFC 3164, you should set
35410 .code
35411 SYSLOG_LONG_LINES=yes
35412 .endd
35413 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35414 lines, but it still splits at internal newlines in &'reject'& log entries.
35415
35416 To make it easy to re-assemble split lines later, each component of a split
35417 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35418 where <&'n'&> is the component number and <&'m'&> is the total number of
35419 components in the entry. The / delimiter is used when the line was split
35420 because it was too long; if it was split because of an internal newline, the \
35421 delimiter is used. For example, supposing the length limit to be 50 instead of
35422 870, the following would be the result of a typical rejection message to
35423 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35424 name, and pid as added by syslog:
35425 .code
35426 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35427 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35428 [3/5]  when scanning for sender: missing or malformed lo
35429 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35430 [5/5] mple>)
35431 .endd
35432 The same error might cause the following lines to be written to &"rejectlog"&
35433 (LOG_NOTICE):
35434 .code
35435 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35436 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35437 [3/18] er when scanning for sender: missing or malformed
35438 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35439 [5\18] .example>)
35440 [6\18] Recipients: ph10@some.domain.cam.example
35441 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35442 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35443 [9\18]        id 16RdAL-0006pc-00
35444 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35445 [11\18] 09:43 +0100
35446 [12\18] F From: <>
35447 [13\18]   Subject: this is a test header
35448 [18\18]   X-something: this is another header
35449 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35450 [16\18] le>
35451 [17\18] B Bcc:
35452 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35453 .endd
35454 Log lines that are neither too long nor contain newlines are written to syslog
35455 without modification.
35456
35457 If only syslog is being used, the Exim monitor is unable to provide a log tail
35458 display, unless syslog is routing &'mainlog'& to a file on the local host and
35459 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35460 where it is.
35461
35462
35463
35464 .section "Log line flags" "SECID250"
35465 One line is written to the main log for each message received, and for each
35466 successful, unsuccessful, and delayed delivery. These lines can readily be
35467 picked out by the distinctive two-character flags that immediately follow the
35468 timestamp. The flags are:
35469 .display
35470 &`<=`&     message arrival
35471 &`(=`&     message fakereject
35472 &`=>`&     normal message delivery
35473 &`->`&     additional address in same delivery
35474 &`>>`&     cutthrough message delivery
35475 &`*>`&     delivery suppressed by &%-N%&
35476 &`**`&     delivery failed; address bounced
35477 &`==`&     delivery deferred; temporary problem
35478 .endd
35479
35480
35481 .section "Logging message reception" "SECID251"
35482 .cindex "log" "reception line"
35483 The format of the single-line entry in the main log that is written for every
35484 message received is shown in the basic example below, which is split over
35485 several lines in order to fit it on the page:
35486 .code
35487 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35488   H=mailer.fict.example [192.168.123.123] U=exim
35489   P=smtp S=5678 id=<incoming message id>
35490 .endd
35491 The address immediately following &"<="& is the envelope sender address. A
35492 bounce message is shown with the sender address &"<>"&, and if it is locally
35493 generated, this is followed by an item of the form
35494 .code
35495 R=<message id>
35496 .endd
35497 which is a reference to the message that caused the bounce to be sent.
35498
35499 .cindex "HELO"
35500 .cindex "EHLO"
35501 For messages from other hosts, the H and U fields identify the remote host and
35502 record the RFC 1413 identity of the user that sent the message, if one was
35503 received. The number given in square brackets is the IP address of the sending
35504 host. If there is a single, unparenthesized  host name in the H field, as
35505 above, it has been verified to correspond to the IP address (see the
35506 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35507 by the remote host in the SMTP HELO or EHLO command, and has not been
35508 verified. If verification yields a different name to that given for HELO or
35509 EHLO, the verified name appears first, followed by the HELO or EHLO
35510 name in parentheses.
35511
35512 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35513 without brackets, in the HELO or EHLO command, leading to entries in
35514 the log containing text like these examples:
35515 .code
35516 H=(10.21.32.43) [192.168.8.34]
35517 H=([10.21.32.43]) [192.168.8.34]
35518 .endd
35519 This can be confusing. Only the final address in square brackets can be relied
35520 on.
35521
35522 For locally generated messages (that is, messages not received over TCP/IP),
35523 the H field is omitted, and the U field contains the login name of the caller
35524 of Exim.
35525
35526 .cindex "authentication" "logging"
35527 .cindex "AUTH" "logging"
35528 For all messages, the P field specifies the protocol used to receive the
35529 message. This is the value that is stored in &$received_protocol$&. In the case
35530 of incoming SMTP messages, the value indicates whether or not any SMTP
35531 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35532 session was encrypted, there is an additional X field that records the cipher
35533 suite that was used.
35534
35535 .cindex log protocol
35536 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35537 hosts that have authenticated themselves using the SMTP AUTH command. The first
35538 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35539 there is an additional item A= followed by the name of the authenticator that
35540 was used. If an authenticated identification was set up by the authenticator's
35541 &%server_set_id%& option, this is logged too, separated by a colon from the
35542 authenticator name.
35543
35544 .cindex "size" "of message"
35545 The id field records the existing message id, if present. The size of the
35546 received message is given by the S field. When the message is delivered,
35547 headers may be removed or added, so that the size of delivered copies of the
35548 message may not correspond with this value (and indeed may be different to each
35549 other).
35550
35551 The &%log_selector%& option can be used to request the logging of additional
35552 data when a message is received. See section &<<SECTlogselector>>& below.
35553
35554
35555
35556 .section "Logging deliveries" "SECID252"
35557 .cindex "log" "delivery line"
35558 The format of the single-line entry in the main log that is written for every
35559 delivery is shown in one of the examples below, for local and remote
35560 deliveries, respectively. Each example has been split into multiple lines in order
35561 to fit it on the page:
35562 .code
35563 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35564   <marv@hitch.fict.example> R=localuser T=local_delivery
35565 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35566   monk@holistic.fict.example R=dnslookup T=remote_smtp
35567   H=holistic.fict.example [192.168.234.234]
35568 .endd
35569 For ordinary local deliveries, the original address is given in angle brackets
35570 after the final delivery address, which might be a pipe or a file. If
35571 intermediate address(es) exist between the original and the final address, the
35572 last of these is given in parentheses after the final address. The R and T
35573 fields record the router and transport that were used to process the address.
35574
35575 If SMTP AUTH was used for the delivery there is an additional item A=
35576 followed by the name of the authenticator that was used.
35577 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35578 option, this is logged too, separated by a colon from the authenticator name.
35579
35580 If a shadow transport was run after a successful local delivery, the log line
35581 for the successful delivery has an item added on the end, of the form
35582 .display
35583 &`ST=<`&&'shadow transport name'&&`>`&
35584 .endd
35585 If the shadow transport did not succeed, the error message is put in
35586 parentheses afterwards.
35587
35588 .cindex "asterisk" "after IP address"
35589 When more than one address is included in a single delivery (for example, two
35590 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35591 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35592 down a single SMTP connection, an asterisk follows the IP address in the log
35593 lines for the second and subsequent messages.
35594
35595 .cindex "delivery" "cutthrough; logging"
35596 .cindex "cutthrough" "logging"
35597 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35598 line precedes the reception line, since cutthrough waits for a possible
35599 rejection from the destination in case it can reject the sourced item.
35600
35601 The generation of a reply message by a filter file gets logged as a
35602 &"delivery"& to the addressee, preceded by &">"&.
35603
35604 The &%log_selector%& option can be used to request the logging of additional
35605 data when a message is delivered. See section &<<SECTlogselector>>& below.
35606
35607
35608 .section "Discarded deliveries" "SECID253"
35609 .cindex "discarded messages"
35610 .cindex "message" "discarded"
35611 .cindex "delivery" "discarded; logging"
35612 When a message is discarded as a result of the command &"seen finish"& being
35613 obeyed in a filter file which generates no deliveries, a log entry of the form
35614 .code
35615 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35616   <low.club@bridge.example> R=userforward
35617 .endd
35618 is written, to record why no deliveries are logged. When a message is discarded
35619 because it is aliased to &":blackhole:"& the log line is like this:
35620 .code
35621 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35622   <hole@nowhere.example> R=blackhole_router
35623 .endd
35624
35625
35626 .section "Deferred deliveries" "SECID254"
35627 When a delivery is deferred, a line of the following form is logged:
35628 .code
35629 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35630   R=dnslookup T=smtp defer (146): Connection refused
35631 .endd
35632 In the case of remote deliveries, the error is the one that was given for the
35633 last IP address that was tried. Details of individual SMTP failures are also
35634 written to the log, so the above line would be preceded by something like
35635 .code
35636 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35637   mail1.endrest.example [192.168.239.239]: Connection refused
35638 .endd
35639 When a deferred address is skipped because its retry time has not been reached,
35640 a message is written to the log, but this can be suppressed by setting an
35641 appropriate value in &%log_selector%&.
35642
35643
35644
35645 .section "Delivery failures" "SECID255"
35646 .cindex "delivery" "failure; logging"
35647 If a delivery fails because an address cannot be routed, a line of the
35648 following form is logged:
35649 .code
35650 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35651   <jim@trek99.example>: unknown mail domain
35652 .endd
35653 If a delivery fails at transport time, the router and transport are shown, and
35654 the response from the remote host is included, as in this example:
35655 .code
35656 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35657   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35658   after pipelined RCPT TO:<ace400@pb.example>: host
35659   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35660   <ace400@pb.example>...Addressee unknown
35661 .endd
35662 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35663 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35664 disabling PIPELINING. The log lines for all forms of delivery failure are
35665 flagged with &`**`&.
35666
35667
35668
35669 .section "Fake deliveries" "SECID256"
35670 .cindex "delivery" "fake; logging"
35671 If a delivery does not actually take place because the &%-N%& option has been
35672 used to suppress it, a normal delivery line is written to the log, except that
35673 &"=>"& is replaced by &"*>"&.
35674
35675
35676
35677 .section "Completion" "SECID257"
35678 A line of the form
35679 .code
35680 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35681 .endd
35682 is written to the main log when a message is about to be removed from the spool
35683 at the end of its processing.
35684
35685
35686
35687
35688 .section "Summary of Fields in Log Lines" "SECID258"
35689 .cindex "log" "summary of fields"
35690 A summary of the field identifiers that are used in log lines is shown in
35691 the following table:
35692 .display
35693 &`A   `&        authenticator name (and optional id and sender)
35694 &`C   `&        SMTP confirmation on delivery
35695 &`    `&        command list for &"no mail in SMTP session"&
35696 &`CV  `&        certificate verification status
35697 &`D   `&        duration of &"no mail in SMTP session"&
35698 &`DN  `&        distinguished name from peer certificate
35699 &`DS  `&        DNSSEC secured lookups
35700 &`DT  `&        on &`=>`& lines: time taken for a delivery
35701 &`F   `&        sender address (on delivery lines)
35702 &`H   `&        host name and IP address
35703 &`I   `&        local interface used
35704 &`K   `&        CHUNKING extension used
35705 &`id  `&        message id for incoming message
35706 &`P   `&        on &`<=`& lines: protocol used
35707 &`    `&        on &`=>`& and &`**`& lines: return path
35708 &`PRDR`&        PRDR extension used
35709 &`PRX `&        on &'<='& and &`=>`& lines: proxy address
35710 &`Q   `&        alternate queue name
35711 &`QT  `&        on &`=>`& lines: time spent on queue so far
35712 &`    `&        on &"Completed"& lines: time spent on queue
35713 &`R   `&        on &`<=`& lines: reference for local bounce
35714 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35715 &`S   `&        size of message in bytes
35716 &`SNI `&        server name indication from TLS client hello
35717 &`ST  `&        shadow transport name
35718 &`T   `&        on &`<=`& lines: message subject (topic)
35719 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35720 &`U   `&        local user or RFC 1413 identity
35721 &`X   `&        TLS cipher suite
35722 .endd
35723
35724
35725 .section "Other log entries" "SECID259"
35726 Various other types of log entry are written from time to time. Most should be
35727 self-explanatory. Among the more common are:
35728
35729 .ilist
35730 .cindex "retry" "time not reached"
35731 &'retry time not reached'&&~&~An address previously suffered a temporary error
35732 during routing or local delivery, and the time to retry has not yet arrived.
35733 This message is not written to an individual message log file unless it happens
35734 during the first delivery attempt.
35735 .next
35736 &'retry time not reached for any host'&&~&~An address previously suffered
35737 temporary errors during remote delivery, and the retry time has not yet arrived
35738 for any of the hosts to which it is routed.
35739 .next
35740 .cindex "spool directory" "file locked"
35741 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35742 some other Exim process is already working on the message. This can be quite
35743 common if queue running processes are started at frequent intervals. The
35744 &'exiwhat'& utility script can be used to find out what Exim processes are
35745 doing.
35746 .next
35747 .cindex "error" "ignored"
35748 &'error ignored'&&~&~There are several circumstances that give rise to this
35749 message:
35750 .olist
35751 Exim failed to deliver a bounce message whose age was greater than
35752 &%ignore_bounce_errors_after%&. The bounce was discarded.
35753 .next
35754 A filter file set up a delivery using the &"noerror"& option, and the delivery
35755 failed. The delivery was discarded.
35756 .next
35757 A delivery set up by a router configured with
35758 . ==== As this is a nested list, any displays it contains must be indented
35759 . ==== as otherwise they are too far to the left.
35760 .code
35761     errors_to = <>
35762 .endd
35763 failed. The delivery was discarded.
35764 .endlist olist
35765 .endlist ilist
35766
35767
35768
35769
35770
35771 .section "Reducing or increasing what is logged" "SECTlogselector"
35772 .cindex "log" "selectors"
35773 By setting the &%log_selector%& global option, you can disable some of Exim's
35774 default logging, or you can request additional logging. The value of
35775 &%log_selector%& is made up of names preceded by plus or minus characters. For
35776 example:
35777 .code
35778 log_selector = +arguments -retry_defer
35779 .endd
35780 The list of optional log items is in the following table, with the default
35781 selection marked by asterisks:
35782 .display
35783 &` 8bitmime                   `&  received 8BITMIME status
35784 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35785 &` address_rewrite            `&  address rewriting
35786 &` all_parents                `&  all parents in => lines
35787 &` arguments                  `&  command line arguments
35788 &`*connection_reject          `&  connection rejections
35789 &`*delay_delivery             `&  immediate delivery delayed
35790 &` deliver_time               `&  time taken to perform delivery
35791 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35792 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35793 &` dnssec                     `&  DNSSEC secured lookups
35794 &`*etrn                       `&  ETRN commands
35795 &`*host_lookup_failed         `&  as it says
35796 &` ident_timeout              `&  timeout for ident connection
35797 &` incoming_interface         `&  local interface on <= and => lines
35798 &` incoming_port              `&  remote port on <= lines
35799 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35800 &` outgoing_interface         `&  local interface on => lines
35801 &` outgoing_port              `&  add remote port to => lines
35802 &`*queue_run                  `&  start and end queue runs
35803 &` queue_time                 `&  time on queue for one recipient
35804 &` queue_time_overall         `&  time on queue for whole message
35805 &` pid                        `&  Exim process id
35806 &` proxy                      `&  proxy address on <= and => lines
35807 &` received_recipients        `&  recipients on <= lines
35808 &` received_sender            `&  sender on <= lines
35809 &`*rejected_header            `&  header contents on reject log
35810 &`*retry_defer                `&  &"retry time not reached"&
35811 &` return_path_on_delivery    `&  put return path on => and ** lines
35812 &` sender_on_delivery         `&  add sender to => lines
35813 &`*sender_verify_fail         `&  sender verification failures
35814 &`*size_reject                `&  rejection because too big
35815 &`*skip_delivery              `&  delivery skipped in a queue run
35816 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35817 &` smtp_connection            `&  incoming SMTP connections
35818 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35819 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35820 &` smtp_no_mail               `&  session with no MAIL commands
35821 &` smtp_protocol_error        `&  SMTP protocol errors
35822 &` smtp_syntax_error          `&  SMTP syntax errors
35823 &` subject                    `&  contents of &'Subject:'& on <= lines
35824 &`*tls_certificate_verified   `&  certificate verification status
35825 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35826 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35827 &` tls_sni                    `&  TLS SNI on <= lines
35828 &` unknown_in_list            `&  DNS lookup failed in list match
35829
35830 &` all                        `&  all of the above
35831 .endd
35832 See also the &%slow_lookup_log%& main configuration option,
35833 section &<<SECID99>>&
35834
35835 More details on each of these items follows:
35836
35837 .ilist
35838 .cindex "8BITMIME"
35839 .cindex "log" "8BITMIME"
35840 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35841 which may help in tracking down interoperability issues with ancient MTAs
35842 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35843 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35844 &`7BIT`& and &`8BITMIME`& respectively.
35845 .next
35846 .cindex "&%warn%& ACL verb" "log when skipping"
35847 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35848 its conditions cannot be evaluated, a log line to this effect is written if
35849 this log selector is set.
35850 .next
35851 .cindex "log" "rewriting"
35852 .cindex "rewriting" "logging"
35853 &%address_rewrite%&: This applies both to global rewrites and per-transport
35854 rewrites, but not to rewrites in filters run as an unprivileged user (because
35855 such users cannot access the log).
35856 .next
35857 .cindex "log" "full parentage"
35858 &%all_parents%&: Normally only the original and final addresses are logged on
35859 delivery lines; with this selector, intermediate parents are given in
35860 parentheses between them.
35861 .next
35862 .cindex "log" "Exim arguments"
35863 .cindex "Exim arguments, logging"
35864 &%arguments%&: This causes Exim to write the arguments with which it was called
35865 to the main log, preceded by the current working directory. This is a debugging
35866 feature, added to make it easier to find out how certain MUAs call
35867 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35868 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35869 that are empty or that contain white space are quoted. Non-printing characters
35870 are shown as escape sequences. This facility cannot log unrecognized arguments,
35871 because the arguments are checked before the configuration file is read. The
35872 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35873 between the caller and Exim.
35874 .next
35875 .cindex "log" "connection rejections"
35876 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35877 connection is rejected, for whatever reason.
35878 .next
35879 .cindex "log" "delayed delivery"
35880 .cindex "delayed delivery, logging"
35881 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35882 started for an incoming message because the load is too high or too many
35883 messages were received on one connection. Logging does not occur if no delivery
35884 process is started because &%queue_only%& is set or &%-odq%& was used.
35885 .next
35886 .cindex "log" "delivery duration"
35887 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35888 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35889 .next
35890 .cindex "log" "message size on delivery"
35891 .cindex "size" "of message"
35892 &%delivery_size%&: For each delivery, the size of message delivered is added to
35893 the &"=>"& line, tagged with S=.
35894 .next
35895 .cindex "log" "dnslist defer"
35896 .cindex "DNS list" "logging defer"
35897 .cindex "black list (DNS)"
35898 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35899 DNS black list suffers a temporary error.
35900 .next
35901 .cindex log dnssec
35902 .cindex dnssec logging
35903 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
35904 dns lookups gave secure results a tag of DS is added.
35905 For acceptance this covers the reverse and forward lookups for host name verification.
35906 It does not cover helo-name verification.
35907 For delivery this covers the SRV, MX, A and/or AAAA lookups.
35908 .next
35909 .cindex "log" "ETRN commands"
35910 .cindex "ETRN" "logging"
35911 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35912 is run to determine whether or not it is actually accepted. An invalid ETRN
35913 command, or one received within a message transaction is not logged by this
35914 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35915 .next
35916 .cindex "log" "host lookup failure"
35917 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35918 any addresses, or when a lookup of an IP address fails to find a host name, a
35919 log line is written. This logging does not apply to direct DNS lookups when
35920 routing email addresses, but it does apply to &"byname"& lookups.
35921 .next
35922 .cindex "log" "ident timeout"
35923 .cindex "RFC 1413" "logging timeout"
35924 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35925 client's ident port times out.
35926 .next
35927 .cindex "log" "incoming interface"
35928 .cindex "log" "local interface"
35929 .cindex "log" "local address and port"
35930 .cindex "TCP/IP" "logging local address and port"
35931 .cindex "interface" "logging"
35932 &%incoming_interface%&: The interface on which a message was received is added
35933 to the &"<="& line as an IP address in square brackets, tagged by I= and
35934 followed by a colon and the port number. The local interface and port are also
35935 added to other SMTP log lines, for example &"SMTP connection from"&, to
35936 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35937 The latter can be disabled by turning off the &%outgoing_interface%& option.
35938 .next
35939 .cindex log "incoming proxy address"
35940 .cindex proxy "logging proxy address"
35941 .cindex "TCP/IP" "logging proxy address"
35942 &%proxy%&: The internal (closest to the system running Exim) IP address
35943 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35944 on a proxied connection
35945 or the &"=>"& line for a message delivered on a proxied connection..
35946 See &<<SECTproxyInbound>>& for more information.
35947 .next
35948 .cindex "log" "incoming remote port"
35949 .cindex "port" "logging remote"
35950 .cindex "TCP/IP" "logging incoming remote port"
35951 .vindex "&$sender_fullhost$&"
35952 .vindex "&$sender_rcvhost$&"
35953 &%incoming_port%&: The remote port number from which a message was received is
35954 added to log entries and &'Received:'& header lines, following the IP address
35955 in square brackets, and separated from it by a colon. This is implemented by
35956 changing the value that is put in the &$sender_fullhost$& and
35957 &$sender_rcvhost$& variables. Recording the remote port number has become more
35958 important with the widening use of NAT (see RFC 2505).
35959 .next
35960 .cindex "log" "dropped connection"
35961 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35962 connection is unexpectedly dropped.
35963 .next
35964 .cindex "log" "outgoing interface"
35965 .cindex "log" "local interface"
35966 .cindex "log" "local address and port"
35967 .cindex "TCP/IP" "logging local address and port"
35968 .cindex "interface" "logging"
35969 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35970 interface on which a message was sent is added to delivery lines as an I= tag
35971 followed by IP address in square brackets. You can disable this by turning
35972 off the &%outgoing_interface%& option.
35973 .next
35974 .cindex "log" "outgoing remote port"
35975 .cindex "port" "logging outgoint remote"
35976 .cindex "TCP/IP" "logging ougtoing remote port"
35977 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35978 containing => tags) following the IP address.
35979 The local port is also added if &%incoming_interface%& and
35980 &%outgoing_interface%& are both enabled.
35981 This option is not included in the default setting, because for most ordinary
35982 configurations, the remote port number is always 25 (the SMTP port), and the
35983 local port is a random ephemeral port.
35984 .next
35985 .cindex "log" "process ids in"
35986 .cindex "pid (process id)" "in log lines"
35987 &%pid%&: The current process id is added to every log line, in square brackets,
35988 immediately after the time and date.
35989 .next
35990 .cindex "log" "queue run"
35991 .cindex "queue runner" "logging"
35992 &%queue_run%&: The start and end of every queue run are logged.
35993 .next
35994 .cindex "log" "queue time"
35995 &%queue_time%&: The amount of time the message has been in the queue on the
35996 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35997 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35998 includes reception time as well as the delivery time for the current address.
35999 This means that it may be longer than the difference between the arrival and
36000 delivery log line times, because the arrival log line is not written until the
36001 message has been successfully received.
36002 .next
36003 &%queue_time_overall%&: The amount of time the message has been in the queue on
36004 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36005 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36006 message, so it includes reception time as well as the total delivery time.
36007 .next
36008 .cindex "log" "recipients"
36009 &%received_recipients%&: The recipients of a message are listed in the main log
36010 as soon as the message is received. The list appears at the end of the log line
36011 that is written when a message is received, preceded by the word &"for"&. The
36012 addresses are listed after they have been qualified, but before any rewriting
36013 has taken place.
36014 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36015 in the list.
36016 .next
36017 .cindex "log" "sender reception"
36018 &%received_sender%&: The unrewritten original sender of a message is added to
36019 the end of the log line that records the message's arrival, after the word
36020 &"from"& (before the recipients if &%received_recipients%& is also set).
36021 .next
36022 .cindex "log" "header lines for rejection"
36023 &%rejected_header%&: If a message's header has been received at the time a
36024 rejection is written to the reject log, the complete header is added to the
36025 log. Header logging can be turned off individually for messages that are
36026 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36027 .next
36028 .cindex "log" "retry defer"
36029 &%retry_defer%&: A log line is written if a delivery is deferred because a
36030 retry time has not yet been reached. However, this &"retry time not reached"&
36031 message is always omitted from individual message logs after the first delivery
36032 attempt.
36033 .next
36034 .cindex "log" "return path"
36035 &%return_path_on_delivery%&: The return path that is being transmitted with
36036 the message is included in delivery and bounce lines, using the tag P=.
36037 This is omitted if no delivery actually happens, for example, if routing fails,
36038 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36039 .next
36040 .cindex "log" "sender on delivery"
36041 &%sender_on_delivery%&: The message's sender address is added to every delivery
36042 and bounce line, tagged by F= (for &"from"&).
36043 This is the original sender that was received with the message; it is not
36044 necessarily the same as the outgoing return path.
36045 .next
36046 .cindex "log" "sender verify failure"
36047 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36048 gives details of a sender verification failure is not written. Log lines for
36049 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36050 detail is lost.
36051 .next
36052 .cindex "log" "size rejection"
36053 &%size_reject%&: A log line is written whenever a message is rejected because
36054 it is too big.
36055 .next
36056 .cindex "log" "frozen messages; skipped"
36057 .cindex "frozen messages" "logging skipping"
36058 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36059 queue run because it is frozen or because another process is already delivering
36060 it.
36061 .cindex "&""spool file is locked""&"
36062 The message that is written is &"spool file is locked"&.
36063 .next
36064 .cindex "log" "smtp confirmation"
36065 .cindex "SMTP" "logging confirmation"
36066 .cindex "LMTP" "logging confirmation"
36067 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36068 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36069 A number of MTAs (including Exim) return an identifying string in this
36070 response.
36071 .next
36072 .cindex "log" "SMTP connections"
36073 .cindex "SMTP" "logging connections"
36074 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36075 established or closed, unless the connection is from a host that matches
36076 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36077 only when the closure is unexpected.) This applies to connections from local
36078 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36079 dropped in the middle of a message, a log line is always written, whether or
36080 not this selector is set, but otherwise nothing is written at the start and end
36081 of connections unless this selector is enabled.
36082
36083 For TCP/IP connections to an Exim daemon, the current number of connections is
36084 included in the log message for each new connection, but note that the count is
36085 reset if the daemon is restarted.
36086 Also, because connections are closed (and the closure is logged) in
36087 subprocesses, the count may not include connections that have been closed but
36088 whose termination the daemon has not yet noticed. Thus, while it is possible to
36089 match up the opening and closing of connections in the log, the value of the
36090 logged counts may not be entirely accurate.
36091 .next
36092 .cindex "log" "SMTP transaction; incomplete"
36093 .cindex "SMTP" "logging incomplete transactions"
36094 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36095 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36096 and the message sender plus any accepted recipients are included in the log
36097 line. This can provide evidence of dictionary attacks.
36098 .next
36099 .cindex "log" "non-MAIL SMTP sessions"
36100 .cindex "MAIL" "logging session without"
36101 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36102 connection terminates without having issued a MAIL command. This includes both
36103 the case when the connection is dropped, and the case when QUIT is used. It
36104 does not include cases where the connection is rejected right at the start (by
36105 an ACL, or because there are too many connections, or whatever). These cases
36106 already have their own log lines.
36107
36108 The log line that is written contains the identity of the client in the usual
36109 way, followed by D= and a time, which records the duration of the connection.
36110 If the connection was authenticated, this fact is logged exactly as it is for
36111 an incoming message, with an A= item. If the connection was encrypted, CV=,
36112 DN=, and X= items may appear as they do for an incoming message, controlled by
36113 the same logging options.
36114
36115 Finally, if any SMTP commands were issued during the connection, a C= item
36116 is added to the line, listing the commands that were used. For example,
36117 .code
36118 C=EHLO,QUIT
36119 .endd
36120 shows that the client issued QUIT straight after EHLO. If there were fewer
36121 than 20 commands, they are all listed. If there were more than 20 commands,
36122 the last 20 are listed, preceded by &"..."&. However, with the default
36123 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36124 have been aborted before 20 non-mail commands are processed.
36125 .next
36126 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36127 colon-separated, is appended to the A= item for a message arrival or delivery
36128 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36129 was accepted or used.
36130 .next
36131 .cindex "log" "SMTP protocol error"
36132 .cindex "SMTP" "logging protocol error"
36133 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36134 encountered. Exim does not have perfect detection of all protocol errors
36135 because of transmission delays and the use of pipelining. If PIPELINING has
36136 been advertised to a client, an Exim server assumes that the client will use
36137 it, and therefore it does not count &"expected"& errors (for example, RCPT
36138 received after rejecting MAIL) as protocol errors.
36139 .next
36140 .cindex "SMTP" "logging syntax errors"
36141 .cindex "SMTP" "syntax errors; logging"
36142 .cindex "SMTP" "unknown command; logging"
36143 .cindex "log" "unknown SMTP command"
36144 .cindex "log" "SMTP syntax error"
36145 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36146 encountered. An unrecognized command is treated as a syntax error. For an
36147 external connection, the host identity is given; for an internal connection
36148 using &%-bs%& the sender identification (normally the calling user) is given.
36149 .next
36150 .cindex "log" "subject"
36151 .cindex "subject, logging"
36152 &%subject%&: The subject of the message is added to the arrival log line,
36153 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36154 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36155 specifies whether characters with values greater than 127 should be logged
36156 unchanged, or whether they should be rendered as escape sequences.
36157 .next
36158 .cindex "log" "certificate verification"
36159 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36160 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36161 verified, and &`CV=no`& if not.
36162 .next
36163 .cindex "log" "TLS cipher"
36164 .cindex "TLS" "logging cipher"
36165 &%tls_cipher%&: When a message is sent or received over an encrypted
36166 connection, the cipher suite used is added to the log line, preceded by X=.
36167 .next
36168 .cindex "log" "TLS peer DN"
36169 .cindex "TLS" "logging peer DN"
36170 &%tls_peerdn%&: When a message is sent or received over an encrypted
36171 connection, and a certificate is supplied by the remote host, the peer DN is
36172 added to the log line, preceded by DN=.
36173 .next
36174 .cindex "log" "TLS SNI"
36175 .cindex "TLS" "logging SNI"
36176 &%tls_sni%&: When a message is received over an encrypted connection, and
36177 the remote host provided the Server Name Indication extension, the SNI is
36178 added to the log line, preceded by SNI=.
36179 .next
36180 .cindex "log" "DNS failure in list"
36181 &%unknown_in_list%&: This setting causes a log entry to be written when the
36182 result of a list match is failure because a DNS lookup failed.
36183 .endlist
36184
36185
36186 .section "Message log" "SECID260"
36187 .cindex "message" "log file for"
36188 .cindex "log" "message log; description of"
36189 .cindex "&_msglog_& directory"
36190 .oindex "&%preserve_message_logs%&"
36191 In addition to the general log files, Exim writes a log file for each message
36192 that it handles. The names of these per-message logs are the message ids, and
36193 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36194 message log contains copies of the log lines that apply to the message. This
36195 makes it easier to inspect the status of an individual message without having
36196 to search the main log. A message log is deleted when processing of the message
36197 is complete, unless &%preserve_message_logs%& is set, but this should be used
36198 only with great care because they can fill up your disk very quickly.
36199
36200 On a heavily loaded system, it may be desirable to disable the use of
36201 per-message logs, in order to reduce disk I/O. This can be done by setting the
36202 &%message_logs%& option false.
36203 .ecindex IIDloggen
36204
36205
36206
36207
36208 . ////////////////////////////////////////////////////////////////////////////
36209 . ////////////////////////////////////////////////////////////////////////////
36210
36211 .chapter "Exim utilities" "CHAPutils"
36212 .scindex IIDutils "utilities"
36213 A number of utility scripts and programs are supplied with Exim and are
36214 described in this chapter. There is also the Exim Monitor, which is covered in
36215 the next chapter. The utilities described here are:
36216
36217 .itable none 0 0 3  7* left  15* left  40* left
36218 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36219   "list what Exim processes are doing"
36220 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36221 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36222 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36223 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36224                                                 various criteria"
36225 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36226 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36227   "extract statistics from the log"
36228 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36229   "check address acceptance from given IP"
36230 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36231 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36232 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36233 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36234 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36235 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36236 .endtable
36237
36238 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36239 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36240 &url(http://duncanthrax.net/exilog/) for details.
36241
36242
36243
36244
36245 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36246 .cindex "&'exiwhat'&"
36247 .cindex "process, querying"
36248 .cindex "SIGUSR1"
36249 On operating systems that can restart a system call after receiving a signal
36250 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36251 a line describing what it is doing to the file &_exim-process.info_& in the
36252 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36253 processes it can find, having first emptied the file. It then waits for one
36254 second to allow the Exim processes to react before displaying the results. In
36255 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36256 send the signal to the Exim processes, so it is normally run as root.
36257
36258 &*Warning*&: This is not an efficient process. It is intended for occasional
36259 use by system administrators. It is not sensible, for example, to set up a
36260 script that sends SIGUSR1 signals to Exim processes at short intervals.
36261
36262
36263 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36264 varies in different operating systems. Not only are different options used,
36265 but the format of the output is different. For this reason, there are some
36266 system configuration options that configure exactly how &'exiwhat'& works. If
36267 it doesn't seem to be working for you, check the following compile-time
36268 options:
36269 .display
36270 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36271 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36272 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36273 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36274 .endd
36275 An example of typical output from &'exiwhat'& is
36276 .code
36277 164 daemon: -q1h, listening on port 25
36278 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36279 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36280   [10.19.42.42] (editor@ref.example)
36281 10592 handling incoming call from [192.168.243.242]
36282 10628 accepting a local non-SMTP message
36283 .endd
36284 The first number in the output line is the process number. The third line has
36285 been split here, in order to fit it on the page.
36286
36287
36288
36289 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36290 .cindex "&'exiqgrep'&"
36291 .cindex "queue" "grepping"
36292 This utility is a Perl script contributed by Matt Hubbard. It runs
36293 .code
36294 exim -bpu
36295 .endd
36296 or (in case &*-a*& switch is specified)
36297 .code
36298 exim -bp
36299 .endd
36300 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36301 contain alternate exim configuration the queue management might be using.
36302
36303 to obtain a queue listing, and then greps the output to select messages
36304 that match given criteria. The following selection options are available:
36305
36306 .vlist
36307 .vitem &*-f*&&~<&'regex'&>
36308 Match the sender address using a case-insensitive search. The field that is
36309 tested is enclosed in angle brackets, so you can test for bounce messages with
36310 .code
36311 exiqgrep -f '^<>$'
36312 .endd
36313 .vitem &*-r*&&~<&'regex'&>
36314 Match a recipient address using a case-insensitive search. The field that is
36315 tested is not enclosed in angle brackets.
36316
36317 .vitem &*-s*&&~<&'regex'&>
36318 Match against the size field.
36319
36320 .vitem &*-y*&&~<&'seconds'&>
36321 Match messages that are younger than the given time.
36322
36323 .vitem &*-o*&&~<&'seconds'&>
36324 Match messages that are older than the given time.
36325
36326 .vitem &*-z*&
36327 Match only frozen messages.
36328
36329 .vitem &*-x*&
36330 Match only non-frozen messages.
36331 .endlist
36332
36333 The following options control the format of the output:
36334
36335 .vlist
36336 .vitem &*-c*&
36337 Display only the count of matching messages.
36338
36339 .vitem &*-l*&
36340 Long format &-- display the full message information as output by Exim. This is
36341 the default.
36342
36343 .vitem &*-i*&
36344 Display message ids only.
36345
36346 .vitem &*-b*&
36347 Brief format &-- one line per message.
36348
36349 .vitem &*-R*&
36350 Display messages in reverse order.
36351
36352 .vitem &*-a*&
36353 Include delivered recipients in queue listing.
36354 .endlist
36355
36356 There is one more option, &%-h%&, which outputs a list of options.
36357
36358
36359
36360 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36361 .cindex "&'exiqsumm'&"
36362 .cindex "queue" "summary"
36363 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36364 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36365 running a command such as
36366 .code
36367 exim -bp | exiqsumm
36368 .endd
36369 The output consists of one line for each domain that has messages waiting for
36370 it, as in the following example:
36371 .code
36372 3   2322   74m   66m  msn.com.example
36373 .endd
36374 Each line lists the number of pending deliveries for a domain, their total
36375 volume, and the length of time that the oldest and the newest messages have
36376 been waiting. Note that the number of pending deliveries is greater than the
36377 number of messages when messages have more than one recipient.
36378
36379 A summary line is output at the end. By default the output is sorted on the
36380 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36381 the output to be sorted by oldest message and by count of messages,
36382 respectively. There are also three options that split the messages for each
36383 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36384 separates frozen messages, and &%-s%& separates messages according to their
36385 sender.
36386
36387 The output of &'exim -bp'& contains the original addresses in the message, so
36388 this also applies to the output from &'exiqsumm'&. No domains from addresses
36389 generated by aliasing or forwarding are included (unless the &%one_time%&
36390 option of the &(redirect)& router has been used to convert them into &"top
36391 level"& addresses).
36392
36393
36394
36395
36396 .section "Extracting specific information from the log (exigrep)" &&&
36397          "SECTextspeinf"
36398 .cindex "&'exigrep'&"
36399 .cindex "log" "extracts; grepping for"
36400 The &'exigrep'& utility is a Perl script that searches one or more main log
36401 files for entries that match a given pattern. When it finds a match, it
36402 extracts all the log entries for the relevant message, not just those that
36403 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36404 given message, or all mail for a given user, or for a given host, for example.
36405 The input files can be in Exim log format or syslog format.
36406 If a matching log line is not associated with a specific message, it is
36407 included in &'exigrep'&'s output without any additional lines. The usage is:
36408 .display
36409 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36410 .endd
36411 If no log file names are given on the command line, the standard input is read.
36412
36413 The &%-t%& argument specifies a number of seconds. It adds an additional
36414 condition for message selection. Messages that are complete are shown only if
36415 they spent more than <&'n'&> seconds on the queue.
36416
36417 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36418 makes it case-sensitive. This may give a performance improvement when searching
36419 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36420 option; with &%-I%& they do not. In both cases it is possible to change the
36421 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36422
36423 The &%-l%& option means &"literal"&, that is, treat all characters in the
36424 pattern as standing for themselves. Otherwise the pattern must be a Perl
36425 regular expression.
36426
36427 The &%-v%& option inverts the matching condition. That is, a line is selected
36428 if it does &'not'& match the pattern.
36429
36430 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36431 that are generated as a result/response to a message that &'exigrep'& matched
36432 normally.
36433
36434 Example of &%-M%&:
36435 user_a sends a message to user_b, which generates a bounce back to user_b. If
36436 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36437 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36438 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36439 when searching for &"user_a"& will show both messages since the bounce is
36440 &"related"& to or a &"result"& of the first message that was found by the
36441 search term.
36442
36443 If the location of a &'zcat'& command is known from the definition of
36444 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36445 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36446 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36447 autodetection of some well known compression extensions.
36448
36449
36450 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36451 .cindex "&'exipick'&"
36452 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36453 lists messages from the queue according to a variety of criteria. For details
36454 of &'exipick'&'s facilities, visit the web page at
36455 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36456 the &%--help%& option.
36457
36458
36459 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36460 .cindex "log" "cycling local files"
36461 .cindex "cycling logs"
36462 .cindex "&'exicyclog'&"
36463 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36464 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36465 you are using log files with datestamps in their names (see section
36466 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36467 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36468 There are two command line options for &'exicyclog'&:
36469 .ilist
36470 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36471 default that is set when Exim is built. The default default is 10.
36472 .next
36473 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36474 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36475 overriding the script's default, which is to find the setting from Exim's
36476 configuration.
36477 .endlist
36478
36479 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36480 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36481 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36482 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36483 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36484 logs are handled similarly.
36485
36486 If the limit is greater than 99, the script uses 3-digit numbers such as
36487 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36488 to one that is greater, or &'vice versa'&, you will have to fix the names of
36489 any existing log files.
36490
36491 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36492 the end are deleted. All files with numbers greater than 01 are compressed,
36493 using a compression command which is configured by the COMPRESS_COMMAND
36494 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36495 root &%crontab%& entry of the form
36496 .code
36497 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36498 .endd
36499 assuming you have used the name &"exim"& for the Exim user. You can run
36500 &'exicyclog'& as root if you wish, but there is no need.
36501
36502
36503
36504 .section "Mail statistics (eximstats)" "SECTmailstat"
36505 .cindex "statistics"
36506 .cindex "&'eximstats'&"
36507 A Perl script called &'eximstats'& is provided for extracting statistical
36508 information from log files. The output is either plain text, or HTML.
36509 Exim log files are also supported by the &'Lire'& system produced by the
36510 LogReport Foundation &url(http://www.logreport.org).
36511
36512 The &'eximstats'& script has been hacked about quite a bit over time. The
36513 latest version is the result of some extensive revision by Steve Campbell. A
36514 lot of information is given by default, but there are options for suppressing
36515 various parts of it. Following any options, the arguments to the script are a
36516 list of files, which should be main log files. For example:
36517 .code
36518 eximstats -nr /var/spool/exim/log/mainlog.01
36519 .endd
36520 By default, &'eximstats'& extracts information about the number and volume of
36521 messages received from or delivered to various hosts. The information is sorted
36522 both by message count and by volume, and the top fifty hosts in each category
36523 are listed on the standard output. Similar information, based on email
36524 addresses or domains instead of hosts can be requested by means of various
36525 options. For messages delivered and received locally, similar statistics are
36526 also produced per user.
36527
36528 The output also includes total counts and statistics about delivery errors, and
36529 histograms showing the number of messages received and deliveries made in each
36530 hour of the day. A delivery with more than one address in its envelope (for
36531 example, an SMTP transaction with more than one RCPT command) is counted
36532 as a single delivery by &'eximstats'&.
36533
36534 Though normally more deliveries than receipts are reported (as messages may
36535 have multiple recipients), it is possible for &'eximstats'& to report more
36536 messages received than delivered, even though the queue is empty at the start
36537 and end of the period in question. If an incoming message contains no valid
36538 recipients, no deliveries are recorded for it. A bounce message is handled as
36539 an entirely separate message.
36540
36541 &'eximstats'& always outputs a grand total summary giving the volume and number
36542 of messages received and deliveries made, and the number of hosts involved in
36543 each case. It also outputs the number of messages that were delayed (that is,
36544 not completely delivered at the first attempt), and the number that had at
36545 least one address that failed.
36546
36547 The remainder of the output is in sections that can be independently disabled
36548 or modified by various options. It consists of a summary of deliveries by
36549 transport, histograms of messages received and delivered per time interval
36550 (default per hour), information about the time messages spent on the queue,
36551 a list of relayed messages, lists of the top fifty sending hosts, local
36552 senders, destination hosts, and destination local users by count and by volume,
36553 and a list of delivery errors that occurred.
36554
36555 The relay information lists messages that were actually relayed, that is, they
36556 came from a remote host and were directly delivered to some other remote host,
36557 without being processed (for example, for aliasing or forwarding) locally.
36558
36559 There are quite a few options for &'eximstats'& to control exactly what it
36560 outputs. These are documented in the Perl script itself, and can be extracted
36561 by running the command &(perldoc)& on the script. For example:
36562 .code
36563 perldoc /usr/exim/bin/eximstats
36564 .endd
36565
36566 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36567 .cindex "&'exim_checkaccess'&"
36568 .cindex "policy control" "checking access"
36569 .cindex "checking access"
36570 The &%-bh%& command line argument allows you to run a fake SMTP session with
36571 debugging output, in order to check what Exim is doing when it is applying
36572 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36573 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36574 sometimes you just want to answer the question &"Does this address have
36575 access?"& without bothering with any further details.
36576
36577 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36578 two arguments, an IP address and an email address:
36579 .code
36580 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36581 .endd
36582 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36583 given email address would be accepted in a RCPT command in a TCP/IP
36584 connection from the host with the given IP address. The output of the utility
36585 is either the word &"accepted"&, or the SMTP error response, for example:
36586 .code
36587 Rejected:
36588 550 Relay not permitted
36589 .endd
36590 When running this test, the utility uses &`<>`& as the envelope sender address
36591 for the MAIL command, but you can change this by providing additional
36592 options. These are passed directly to the Exim command. For example, to specify
36593 that the test is to be run with the sender address &'himself@there.example'&
36594 you can use:
36595 .code
36596 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36597                  -f himself@there.example
36598 .endd
36599 Note that these additional Exim command line items must be given after the two
36600 mandatory arguments.
36601
36602 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36603 while running its checks. You can run checks that include callouts by using
36604 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36605
36606
36607
36608 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36609 .cindex "DBM" "building dbm files"
36610 .cindex "building DBM files"
36611 .cindex "&'exim_dbmbuild'&"
36612 .cindex "lower casing"
36613 .cindex "binary zero" "in lookup key"
36614 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36615 the format used by the &(lsearch)& lookup (see section
36616 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36617 names as keys and the remainder of the information as data. The lower-casing
36618 can be prevented by calling the program with the &%-nolc%& option.
36619
36620 A terminating zero is included as part of the key string. This is expected by
36621 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36622 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36623 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36624 files.
36625
36626 The program requires two arguments: the name of the input file (which can be a
36627 single hyphen to indicate the standard input), and the name of the output file.
36628 It creates the output under a temporary name, and then renames it if all went
36629 well.
36630
36631 .cindex "USE_DB"
36632 If the native DB interface is in use (USE_DB is set in a compile-time
36633 configuration file &-- this is common in free versions of Unix) the two file
36634 names must be different, because in this mode the Berkeley DB functions create
36635 a single output file using exactly the name given. For example,
36636 .code
36637 exim_dbmbuild /etc/aliases /etc/aliases.db
36638 .endd
36639 reads the system alias file and creates a DBM version of it in
36640 &_/etc/aliases.db_&.
36641
36642 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36643 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36644 environment, the suffixes are added to the second argument of
36645 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36646 when the Berkeley functions are used in compatibility mode (though this is not
36647 recommended), because in that case it adds a &_.db_& suffix to the file name.
36648
36649 If a duplicate key is encountered, the program outputs a warning, and when it
36650 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36651 option is used. By default, only the first of a set of duplicates is used &--
36652 this makes it compatible with &(lsearch)& lookups. There is an option
36653 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36654 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36655 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36656 return code is 2.
36657
36658
36659
36660
36661 .section "Finding individual retry times (exinext)" "SECTfinindret"
36662 .cindex "retry" "times"
36663 .cindex "&'exinext'&"
36664 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36665 fish specific information out of the retry database. Given a mail domain (or a
36666 complete address), it looks up the hosts for that domain, and outputs any retry
36667 information for the hosts or for the domain. At present, the retry information
36668 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36669 output. For example:
36670 .code
36671 $ exinext piglet@milne.fict.example
36672 kanga.milne.example:192.168.8.1 error 146: Connection refused
36673   first failed: 21-Feb-1996 14:57:34
36674   last tried:   21-Feb-1996 14:57:34
36675   next try at:  21-Feb-1996 15:02:34
36676 roo.milne.example:192.168.8.3 error 146: Connection refused
36677   first failed: 20-Jan-1996 13:12:08
36678   last tried:   21-Feb-1996 11:42:03
36679   next try at:  21-Feb-1996 19:42:03
36680   past final cutoff time
36681 .endd
36682 You can also give &'exinext'& a local part, without a domain, and it
36683 will give any retry information for that local part in your default domain.
36684 A message id can be used to obtain retry information pertaining to a specific
36685 message. This exists only when an attempt to deliver a message to a remote host
36686 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36687 &'exinext'& is not particularly efficient, but then it is not expected to be
36688 run very often.
36689
36690 The &'exinext'& utility calls Exim to find out information such as the location
36691 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36692 passed on to the &'exim'& commands. The first specifies an alternate Exim
36693 configuration file, and the second sets macros for use within the configuration
36694 file. These features are mainly to help in testing, but might also be useful in
36695 environments where more than one configuration file is in use.
36696
36697
36698
36699 .section "Hints database maintenance" "SECThindatmai"
36700 .cindex "hints database" "maintenance"
36701 .cindex "maintaining Exim's hints database"
36702 Three utility programs are provided for maintaining the DBM files that Exim
36703 uses to contain its delivery hint information. Each program requires two
36704 arguments. The first specifies the name of Exim's spool directory, and the
36705 second is the name of the database it is to operate on. These are as follows:
36706
36707 .ilist
36708 &'retry'&: the database of retry information
36709 .next
36710 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36711 for remote hosts
36712 .next
36713 &'callout'&: the callout cache
36714 .next
36715 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36716 .next
36717 &'misc'&: other hints data
36718 .endlist
36719
36720 The &'misc'& database is used for
36721
36722 .ilist
36723 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36724 .next
36725 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36726 &(smtp)& transport)
36727 .next
36728 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36729 in a transport)
36730 .endlist
36731
36732
36733
36734 .section "exim_dumpdb" "SECID261"
36735 .cindex "&'exim_dumpdb'&"
36736 The entire contents of a database are written to the standard output by the
36737 &'exim_dumpdb'& program, which has no options or arguments other than the
36738 spool and database names. For example, to dump the retry database:
36739 .code
36740 exim_dumpdb /var/spool/exim retry
36741 .endd
36742 Two lines of output are produced for each entry:
36743 .code
36744 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36745 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36746 .endd
36747 The first item on the first line is the key of the record. It starts with one
36748 of the letters R, or T, depending on whether it refers to a routing or
36749 transport retry. For a local delivery, the next part is the local address; for
36750 a remote delivery it is the name of the remote host, followed by its failing IP
36751 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36752 transport). If the remote port is not the standard one (port 25), it is added
36753 to the IP address. Then there follows an error code, an additional error code,
36754 and a textual description of the error.
36755
36756 The three times on the second line are the time of first failure, the time of
36757 the last delivery attempt, and the computed time for the next attempt. The line
36758 ends with an asterisk if the cutoff time for the last retry rule has been
36759 exceeded.
36760
36761 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36762 consists of a host name followed by a list of ids for messages that are or were
36763 waiting to be delivered to that host. If there are a very large number for any
36764 one host, continuation records, with a sequence number added to the host name,
36765 may be seen. The data in these records is often out of date, because a message
36766 may be routed to several alternative hosts, and Exim makes no effort to keep
36767 cross-references.
36768
36769
36770
36771 .section "exim_tidydb" "SECID262"
36772 .cindex "&'exim_tidydb'&"
36773 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36774 database. If run with no options, it removes all records that are more than 30
36775 days old. The age is calculated from the date and time that the record was last
36776 updated. Note that, in the case of the retry database, it is &'not'& the time
36777 since the first delivery failure. Information about a host that has been down
36778 for more than 30 days will remain in the database, provided that the record is
36779 updated sufficiently often.
36780
36781 The cutoff date can be altered by means of the &%-t%& option, which must be
36782 followed by a time. For example, to remove all records older than a week from
36783 the retry database:
36784 .code
36785 exim_tidydb -t 7d /var/spool/exim retry
36786 .endd
36787 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36788 message ids. In the former these appear as data in records keyed by host &--
36789 they were messages that were waiting for that host &-- and in the latter they
36790 are the keys for retry information for messages that have suffered certain
36791 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36792 message ids in database records are those of messages that are still on the
36793 queue. Message ids for messages that no longer exist are removed from
36794 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36795 For the &'retry'& database, records whose keys are non-existent message ids are
36796 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36797 whenever it removes information from the database.
36798
36799 Certain records are automatically removed by Exim when they are no longer
36800 needed, but others are not. For example, if all the MX hosts for a domain are
36801 down, a retry record is created for each one. If the primary MX host comes back
36802 first, its record is removed when Exim successfully delivers to it, but the
36803 records for the others remain because Exim has not tried to use those hosts.
36804
36805 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36806 hints databases. You should do this at a quiet time of day, because it requires
36807 a database to be locked (and therefore inaccessible to Exim) while it does its
36808 work. Removing records from a DBM file does not normally make the file smaller,
36809 but all the common DBM libraries are able to re-use the space that is released.
36810 After an initial phase of increasing in size, the databases normally reach a
36811 point at which they no longer get any bigger, as long as they are regularly
36812 tidied.
36813
36814 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36815 databases is likely to keep on increasing.
36816
36817
36818
36819
36820 .section "exim_fixdb" "SECID263"
36821 .cindex "&'exim_fixdb'&"
36822 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36823 Its main use is for testing Exim, but it might also be occasionally useful for
36824 getting round problems in a live system. It has no options, and its interface
36825 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36826 key of a database record can then be entered, and the data for that record is
36827 displayed.
36828
36829 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36830 except the &'retry'& database, that is the only operation that can be carried
36831 out. For the &'retry'& database, each field is output preceded by a number, and
36832 data for individual fields can be changed by typing the field number followed
36833 by new data, for example:
36834 .code
36835 > 4 951102:1000
36836 .endd
36837 resets the time of the next delivery attempt. Time values are given as a
36838 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36839 used as optional separators.
36840
36841
36842
36843
36844 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36845 .cindex "mailbox" "maintenance"
36846 .cindex "&'exim_lock'&"
36847 .cindex "locking mailboxes"
36848 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36849 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36850 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36851 a user agent while investigating a problem. The utility requires the name of
36852 the file as its first argument. If the locking is successful, the second
36853 argument is run as a command (using C's &[system()]& function); if there is no
36854 second argument, the value of the SHELL environment variable is used; if this
36855 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36856 is unlocked and the utility ends. The following options are available:
36857
36858 .vlist
36859 .vitem &%-fcntl%&
36860 Use &[fcntl()]& locking on the open mailbox.
36861
36862 .vitem &%-flock%&
36863 Use &[flock()]& locking on the open mailbox, provided the operating system
36864 supports it.
36865
36866 .vitem &%-interval%&
36867 This must be followed by a number, which is a number of seconds; it sets the
36868 interval to sleep between retries (default 3).
36869
36870 .vitem &%-lockfile%&
36871 Create a lock file before opening the mailbox.
36872
36873 .vitem &%-mbx%&
36874 Lock the mailbox using MBX rules.
36875
36876 .vitem &%-q%&
36877 Suppress verification output.
36878
36879 .vitem &%-retries%&
36880 This must be followed by a number; it sets the number of times to try to get
36881 the lock (default 10).
36882
36883 .vitem &%-restore_time%&
36884 This option causes &%exim_lock%& to restore the modified and read times to the
36885 locked file before exiting. This allows you to access a locked mailbox (for
36886 example, to take a backup copy) without disturbing the times that the user
36887 subsequently sees.
36888
36889 .vitem &%-timeout%&
36890 This must be followed by a number, which is a number of seconds; it sets a
36891 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36892 default), a non-blocking call is used.
36893
36894 .vitem &%-v%&
36895 Generate verbose output.
36896 .endlist
36897
36898 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36899 default is to create a lock file and also to use &[fcntl()]& locking on the
36900 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36901 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36902 requires that the directory containing the file be writeable. Locking by lock
36903 file does not last for ever; Exim assumes that a lock file is expired if it is
36904 more than 30 minutes old.
36905
36906 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36907 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36908 to be taken out on the open mailbox, and an exclusive lock on the file
36909 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36910 number of the mailbox file. When the locking is released, if an exclusive lock
36911 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36912
36913 The default output contains verification of the locking that takes place. The
36914 &%-v%& option causes some additional information to be given. The &%-q%& option
36915 suppresses all output except error messages.
36916
36917 A command such as
36918 .code
36919 exim_lock /var/spool/mail/spqr
36920 .endd
36921 runs an interactive shell while the file is locked, whereas
36922 .display
36923 &`exim_lock -q /var/spool/mail/spqr <<End`&
36924 <&'some commands'&>
36925 &`End`&
36926 .endd
36927 runs a specific non-interactive sequence of commands while the file is locked,
36928 suppressing all verification output. A single command can be run by a command
36929 such as
36930 .code
36931 exim_lock -q /var/spool/mail/spqr \
36932   "cp /var/spool/mail/spqr /some/where"
36933 .endd
36934 Note that if a command is supplied, it must be entirely contained within the
36935 second argument &-- hence the quotes.
36936 .ecindex IIDutils
36937
36938
36939 . ////////////////////////////////////////////////////////////////////////////
36940 . ////////////////////////////////////////////////////////////////////////////
36941
36942 .chapter "The Exim monitor" "CHAPeximon"
36943 .scindex IIDeximon "Exim monitor" "description"
36944 .cindex "X-windows"
36945 .cindex "&'eximon'&"
36946 .cindex "Local/eximon.conf"
36947 .cindex "&_exim_monitor/EDITME_&"
36948 The Exim monitor is an application which displays in an X window information
36949 about the state of Exim's queue and what Exim is doing. An admin user can
36950 perform certain operations on messages from this GUI interface; however all
36951 such facilities are also available from the command line, and indeed, the
36952 monitor itself makes use of the command line to perform any actions requested.
36953
36954
36955
36956 .section "Running the monitor" "SECID264"
36957 The monitor is started by running the script called &'eximon'&. This is a shell
36958 script that sets up a number of environment variables, and then runs the
36959 binary called &_eximon.bin_&. The default appearance of the monitor window can
36960 be changed by editing the &_Local/eximon.conf_& file created by editing
36961 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36962 parameters are for.
36963
36964 The parameters that get built into the &'eximon'& script can be overridden for
36965 a particular invocation by setting up environment variables of the same names,
36966 preceded by &`EXIMON_`&. For example, a shell command such as
36967 .code
36968 EXIMON_LOG_DEPTH=400 eximon
36969 .endd
36970 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36971 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36972 overrides the Exim log file configuration. This makes it possible to have
36973 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36974 syslog messages are routed to a file on the local host.
36975
36976 X resources can be used to change the appearance of the window in the normal
36977 way. For example, a resource setting of the form
36978 .code
36979 Eximon*background: gray94
36980 .endd
36981 changes the colour of the background to light grey rather than white. The
36982 stripcharts are drawn with both the data lines and the reference lines in
36983 black. This means that the reference lines are not visible when on top of the
36984 data. However, their colour can be changed by setting a resource called
36985 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36986 For example, if your X server is running Unix, you could set up lighter
36987 reference lines in the stripcharts by obeying
36988 .code
36989 xrdb -merge <<End
36990 Eximon*highlight: gray
36991 End
36992 .endd
36993 .cindex "admin user"
36994 In order to see the contents of messages on the queue, and to operate on them,
36995 &'eximon'& must either be run as root or by an admin user.
36996
36997 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36998 contain X11 resource parameters interpreted by the X11 library.  In addition,
36999 if the first parameter starts with the string "gdb" then it is removed and the
37000 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37001 versioned variants of gdb can be invoked).
37002
37003 The monitor's window is divided into three parts. The first contains one or
37004 more stripcharts and two action buttons, the second contains a &"tail"& of the
37005 main log file, and the third is a display of the queue of messages awaiting
37006 delivery, with two more action buttons. The following sections describe these
37007 different parts of the display.
37008
37009
37010
37011
37012 .section "The stripcharts" "SECID265"
37013 .cindex "stripchart"
37014 The first stripchart is always a count of messages on the queue. Its name can
37015 be configured by setting QUEUE_STRIPCHART_NAME in the
37016 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37017 configuration script by regular expression matches on log file entries, making
37018 it possible to display, for example, counts of messages delivered to certain
37019 hosts or using certain transports. The supplied defaults display counts of
37020 received and delivered messages, and of local and SMTP deliveries. The default
37021 period between stripchart updates is one minute; this can be adjusted by a
37022 parameter in the &_Local/eximon.conf_& file.
37023
37024 The stripchart displays rescale themselves automatically as the value they are
37025 displaying changes. There are always 10 horizontal lines in each chart; the
37026 title string indicates the value of each division when it is greater than one.
37027 For example, &"x2"& means that each division represents a value of 2.
37028
37029 It is also possible to have a stripchart which shows the percentage fullness of
37030 a particular disk partition, which is useful when local deliveries are confined
37031 to a single partition.
37032
37033 .cindex "&%statvfs%& function"
37034 This relies on the availability of the &[statvfs()]& function or equivalent in
37035 the operating system. Most, but not all versions of Unix that support Exim have
37036 this. For this particular stripchart, the top of the chart always represents
37037 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37038 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37039 &_Local/eximon.conf_& file.
37040
37041
37042
37043
37044 .section "Main action buttons" "SECID266"
37045 .cindex "size" "of monitor window"
37046 .cindex "Exim monitor" "window size"
37047 .cindex "window size"
37048 Below the stripcharts there is an action button for quitting the monitor. Next
37049 to this is another button marked &"Size"&. They are placed here so that
37050 shrinking the window to its default minimum size leaves just the queue count
37051 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37052 the window to expand to its maximum size, unless it is already at the maximum,
37053 in which case it is reduced to its minimum.
37054
37055 When expanding to the maximum, if the window cannot be fully seen where it
37056 currently is, it is moved back to where it was the last time it was at full
37057 size. When it is expanding from its minimum size, the old position is
37058 remembered, and next time it is reduced to the minimum it is moved back there.
37059
37060 The idea is that you can keep a reduced window just showing one or two
37061 stripcharts at a convenient place on your screen, easily expand it to show
37062 the full window when required, and just as easily put it back to what it was.
37063 The idea is copied from what the &'twm'& window manager does for its
37064 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37065 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37066
37067 Normally, the monitor starts up with the window at its full size, but it can be
37068 built so that it starts up with the window at its smallest size, by setting
37069 START_SMALL=yes in &_Local/eximon.conf_&.
37070
37071
37072
37073 .section "The log display" "SECID267"
37074 .cindex "log" "tail of; in monitor"
37075 The second section of the window is an area in which a display of the tail of
37076 the main log is maintained.
37077 To save space on the screen, the timestamp on each log line is shortened by
37078 removing the date and, if &%log_timezone%& is set, the timezone.
37079 The log tail is not available when the only destination for logging data is
37080 syslog, unless the syslog lines are routed to a local file whose name is passed
37081 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37082
37083 The log sub-window has a scroll bar at its lefthand side which can be used to
37084 move back to look at earlier text, and the up and down arrow keys also have a
37085 scrolling effect. The amount of log that is kept depends on the setting of
37086 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37087 to use. When this is full, the earlier 50% of data is discarded &-- this is
37088 much more efficient than throwing it away line by line. The sub-window also has
37089 a horizontal scroll bar for accessing the ends of long log lines. This is the
37090 only means of horizontal scrolling; the right and left arrow keys are not
37091 available. Text can be cut from this part of the window using the mouse in the
37092 normal way. The size of this subwindow is controlled by parameters in the
37093 configuration file &_Local/eximon.conf_&.
37094
37095 Searches of the text in the log window can be carried out by means of the ^R
37096 and ^S keystrokes, which default to a reverse and a forward search,
37097 respectively. The search covers only the text that is displayed in the window.
37098 It cannot go further back up the log.
37099
37100 The point from which the search starts is indicated by a caret marker. This is
37101 normally at the end of the text in the window, but can be positioned explicitly
37102 by pointing and clicking with the left mouse button, and is moved automatically
37103 by a successful search. If new text arrives in the window when it is scrolled
37104 back, the caret remains where it is, but if the window is not scrolled back,
37105 the caret is moved to the end of the new text.
37106
37107 Pressing ^R or ^S pops up a window into which the search text can be typed.
37108 There are buttons for selecting forward or reverse searching, for carrying out
37109 the search, and for cancelling. If the &"Search"& button is pressed, the search
37110 happens and the window remains so that further searches can be done. If the
37111 &"Return"& key is pressed, a single search is done and the window is closed. If
37112 ^C is typed the search is cancelled.
37113
37114 The searching facility is implemented using the facilities of the Athena text
37115 widget. By default this pops up a window containing both &"search"& and
37116 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37117 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37118 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37119 provided version of &%TextPop%& when the remaining parts of the text widget
37120 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37121 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37122 on these systems, at the expense of having unwanted items in the search popup
37123 window.
37124
37125
37126
37127 .section "The queue display" "SECID268"
37128 .cindex "queue" "display in monitor"
37129 The bottom section of the monitor window contains a list of all messages that
37130 are on the queue, which includes those currently being received or delivered,
37131 as well as those awaiting delivery. The size of this subwindow is controlled by
37132 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37133 at which it is updated is controlled by another parameter in the same file &--
37134 the default is 5 minutes, since queue scans can be quite expensive. However,
37135 there is an &"Update"& action button just above the display which can be used
37136 to force an update of the queue display at any time.
37137
37138 When a host is down for some time, a lot of pending mail can build up for it,
37139 and this can make it hard to deal with other messages on the queue. To help
37140 with this situation there is a button next to &"Update"& called &"Hide"&. If
37141 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37142 type anything in here and press &"Return"&, the text is added to a chain of
37143 such texts, and if every undelivered address in a message matches at least one
37144 of the texts, the message is not displayed.
37145
37146 If there is an address that does not match any of the texts, all the addresses
37147 are displayed as normal. The matching happens on the ends of addresses so, for
37148 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37149 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37150 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37151 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37152 a hide request is automatically cancelled after one hour.
37153
37154 While the dialogue box is displayed, you can't press any buttons or do anything
37155 else to the monitor window. For this reason, if you want to cut text from the
37156 queue display to use in the dialogue box, you have to do the cutting before
37157 pressing the &"Hide"& button.
37158
37159 The queue display contains, for each unhidden queued message, the length of
37160 time it has been on the queue, the size of the message, the message id, the
37161 message sender, and the first undelivered recipient, all on one line. If it is
37162 a bounce message, the sender is shown as &"<>"&. If there is more than one
37163 recipient to which the message has not yet been delivered, subsequent ones are
37164 listed on additional lines, up to a maximum configured number, following which
37165 an ellipsis is displayed. Recipients that have already received the message are
37166 not shown.
37167
37168 .cindex "frozen messages" "display"
37169 If a message is frozen, an asterisk is displayed at the left-hand side.
37170
37171 The queue display has a vertical scroll bar, and can also be scrolled by means
37172 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37173 The text searching facilities, as described above for the log window, are also
37174 available, but the caret is always moved to the end of the text when the queue
37175 display is updated.
37176
37177
37178
37179 .section "The queue menu" "SECID269"
37180 .cindex "queue" "menu in monitor"
37181 If the &%shift%& key is held down and the left button is clicked when the mouse
37182 pointer is over the text for any message, an action menu pops up, and the first
37183 line of the queue display for the message is highlighted. This does not affect
37184 any selected text.
37185
37186 If you want to use some other event for popping up the menu, you can set the
37187 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37188 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37189 value set in this parameter is a standard X event description. For example, to
37190 run eximon using &%ctrl%& rather than &%shift%& you could use
37191 .code
37192 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37193 .endd
37194 The title of the menu is the message id, and it contains entries which act as
37195 follows:
37196
37197 .ilist
37198 &'message log'&: The contents of the message log for the message are displayed
37199 in a new text window.
37200 .next
37201 &'headers'&: Information from the spool file that contains the envelope
37202 information and headers is displayed in a new text window. See chapter
37203 &<<CHAPspool>>& for a description of the format of spool files.
37204 .next
37205 &'body'&: The contents of the spool file containing the body of the message are
37206 displayed in a new text window. There is a default limit of 20,000 bytes to the
37207 amount of data displayed. This can be changed by setting the BODY_MAX
37208 option at compile time, or the EXIMON_BODY_MAX option at run time.
37209 .next
37210 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37211 delivery of the message. This causes an automatic thaw if the message is
37212 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37213 a new text window. The delivery is run in a separate process, to avoid holding
37214 up the monitor while the delivery proceeds.
37215 .next
37216 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37217 that the message be frozen.
37218 .next
37219 .cindex "thawing messages"
37220 .cindex "unfreezing messages"
37221 .cindex "frozen messages" "thawing"
37222 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37223 that the message be thawed.
37224 .next
37225 .cindex "delivery" "forcing failure"
37226 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37227 that Exim gives up trying to deliver the message. A bounce message is generated
37228 for any remaining undelivered addresses.
37229 .next
37230 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37231 that the message be deleted from the system without generating a bounce
37232 message.
37233 .next
37234 &'add recipient'&: A dialog box is displayed into which a recipient address can
37235 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37236 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37237 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37238 causes a call to Exim to be made using the &%-Mar%& option to request that an
37239 additional recipient be added to the message, unless the entry box is empty, in
37240 which case no action is taken.
37241 .next
37242 &'mark delivered'&: A dialog box is displayed into which a recipient address
37243 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37244 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37245 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37246 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37247 recipient address as already delivered, unless the entry box is empty, in which
37248 case no action is taken.
37249 .next
37250 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37251 mark all recipient addresses as already delivered.
37252 .next
37253 &'edit sender'&: A dialog box is displayed initialized with the current
37254 sender's address. Pressing RETURN causes a call to Exim to be made using the
37255 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37256 in which case no action is taken. If you want to set an empty sender (as in
37257 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37258 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37259 the address is qualified with that domain.
37260 .endlist
37261
37262 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37263 other cases when a call to Exim is made, if there is any output from Exim (in
37264 particular, if the command fails) a window containing the command and the
37265 output is displayed. Otherwise, the results of the action are normally apparent
37266 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37267 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37268 if no output is generated.
37269
37270 The queue display is automatically updated for actions such as freezing and
37271 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37272 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37273 force an update of the display after one of these actions.
37274
37275 In any text window that is displayed as result of a menu action, the normal
37276 cut-and-paste facility is available, and searching can be carried out using ^R
37277 and ^S, as described above for the log tail window.
37278 .ecindex IIDeximon
37279
37280
37281
37282
37283
37284 . ////////////////////////////////////////////////////////////////////////////
37285 . ////////////////////////////////////////////////////////////////////////////
37286
37287 .chapter "Security considerations" "CHAPsecurity"
37288 .scindex IIDsecurcon "security" "discussion of"
37289 This chapter discusses a number of issues concerned with security, some of
37290 which are also covered in other parts of this manual.
37291
37292 For reasons that this author does not understand, some people have promoted
37293 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37294 existence of this chapter in the documentation. However, the intent of the
37295 chapter is simply to describe the way Exim works in relation to certain
37296 security concerns, not to make any specific claims about the effectiveness of
37297 its security as compared with other MTAs.
37298
37299 What follows is a description of the way Exim is supposed to be. Best efforts
37300 have been made to try to ensure that the code agrees with the theory, but an
37301 absence of bugs can never be guaranteed. Any that are reported will get fixed
37302 as soon as possible.
37303
37304
37305 .section "Building a more &""hardened""& Exim" "SECID286"
37306 .cindex "security" "build-time features"
37307 There are a number of build-time options that can be set in &_Local/Makefile_&
37308 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37309 Exim administrator who does not have the root password, or by someone who has
37310 penetrated the Exim (but not the root) account. These options are as follows:
37311
37312 .ilist
37313 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37314 start of any file names used with the &%-C%& option. When it is set, these file
37315 names are also not allowed to contain the sequence &"/../"&. (However, if the
37316 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37317 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37318 default setting for &%ALT_CONFIG_PREFIX%&.
37319
37320 If the permitted configuration files are confined to a directory to
37321 which only root has access, this guards against someone who has broken
37322 into the Exim account from running a privileged Exim with an arbitrary
37323 configuration file, and using it to break into other accounts.
37324 .next
37325
37326 If a non-trusted configuration file (i.e. not the default configuration file
37327 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37328 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37329 the next item), then root privilege is retained only if the caller of Exim is
37330 root. This locks out the possibility of testing a configuration using &%-C%&
37331 right through message reception and delivery, even if the caller is root. The
37332 reception works, but by that time, Exim is running as the Exim user, so when
37333 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37334 privilege to be lost. However, root can test reception and delivery using two
37335 separate commands.
37336
37337 .next
37338 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37339 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37340 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37341 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37342 the restrictive side.  Requiring build-time selection of safe macros is onerous
37343 but this option is intended solely as a transition mechanism to permit
37344 previously-working configurations to continue to work after release 4.73.
37345 .next
37346 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37347 is disabled.
37348 .next
37349 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37350 never to be used for any deliveries. This is like the &%never_users%& runtime
37351 option, but it cannot be overridden; the runtime option adds additional users
37352 to the list. The default setting is &"root"&; this prevents a non-root user who
37353 is permitted to modify the runtime file from using Exim as a way to get root.
37354 .endlist
37355
37356
37357
37358 .section "Root privilege" "SECID270"
37359 .cindex "setuid"
37360 .cindex "root privilege"
37361 The Exim binary is normally setuid to root, which means that it gains root
37362 privilege (runs as root) when it starts execution. In some special cases (for
37363 example, when the daemon is not in use and there are no local deliveries), it
37364 may be possible to run Exim setuid to some user other than root. This is
37365 discussed in the next section. However, in most installations, root privilege
37366 is required for two things:
37367
37368 .ilist
37369 To set up a socket connected to the standard SMTP port (25) when initialising
37370 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37371 not required.
37372 .next
37373 To be able to change uid and gid in order to read users' &_.forward_& files and
37374 perform local deliveries as the receiving user or as specified in the
37375 configuration.
37376 .endlist
37377
37378 It is not necessary to be root to do any of the other things Exim does, such as
37379 receiving messages and delivering them externally over SMTP, and it is
37380 obviously more secure if Exim does not run as root except when necessary.
37381 For this reason, a user and group for Exim to use must be defined in
37382 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37383 group"&. Their values can be changed by the run time configuration, though this
37384 is not recommended. Often a user called &'exim'& is used, but some sites use
37385 &'mail'& or another user name altogether.
37386
37387 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37388 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37389 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37390
37391 After a new Exim process has interpreted its command line options, it changes
37392 uid and gid in the following cases:
37393
37394 .ilist
37395 .oindex "&%-C%&"
37396 .oindex "&%-D%&"
37397 If the &%-C%& option is used to specify an alternate configuration file, or if
37398 the &%-D%& option is used to define macro values for the configuration, and the
37399 calling process is not running as root, the uid and gid are changed to those of
37400 the calling process.
37401 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37402 option may not be used at all.
37403 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37404 can be supplied if the calling process is running as root, the Exim run-time
37405 user or CONFIGURE_OWNER, if defined.
37406 .next
37407 .oindex "&%-be%&"
37408 .oindex "&%-bf%&"
37409 .oindex "&%-bF%&"
37410 If the expansion test option (&%-be%&) or one of the filter testing options
37411 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37412 calling process.
37413 .next
37414 If the process is not a daemon process or a queue runner process or a delivery
37415 process or a process for testing address routing (started with &%-bt%&), the
37416 uid and gid are changed to the Exim user and group. This means that Exim always
37417 runs under its own uid and gid when receiving messages. This also applies when
37418 testing address verification
37419 .oindex "&%-bv%&"
37420 .oindex "&%-bh%&"
37421 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37422 option).
37423 .next
37424 For a daemon, queue runner, delivery, or address testing process, the uid
37425 remains as root at this stage, but the gid is changed to the Exim group.
37426 .endlist
37427
37428 The processes that initially retain root privilege behave as follows:
37429
37430 .ilist
37431 A daemon process changes the gid to the Exim group and the uid to the Exim
37432 user after setting up one or more listening sockets. The &[initgroups()]&
37433 function is called, so that if the Exim user is in any additional groups, they
37434 will be used during message reception.
37435 .next
37436 A queue runner process retains root privilege throughout its execution. Its
37437 job is to fork a controlled sequence of delivery processes.
37438 .next
37439 A delivery process retains root privilege throughout most of its execution,
37440 but any actual deliveries (that is, the transports themselves) are run in
37441 subprocesses which always change to a non-root uid and gid. For local
37442 deliveries this is typically the uid and gid of the owner of the mailbox; for
37443 remote deliveries, the Exim uid and gid are used. Once all the delivery
37444 subprocesses have been run, a delivery process changes to the Exim uid and gid
37445 while doing post-delivery tidying up such as updating the retry database and
37446 generating bounce and warning messages.
37447
37448 While the recipient addresses in a message are being routed, the delivery
37449 process runs as root. However, if a user's filter file has to be processed,
37450 this is done in a subprocess that runs under the individual user's uid and
37451 gid. A system filter is run as root unless &%system_filter_user%& is set.
37452 .next
37453 A process that is testing addresses (the &%-bt%& option) runs as root so that
37454 the routing is done in the same environment as a message delivery.
37455 .endlist
37456
37457
37458
37459
37460 .section "Running Exim without privilege" "SECTrunexiwitpri"
37461 .cindex "privilege, running without"
37462 .cindex "unprivileged running"
37463 .cindex "root privilege" "running without"
37464 Some installations like to run Exim in an unprivileged state for more of its
37465 operation, for added security. Support for this mode of operation is provided
37466 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37467 gid are changed to the Exim user and group at the start of a delivery process
37468 (and also queue runner and address testing processes). This means that address
37469 routing is no longer run as root, and the deliveries themselves cannot change
37470 to any other uid.
37471
37472 .cindex SIGHUP
37473 .cindex "daemon" "restarting"
37474 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37475 that the daemon can still be started in the usual way, and it can respond
37476 correctly to SIGHUP because the re-invocation regains root privilege.
37477
37478 An alternative approach is to make Exim setuid to the Exim user and also setgid
37479 to the Exim group. If you do this, the daemon must be started from a root
37480 process. (Calling Exim from a root process makes it behave in the way it does
37481 when it is setuid root.) However, the daemon cannot restart itself after a
37482 SIGHUP signal because it cannot regain privilege.
37483
37484 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37485 stops Exim from trying to re-invoke itself to do a delivery after a message has
37486 been received. Such a re-invocation is a waste of resources because it has no
37487 effect.
37488
37489 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37490 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37491 to the Exim user seems a clean approach, but there is one complication:
37492
37493 In this style of operation, Exim is running with the real uid and gid set to
37494 those of the calling process, and the effective uid/gid set to Exim's values.
37495 Ideally, any association with the calling process' uid/gid should be dropped,
37496 that is, the real uid/gid should be reset to the effective values so as to
37497 discard any privileges that the caller may have. While some operating systems
37498 have a function that permits this action for a non-root effective uid, quite a
37499 number of them do not. Because of this lack of standardization, Exim does not
37500 address this problem at this time.
37501
37502 For this reason, the recommended approach for &"mostly unprivileged"& running
37503 is to keep the Exim binary setuid to root, and to set
37504 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37505 be used in the most straightforward way.
37506
37507 If you configure Exim not to run delivery processes as root, there are a
37508 number of restrictions on what you can do:
37509
37510 .ilist
37511 You can deliver only as the Exim user/group. You should  explicitly use the
37512 &%user%& and &%group%& options to override routers or local transports that
37513 normally deliver as the recipient. This makes sure that configurations that
37514 work in this mode function the same way in normal mode. Any implicit or
37515 explicit specification of another user causes an error.
37516 .next
37517 Use of &_.forward_& files is severely restricted, such that it is usually
37518 not worthwhile to include them in the configuration.
37519 .next
37520 Users who wish to use &_.forward_& would have to make their home directory and
37521 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37522 and their equivalents in Exim filters, cannot be used. While they could be
37523 enabled in the Exim user's name, that would be insecure and not very useful.
37524 .next
37525 Unless the local user mailboxes are all owned by the Exim user (possible in
37526 some POP3 or IMAP-only environments):
37527
37528 .olist
37529 They must be owned by the Exim group and be writeable by that group. This
37530 implies you must set &%mode%& in the appendfile configuration, as well as the
37531 mode of the mailbox files themselves.
37532 .next
37533 You must set &%no_check_owner%&, since most or all of the files will not be
37534 owned by the Exim user.
37535 .next
37536 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37537 on a newly created mailbox when unprivileged. This also implies that new
37538 mailboxes need to be created manually.
37539 .endlist olist
37540 .endlist ilist
37541
37542
37543 These restrictions severely restrict what can be done in local deliveries.
37544 However, there are no restrictions on remote deliveries. If you are running a
37545 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37546 gives more security at essentially no cost.
37547
37548 If you are using the &%mua_wrapper%& facility (see chapter
37549 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37550
37551
37552
37553
37554 .section "Delivering to local files" "SECID271"
37555 Full details of the checks applied by &(appendfile)& before it writes to a file
37556 are given in chapter &<<CHAPappendfile>>&.
37557
37558
37559
37560 .section "Running local commands" "SECTsecconslocalcmds"
37561 .cindex "security" "local commands"
37562 .cindex "security" "command injection attacks"
37563 There are a number of ways in which an administrator can configure Exim to run
37564 commands based upon received, untrustworthy, data. Further, in some
37565 configurations a user who can control a &_.forward_& file can also arrange to
37566 run commands. Configuration to check includes, but is not limited to:
37567
37568 .ilist
37569 Use of &%use_shell%& in the pipe transport: various forms of shell command
37570 injection may be possible with this option present. It is dangerous and should
37571 be used only with considerable caution. Consider constraints which whitelist
37572 allowed characters in a variable which is to be used in a pipe transport that
37573 has &%use_shell%& enabled.
37574 .next
37575 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37576 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37577 &_.forward_& files in a redirect router. If Exim is running on a central mail
37578 hub to which ordinary users do not have shell access, but home directories are
37579 NFS mounted (for instance) then administrators should review the list of these
37580 forbid options available, and should bear in mind that the options that may
37581 need forbidding can change as new features are added between releases.
37582 .next
37583 The &%${run...}%& expansion item does not use a shell by default, but
37584 administrators can configure use of &_/bin/sh_& as part of the command.
37585 Such invocations should be viewed with prejudicial suspicion.
37586 .next
37587 Administrators who use embedded Perl are advised to explore how Perl's
37588 taint checking might apply to their usage.
37589 .next
37590 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37591 administrators are well advised to view its use with suspicion, in case (for
37592 instance) it allows a local-part to contain embedded Exim directives.
37593 .next
37594 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37595 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37596 each can reference arbitrary lists and files, rather than just being a list
37597 of opaque strings.
37598 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37599 real-world security vulnerabilities caused by its use with untrustworthy data
37600 injected in, for SQL injection attacks.
37601 Consider the use of the &%inlisti%& expansion condition instead.
37602 .endlist
37603
37604
37605
37606
37607 .section "Trust in configuration data" "SECTsecconfdata"
37608 .cindex "security" "data sources"
37609 .cindex "security" "regular expressions"
37610 .cindex "regular expressions" "security"
37611 .cindex "PCRE" "security"
37612 If configuration data for Exim can come from untrustworthy sources, there
37613 are some issues to be aware of:
37614
37615 .ilist
37616 Use of &%${expand...}%& may provide a path for shell injection attacks.
37617 .next
37618 Letting untrusted data provide a regular expression is unwise.
37619 .next
37620 Using &%${match...}%& to apply a fixed regular expression against untrusted
37621 data may result in pathological behaviour within PCRE.  Be aware of what
37622 "backtracking" means and consider options for being more strict with a regular
37623 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37624 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37625 possessive quantifiers or just not using regular expressions against untrusted
37626 data.
37627 .next
37628 It can be important to correctly use &%${quote:...}%&,
37629 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37630 items to ensure that data is correctly constructed.
37631 .next
37632 Some lookups might return multiple results, even though normal usage is only
37633 expected to yield one result.
37634 .endlist
37635
37636
37637
37638
37639 .section "IPv4 source routing" "SECID272"
37640 .cindex "source routing" "in IP packets"
37641 .cindex "IP source routing"
37642 Many operating systems suppress IP source-routed packets in the kernel, but
37643 some cannot be made to do this, so Exim does its own check. It logs incoming
37644 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37645 IPv6. No special checking is currently done.
37646
37647
37648
37649 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37650 Support for these SMTP commands is disabled by default. If required, they can
37651 be enabled by defining suitable ACLs.
37652
37653
37654
37655
37656 .section "Privileged users" "SECID274"
37657 .cindex "trusted users"
37658 .cindex "admin user"
37659 .cindex "privileged user"
37660 .cindex "user" "trusted"
37661 .cindex "user" "admin"
37662 Exim recognizes two sets of users with special privileges. Trusted users are
37663 able to submit new messages to Exim locally, but supply their own sender
37664 addresses and information about a sending host. For other users submitting
37665 local messages, Exim sets up the sender address from the uid, and doesn't
37666 permit a remote host to be specified.
37667
37668 .oindex "&%-f%&"
37669 However, an untrusted user is permitted to use the &%-f%& command line option
37670 in the special form &%-f <>%& to indicate that a delivery failure for the
37671 message should not cause an error report. This affects the message's envelope,
37672 but it does not affect the &'Sender:'& header. Untrusted users may also be
37673 permitted to use specific forms of address with the &%-f%& option by setting
37674 the &%untrusted_set_sender%& option.
37675
37676 Trusted users are used to run processes that receive mail messages from some
37677 other mail domain and pass them on to Exim for delivery either locally, or over
37678 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37679 as any user listed in the &%trusted_users%& configuration option, or under any
37680 group listed in the &%trusted_groups%& option.
37681
37682 Admin users are permitted to do things to the messages on Exim's queue. They
37683 can freeze or thaw messages, cause them to be returned to their senders, remove
37684 them entirely, or modify them in various ways. In addition, admin users can run
37685 the Exim monitor and see all the information it is capable of providing, which
37686 includes the contents of files on the spool.
37687
37688 .oindex "&%-M%&"
37689 .oindex "&%-q%&"
37690 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37691 delivery of messages on its queue is restricted to admin users. This
37692 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37693 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37694 queue is also restricted to admin users. This restriction can be relaxed by
37695 setting &%no_queue_list_requires_admin%&.
37696
37697 Exim recognizes an admin user if the calling process is running as root or as
37698 the Exim user or if any of the groups associated with the calling process is
37699 the Exim group. It is not necessary actually to be running under the Exim
37700 group. However, if admin users who are not root or the Exim user are to access
37701 the contents of files on the spool via the Exim monitor (which runs
37702 unprivileged), Exim must be built to allow group read access to its spool
37703 files.
37704
37705
37706
37707 .section "Spool files" "SECID275"
37708 .cindex "spool directory" "files"
37709 Exim's spool directory and everything it contains is owned by the Exim user and
37710 set to the Exim group. The mode for spool files is defined in the
37711 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37712 any user who is a member of the Exim group can access these files.
37713
37714
37715
37716 .section "Use of argv[0]" "SECID276"
37717 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37718 of specific strings, Exim assumes certain options. For example, calling Exim
37719 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37720 to calling it with the option &%-bS%&. There are no security implications in
37721 this.
37722
37723
37724
37725 .section "Use of %f formatting" "SECID277"
37726 The only use made of &"%f"& by Exim is in formatting load average values. These
37727 are actually stored in integer variables as 1000 times the load average.
37728 Consequently, their range is limited and so therefore is the length of the
37729 converted output.
37730
37731
37732
37733 .section "Embedded Exim path" "SECID278"
37734 Exim uses its own path name, which is embedded in the code, only when it needs
37735 to re-exec in order to regain root privilege. Therefore, it is not root when it
37736 does so. If some bug allowed the path to get overwritten, it would lead to an
37737 arbitrary program's being run as exim, not as root.
37738
37739
37740
37741 .section "Dynamic module directory" "SECTdynmoddir"
37742 Any dynamically loadable modules must be installed into the directory
37743 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37744 loading it.
37745
37746
37747 .section "Use of sprintf()" "SECID279"
37748 .cindex "&[sprintf()]&"
37749 A large number of occurrences of &"sprintf"& in the code are actually calls to
37750 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37751 The intermediate formatting is done into a large fixed buffer by a function
37752 that runs through the format string itself, and checks the length of each
37753 conversion before performing it, thus preventing buffer overruns.
37754
37755 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37756 the output buffer is known to be sufficiently long to contain the converted
37757 string.
37758
37759
37760
37761 .section "Use of debug_printf() and log_write()" "SECID280"
37762 Arbitrary strings are passed to both these functions, but they do their
37763 formatting by calling the function &'string_vformat()'&, which runs through
37764 the format string itself, and checks the length of each conversion.
37765
37766
37767
37768 .section "Use of strcat() and strcpy()" "SECID281"
37769 These are used only in cases where the output buffer is known to be large
37770 enough to hold the result.
37771 .ecindex IIDsecurcon
37772
37773
37774
37775
37776 . ////////////////////////////////////////////////////////////////////////////
37777 . ////////////////////////////////////////////////////////////////////////////
37778
37779 .chapter "Format of spool files" "CHAPspool"
37780 .scindex IIDforspo1 "format" "spool files"
37781 .scindex IIDforspo2 "spool directory" "format of files"
37782 .scindex IIDforspo3 "spool files" "format of"
37783 .cindex "spool files" "editing"
37784 A message on Exim's queue consists of two files, whose names are the message id
37785 followed by -D and -H, respectively. The data portion of the message is kept in
37786 the -D file on its own. The message's envelope, status, and headers are all
37787 kept in the -H file, whose format is described in this chapter. Each of these
37788 two files contains the final component of its own name as its first line. This
37789 is insurance against disk crashes where the directory is lost but the files
37790 themselves are recoverable.
37791
37792 Some people are tempted into editing -D files in order to modify messages. You
37793 need to be extremely careful if you do this; it is not recommended and you are
37794 on your own if you do it. Here are some of the pitfalls:
37795
37796 .ilist
37797 You must ensure that Exim does not try to deliver the message while you are
37798 fiddling with it. The safest way is to take out a write lock on the -D file,
37799 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37800 place, the lock will be retained. If you write a new file and rename it, the
37801 lock will be lost at the instant of rename.
37802 .next
37803 .vindex "&$body_linecount$&"
37804 If you change the number of lines in the file, the value of
37805 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37806 present, this value is not used by Exim, but there is no guarantee that this
37807 will always be the case.
37808 .next
37809 If the message is in MIME format, you must take care not to break it.
37810 .next
37811 If the message is cryptographically signed, any change will invalidate the
37812 signature.
37813 .endlist
37814 All in all, modifying -D files is fraught with danger.
37815
37816 Files whose names end with -J may also be seen in the &_input_& directory (or
37817 its subdirectories when &%split_spool_directory%& is set). These are journal
37818 files, used to record addresses to which the message has been delivered during
37819 the course of a delivery attempt. If there are still undelivered recipients at
37820 the end, the -H file is updated, and the -J file is deleted. If, however, there
37821 is some kind of crash (for example, a power outage) before this happens, the -J
37822 file remains in existence. When Exim next processes the message, it notices the
37823 -J file and uses it to update the -H file before starting the next delivery
37824 attempt.
37825
37826 .section "Format of the -H file" "SECID282"
37827 .cindex "uid (user id)" "in spool file"
37828 .cindex "gid (group id)" "in spool file"
37829 The second line of the -H file contains the login name for the uid of the
37830 process that called Exim to read the message, followed by the numerical uid and
37831 gid. For a locally generated message, this is normally the user who sent the
37832 message. For a message received over TCP/IP via the daemon, it is
37833 normally the Exim user.
37834
37835 The third line of the file contains the address of the message's sender as
37836 transmitted in the envelope, contained in angle brackets. The sender address is
37837 empty for bounce messages. For incoming SMTP mail, the sender address is given
37838 in the MAIL command. For locally generated mail, the sender address is
37839 created by Exim from the login name of the current user and the configured
37840 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37841 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37842 &"<>"& or an address that matches &%untrusted_set_senders%&.
37843
37844 The fourth line contains two numbers. The first is the time that the message
37845 was received, in the conventional Unix form &-- the number of seconds since the
37846 start of the epoch. The second number is a count of the number of messages
37847 warning of delayed delivery that have been sent to the sender.
37848
37849 There follow a number of lines starting with a hyphen. These can appear in any
37850 order, and are omitted when not relevant:
37851
37852 .vlist
37853 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37854 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37855 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37856 recognized, to provide backward compatibility. In the old format, a line of
37857 this form is present for every ACL variable that is not empty. The number
37858 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37859 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37860 the data string for the variable. The string itself starts at the beginning of
37861 the next line, and is followed by a newline character. It may contain internal
37862 newlines.
37863
37864 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37865 A line of this form is present for every ACL connection variable that is
37866 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37867 The length is the length of the data string for the variable. The string itself
37868 starts at the beginning of the next line, and is followed by a newline
37869 character. It may contain internal newlines.
37870
37871 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37872 A line of this form is present for every ACL message variable that is defined.
37873 Note that there is a space between &%-aclm%& and the rest of the name. The
37874 length is the length of the data string for the variable. The string itself
37875 starts at the beginning of the next line, and is followed by a newline
37876 character. It may contain internal newlines.
37877
37878 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37879 This is present if, when the message was received over SMTP, the value of
37880 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37881
37882 .vitem &%-allow_unqualified_recipient%&
37883 This is present if unqualified recipient addresses are permitted in header
37884 lines (to stop such addresses from being qualified if rewriting occurs at
37885 transport time). Local messages that were input using &%-bnq%& and remote
37886 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37887
37888 .vitem &%-allow_unqualified_sender%&
37889 This is present if unqualified sender addresses are permitted in header lines
37890 (to stop such addresses from being qualified if rewriting occurs at transport
37891 time). Local messages that were input using &%-bnq%& and remote messages from
37892 hosts that match &%sender_unqualified_hosts%& set this flag.
37893
37894 .vitem "&%-auth_id%&&~<&'text'&>"
37895 The id information for a message received on an authenticated SMTP connection
37896 &-- the value of the &$authenticated_id$& variable.
37897
37898 .vitem "&%-auth_sender%&&~<&'address'&>"
37899 The address of an authenticated sender &-- the value of the
37900 &$authenticated_sender$& variable.
37901
37902 .vitem "&%-body_linecount%&&~<&'number'&>"
37903 This records the number of lines in the body of the message, and is always
37904 present.
37905
37906 .vitem "&%-body_zerocount%&&~<&'number'&>"
37907 This records the number of binary zero bytes in the body of the message, and is
37908 present if the number is greater than zero.
37909
37910 .vitem &%-deliver_firsttime%&
37911 This is written when a new message is first added to the spool. When the spool
37912 file is updated after a deferral, it is omitted.
37913
37914 .vitem "&%-frozen%&&~<&'time'&>"
37915 .cindex "frozen messages" "spool data"
37916 The message is frozen, and the freezing happened at <&'time'&>.
37917
37918 .vitem "&%-helo_name%&&~<&'text'&>"
37919 This records the host name as specified by a remote host in a HELO or EHLO
37920 command.
37921
37922 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37923 This records the IP address of the host from which the message was received and
37924 the remote port number that was used. It is omitted for locally generated
37925 messages.
37926
37927 .vitem "&%-host_auth%&&~<&'text'&>"
37928 If the message was received on an authenticated SMTP connection, this records
37929 the name of the authenticator &-- the value of the
37930 &$sender_host_authenticated$& variable.
37931
37932 .vitem &%-host_lookup_failed%&
37933 This is present if an attempt to look up the sending host's name from its IP
37934 address failed. It corresponds to the &$host_lookup_failed$& variable.
37935
37936 .vitem "&%-host_name%&&~<&'text'&>"
37937 .cindex "reverse DNS lookup"
37938 .cindex "DNS" "reverse lookup"
37939 This records the name of the remote host from which the message was received,
37940 if the host name was looked up from the IP address when the message was being
37941 received. It is not present if no reverse lookup was done.
37942
37943 .vitem "&%-ident%&&~<&'text'&>"
37944 For locally submitted messages, this records the login of the originating user,
37945 unless it was a trusted user and the &%-oMt%& option was used to specify an
37946 ident value. For messages received over TCP/IP, this records the ident string
37947 supplied by the remote host, if any.
37948
37949 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37950 This records the IP address of the local interface and the port number through
37951 which a message was received from a remote host. It is omitted for locally
37952 generated messages.
37953
37954 .vitem &%-local%&
37955 The message is from a local sender.
37956
37957 .vitem &%-localerror%&
37958 The message is a locally-generated bounce message.
37959
37960 .vitem "&%-local_scan%&&~<&'string'&>"
37961 This records the data string that was returned by the &[local_scan()]& function
37962 when the message was received &-- the value of the &$local_scan_data$&
37963 variable. It is omitted if no data was returned.
37964
37965 .vitem &%-manual_thaw%&
37966 The message was frozen but has been thawed manually, that is, by an explicit
37967 Exim command rather than via the auto-thaw process.
37968
37969 .vitem &%-N%&
37970 A testing delivery process was started using the &%-N%& option to suppress any
37971 actual deliveries, but delivery was deferred. At any further delivery attempts,
37972 &%-N%& is assumed.
37973
37974 .vitem &%-received_protocol%&
37975 This records the value of the &$received_protocol$& variable, which contains
37976 the name of the protocol by which the message was received.
37977
37978 .vitem &%-sender_set_untrusted%&
37979 The envelope sender of this message was set by an untrusted local caller (used
37980 to ensure that the caller is displayed in queue listings).
37981
37982 .vitem "&%-spam_score_int%&&~<&'number'&>"
37983 If a message was scanned by SpamAssassin, this is present. It records the value
37984 of &$spam_score_int$&.
37985
37986 .vitem &%-tls_certificate_verified%&
37987 A TLS certificate was received from the client that sent this message, and the
37988 certificate was verified by the server.
37989
37990 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37991 When the message was received over an encrypted connection, this records the
37992 name of the cipher suite that was used.
37993
37994 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37995 When the message was received over an encrypted connection, and a certificate
37996 was received from the client, this records the Distinguished Name from that
37997 certificate.
37998 .endlist
37999
38000 Following the options there is a list of those addresses to which the message
38001 is not to be delivered. This set of addresses is initialized from the command
38002 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38003 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38004 the address is added to this set. The addresses are kept internally as a
38005 balanced binary tree, and it is a representation of that tree which is written
38006 to the spool file. If an address is expanded via an alias or forward file, the
38007 original address is added to the tree when deliveries to all its child
38008 addresses are complete.
38009
38010 If the tree is empty, there is a single line in the spool file containing just
38011 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38012 Y or N, followed by an address. The address is the value for the node of the
38013 tree, and the letters indicate whether the node has a left branch and/or a
38014 right branch attached to it, respectively. If branches exist, they immediately
38015 follow. Here is an example of a three-node tree:
38016 .code
38017 YY darcy@austen.fict.example
38018 NN alice@wonderland.fict.example
38019 NN editor@thesaurus.ref.example
38020 .endd
38021 After the non-recipients tree, there is a list of the message's recipients.
38022 This is a simple list, preceded by a count. It includes all the original
38023 recipients of the message, including those to whom the message has already been
38024 delivered. In the simplest case, the list contains one address per line. For
38025 example:
38026 .code
38027 4
38028 editor@thesaurus.ref.example
38029 darcy@austen.fict.example
38030 rdo@foundation
38031 alice@wonderland.fict.example
38032 .endd
38033 However, when a child address has been added to the top-level addresses as a
38034 result of the use of the &%one_time%& option on a &(redirect)& router, each
38035 line is of the following form:
38036 .display
38037 <&'top-level address'&> <&'errors_to address'&> &&&
38038   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38039 .endd
38040 The 01 flag bit indicates the presence of the three other fields that follow
38041 the top-level address. Other bits may be used in future to support additional
38042 fields. The <&'parent number'&> is the offset in the recipients list of the
38043 original parent of the &"one time"& address. The first two fields are the
38044 envelope sender that is associated with this address and its length. If the
38045 length is zero, there is no special envelope sender (there are then two space
38046 characters in the line). A non-empty field can arise from a &(redirect)& router
38047 that has an &%errors_to%& setting.
38048
38049
38050 A blank line separates the envelope and status information from the headers
38051 which follow. A header may occupy several lines of the file, and to save effort
38052 when reading it in, each header is preceded by a number and an identifying
38053 character. The number is the number of characters in the header, including any
38054 embedded newlines and the terminating newline. The character is one of the
38055 following:
38056
38057 .table2 50pt
38058 .row <&'blank'&>         "header in which Exim has no special interest"
38059 .row &`B`&               "&'Bcc:'& header"
38060 .row &`C`&               "&'Cc:'& header"
38061 .row &`F`&               "&'From:'& header"
38062 .row &`I`&               "&'Message-id:'& header"
38063 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38064 .row &`R`&               "&'Reply-To:'& header"
38065 .row &`S`&               "&'Sender:'& header"
38066 .row &`T`&               "&'To:'& header"
38067 .row &`*`&               "replaced or deleted header"
38068 .endtable
38069
38070 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38071 purposes. They are not transmitted when the message is delivered. Here is a
38072 typical set of headers:
38073 .code
38074 111P Received: by hobbit.fict.example with local (Exim 4.00)
38075 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38076 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38077 038* X-rewrote-sender: bb@hobbit.fict.example
38078 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38079 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38080 099* To: alice@wonderland.fict.example, rdo@foundation,
38081 darcy@austen.fict.example, editor@thesaurus.ref.example
38082 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38083 darcy@austen.fict.example, editor@thesaurus.ref.example
38084 038  Date: Fri, 11 May 2001 10:28:59 +0100
38085 .endd
38086 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38087 &'To:'& header have been rewritten, the last one because routing expanded the
38088 unqualified domain &'foundation'&.
38089 .ecindex IIDforspo1
38090 .ecindex IIDforspo2
38091 .ecindex IIDforspo3
38092
38093 . ////////////////////////////////////////////////////////////////////////////
38094 . ////////////////////////////////////////////////////////////////////////////
38095
38096 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38097          "DKIM Support"
38098 .cindex "DKIM"
38099
38100 DKIM is a mechanism by which messages sent by some entity can be provably
38101 linked to a domain which that entity controls.  It permits reputation to
38102 be tracked on a per-domain basis, rather than merely upon source IP address.
38103 DKIM is documented in RFC 4871.
38104
38105 DKIM support is compiled into Exim by default if TLS support is present.
38106 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38107
38108 Exim's DKIM implementation allows to
38109 .olist
38110 Sign outgoing messages: This function is implemented in the SMTP transport.
38111 It can co-exist with all other Exim features
38112 (including transport filters)
38113 except cutthrough delivery.
38114 .next
38115 Verify signatures in incoming messages: This is implemented by an additional
38116 ACL (acl_smtp_dkim), which can be called several times per message, with
38117 different signature contexts.
38118 .endlist
38119
38120 In typical Exim style, the verification implementation does not include any
38121 default "policy". Instead it enables you to build your own policy using
38122 Exim's standard controls.
38123
38124 Please note that verification of DKIM signatures in incoming mail is turned
38125 on by default for logging purposes. For each signature in incoming email,
38126 exim will log a line displaying the most important signature details, and the
38127 signature status. Here is an example (with line-breaks added for clarity):
38128 .code
38129 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38130     d=facebookmail.com s=q1-2009b
38131     c=relaxed/relaxed a=rsa-sha1
38132     i=@facebookmail.com t=1252484542 [verification succeeded]
38133 .endd
38134 You might want to turn off DKIM verification processing entirely for internal
38135 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38136 control modifier. This should typically be done in the RCPT ACL, at points
38137 where you accept mail from relay sources (internal hosts or authenticated
38138 senders).
38139
38140
38141 .section "Signing outgoing messages" "SECDKIMSIGN"
38142 .cindex "DKIM" "signing"
38143
38144 Signing is enabled by setting private options on the SMTP transport.
38145 These options take (expandable) strings as arguments.
38146
38147 .option dkim_domain smtp string&!! unset
38148 MANDATORY:
38149 The domain you want to sign with. The result of this expanded
38150 option is put into the &%$dkim_domain%& expansion variable.
38151
38152 .option dkim_selector smtp string&!! unset
38153 MANDATORY:
38154 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38155 variable to look up a matching selector. The result is put in the expansion
38156 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38157 option along with &%$dkim_domain%&.
38158
38159 .option dkim_private_key smtp string&!! unset
38160 MANDATORY:
38161 This sets the private key to use. You can use the &%$dkim_domain%& and
38162 &%$dkim_selector%& expansion variables to determine the private key to use.
38163 The result can either
38164 .ilist
38165 be a valid RSA private key in ASCII armor, including line breaks.
38166 .next
38167 start with a slash, in which case it is treated as a file that contains
38168 the private key.
38169 .next
38170 be "0", "false" or the empty string, in which case the message will not
38171 be signed. This case will not result in an error, even if &%dkim_strict%&
38172 is set.
38173 .endlist
38174
38175 .option dkim_canon smtp string&!! unset
38176 OPTIONAL:
38177 This option sets the canonicalization method used when signing a message.
38178 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38179 The option defaults to "relaxed" when unset. Note: the current implementation
38180 only supports using the same canonicalization method for both headers and body.
38181
38182 .option dkim_strict smtp string&!! unset
38183 OPTIONAL:
38184 This  option  defines  how  Exim  behaves  when  signing a message that
38185 should be signed fails for some reason.  When the expansion evaluates to
38186 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38187 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38188 variables here.
38189
38190 .option dkim_sign_headers smtp string&!! unset
38191 OPTIONAL:
38192 When set, this option must expand to (or be specified as) a colon-separated
38193 list of header names. Headers with these names will be included in the message
38194 signature. When unspecified, the header names recommended in RFC4871 will be
38195 used.
38196
38197
38198 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38199 .cindex "DKIM" "verification"
38200
38201 Verification of DKIM signatures in SMTP incoming email is implemented via the
38202 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38203 syntactically(!) correct signature in the incoming message.
38204 A missing ACL definition defaults to accept.
38205 If any ACL call does not accept, the message is not accepted.
38206 If a cutthrough delivery was in progress for the message it is
38207 summarily dropped (having wasted the transmission effort).
38208
38209 To evaluate the signature in the ACL a large number of expansion variables
38210 containing the signature status and its details are set up during the
38211 runtime of the ACL.
38212
38213 Calling the ACL only for existing signatures is not sufficient to build
38214 more advanced policies. For that reason, the global option
38215 &%dkim_verify_signers%&, and a global expansion variable
38216 &%$dkim_signers%& exist.
38217
38218 The global option &%dkim_verify_signers%& can be set to a colon-separated
38219 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38220 called. It is expanded when the message has been received. At this point,
38221 the expansion variable &%$dkim_signers%& already contains a colon-separated
38222 list of signer domains and identities for the message. When
38223 &%dkim_verify_signers%& is not specified in the main configuration,
38224 it defaults as:
38225 .code
38226 dkim_verify_signers = $dkim_signers
38227 .endd
38228 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38229 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38230 call the ACL for known domains or identities. This would be achieved as follows:
38231 .code
38232 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38233 .endd
38234 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38235 and "ebay.com", plus all domains and identities that have signatures in the message.
38236 You can also be more creative in constructing your policy. For example:
38237 .code
38238 dkim_verify_signers = $sender_address_domain:$dkim_signers
38239 .endd
38240
38241 If a domain or identity is listed several times in the (expanded) value of
38242 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38243
38244
38245 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38246 available (from most to least important):
38247
38248
38249 .vlist
38250 .vitem &%$dkim_cur_signer%&
38251 The signer that is being evaluated in this ACL run. This can be a domain or
38252 an identity. This is one of the list items from the expanded main option
38253 &%dkim_verify_signers%& (see above).
38254 .vitem &%$dkim_verify_status%&
38255 A string describing the general status of the signature. One of
38256 .ilist
38257 &%none%&: There is no signature in the message for the current domain or
38258 identity (as reflected by &%$dkim_cur_signer%&).
38259 .next
38260 &%invalid%&: The signature could not be verified due to a processing error.
38261 More detail is available in &%$dkim_verify_reason%&.
38262 .next
38263 &%fail%&: Verification of the signature failed.  More detail is
38264 available in &%$dkim_verify_reason%&.
38265 .next
38266 &%pass%&: The signature passed verification. It is valid.
38267 .endlist
38268 .vitem &%$dkim_verify_reason%&
38269 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38270 "fail" or "invalid". One of
38271 .ilist
38272 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38273 key for the domain could not be retrieved. This may be a temporary problem.
38274 .next
38275 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38276 record for the domain is syntactically invalid.
38277 .next
38278 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38279 body hash does not match the one specified in the signature header. This
38280 means that the message body was modified in transit.
38281 .next
38282 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38283 could not be verified. This may mean that headers were modified,
38284 re-written or otherwise changed in a way which is incompatible with
38285 DKIM verification. It may of course also mean that the signature is forged.
38286 .endlist
38287 .vitem &%$dkim_domain%&
38288 The signing domain. IMPORTANT: This variable is only populated if there is
38289 an actual signature in the message for the current domain or identity (as
38290 reflected by &%$dkim_cur_signer%&).
38291 .vitem &%$dkim_identity%&
38292 The signing identity, if present. IMPORTANT: This variable is only populated
38293 if there is an actual signature in the message for the current domain or
38294 identity (as reflected by &%$dkim_cur_signer%&).
38295 .vitem &%$dkim_selector%&
38296 The key record selector string.
38297 .vitem &%$dkim_algo%&
38298 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38299 .vitem &%$dkim_canon_body%&
38300 The body canonicalization method. One of 'relaxed' or 'simple'.
38301 .vitem &%dkim_canon_headers%&
38302 The header canonicalization method. One of 'relaxed' or 'simple'.
38303 .vitem &%$dkim_copiedheaders%&
38304 A transcript of headers and their values which are included in the signature
38305 (copied from the 'z=' tag of the signature).
38306 .vitem &%$dkim_bodylength%&
38307 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38308 limit was set by the signer, "9999999999999" is returned. This makes sure
38309 that this variable always expands to an integer value.
38310 .vitem &%$dkim_created%&
38311 UNIX timestamp reflecting the date and time when the signature was created.
38312 When this was not specified by the signer, "0" is returned.
38313 .vitem &%$dkim_expires%&
38314 UNIX timestamp reflecting the date and time when the signer wants the
38315 signature to be treated as "expired". When this was not specified by the
38316 signer, "9999999999999" is returned. This makes it possible to do useful
38317 integer size comparisons against this value.
38318 .vitem &%$dkim_headernames%&
38319 A colon-separated list of names of headers included in the signature.
38320 .vitem &%$dkim_key_testing%&
38321 "1" if the key record has the "testing" flag set, "0" if not.
38322 .vitem &%$dkim_key_nosubdomains%&
38323 "1" if the key record forbids subdomaining, "0" otherwise.
38324 .vitem &%$dkim_key_srvtype%&
38325 Service type (tag s=) from the key record. Defaults to "*" if not specified
38326 in the key record.
38327 .vitem &%$dkim_key_granularity%&
38328 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38329 in the key record.
38330 .vitem &%$dkim_key_notes%&
38331 Notes from the key record (tag n=).
38332 .vitem &%$dkim_key_length%&
38333 Number of bits in the key.
38334 .endlist
38335
38336 In addition, two ACL conditions are provided:
38337
38338 .vlist
38339 .vitem &%dkim_signers%&
38340 ACL condition that checks a colon-separated list of domains or identities
38341 for a match against the domain or identity that the ACL is currently verifying
38342 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38343 verb to a group of domains or identities. For example:
38344
38345 .code
38346 # Warn when Mail purportedly from GMail has no signature at all
38347 warn log_message = GMail sender without DKIM signature
38348      sender_domains = gmail.com
38349      dkim_signers = gmail.com
38350      dkim_status = none
38351 .endd
38352
38353 .vitem &%dkim_status%&
38354 ACL condition that checks a colon-separated list of possible DKIM verification
38355 results against the actual result of verification. This is typically used
38356 to restrict an ACL verb to a list of verification outcomes, for example:
38357
38358 .code
38359 deny message = Mail from Paypal with invalid/missing signature
38360      sender_domains = paypal.com:paypal.de
38361      dkim_signers = paypal.com:paypal.de
38362      dkim_status = none:invalid:fail
38363 .endd
38364
38365 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38366 see the documentation of the &%$dkim_verify_status%& expansion variable above
38367 for more information of what they mean.
38368 .endlist
38369
38370 . ////////////////////////////////////////////////////////////////////////////
38371 . ////////////////////////////////////////////////////////////////////////////
38372
38373 .chapter "Proxies" "CHAPproxies" &&&
38374          "Proxy support"
38375 .cindex "proxy support"
38376 .cindex "proxy" "access via"
38377
38378 A proxy is an intermediate system through which communication is passed.
38379 Proxies may provide a security, availability or load-distribution function.
38380
38381
38382 .section "Inbound proxies" SECTproxyInbound
38383 .cindex proxy inbound
38384 .cindex proxy "server side"
38385 .cindex proxy "Proxy protocol"
38386 .cindex "Proxy protocol" proxy
38387
38388 Exim has support for receiving inbound SMTP connections via a proxy
38389 that uses &"Proxy Protocol"& to speak to it.
38390 To include this support, include &"SUPPORT_PROXY=yes"&
38391 in Local/Makefile.
38392
38393 It was built on specifications from:
38394 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38395 That URL was revised in May 2014 to version 2 spec:
38396 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38397
38398 The purpose of this facility is so that an application load balancer,
38399 such as HAProxy, can sit in front of several Exim servers
38400 to distribute load.
38401 Exim uses the local protocol communication with the proxy to obtain
38402 the remote SMTP system IP address and port information.
38403 There is no logging if a host passes or
38404 fails Proxy Protocol negotiation, but it can easily be determined and
38405 recorded in an ACL (example is below).
38406
38407 Use of a proxy is enabled by setting the &%hosts_proxy%&
38408 main configuration option to a hostlist; connections from these
38409 hosts will use Proxy Protocol.
38410
38411 .new
38412 The following expansion variables are usable
38413 (&"internal"& and &"external"& here refer to the interfaces
38414 of the proxy):
38415 .display
38416 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38417 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38418 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38419 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38420 &'proxy_session        '& boolean: SMTP connection via proxy
38421 .endd
38422 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38423 there was a protocol error.
38424 .wen
38425
38426 Since the real connections are all coming from the proxy, and the
38427 per host connection tracking is done before Proxy Protocol is
38428 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38429 handle all of the parallel volume you expect per inbound proxy.
38430 With the option set so high, you lose the ability
38431 to protect your server from many connections from one IP.
38432 In order to prevent your server from overload, you
38433 need to add a per connection ratelimit to your connect ACL.
38434 A possible solution is:
38435 .display
38436   # Set max number of connections per host
38437   LIMIT   = 5
38438   # Or do some kind of IP lookup in a flat file or database
38439   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38440
38441   defer   message        = Too many connections from this IP right now
38442           ratelimit      = LIMIT / 5s / per_conn / strict
38443 .endd
38444
38445
38446
38447 .section "Outbound proxies" SECTproxySOCKS
38448 .cindex proxy outbound
38449 .cindex proxy "client side"
38450 .cindex proxy SOCKS
38451 .cindex SOCKS proxy
38452 Exim has support for sending outbound SMTP via a proxy
38453 using a protocol called SOCKS5 (defined by RFC1928).
38454 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38455 Local/Makefile.
38456
38457 Use of a proxy is enabled by setting the &%socks_proxy%& option
38458 on an smtp transport.
38459 The option value is expanded and should then be a list
38460 (colon-separated by default) of proxy specifiers.
38461 Each proxy specifier is a list
38462 (space-separated by default) where the initial element
38463 is an IP address and any subsequent elements are options.
38464
38465 Options are a string <name>=<value>.
38466 The list of options is in the following table:
38467 .display
38468 &'auth   '& authentication method
38469 &'name   '& authentication username
38470 &'pass   '& authentication password
38471 &'port   '& tcp port
38472 &'tmo    '& connection timeout
38473 &'pri    '& priority
38474 &'weight '& selection bias
38475 .endd
38476
38477 More details on each of these options follows:
38478
38479 .ilist
38480 .cindex authentication "to proxy"
38481 .cindex proxy authentication
38482 &%auth%&: Either &"none"& (default) or &"name"&.
38483 Using &"name"& selects username/password authentication per RFC 1929
38484 for access to the proxy.
38485 Default is &"none"&.
38486 .next
38487 &%name%&: sets the username for the &"name"& authentication method.
38488 Default is empty.
38489 .next
38490 &%pass%&: sets the password for the &"name"& authentication method.
38491 Default is empty.
38492 .next
38493 &%port%&: the TCP port number to use for the connection to the proxy.
38494 Default is 1080.
38495 .next
38496 &%tmo%&: sets a connection timeout in seconds for this proxy.
38497 Default is 5.
38498 .next
38499 &%pri%&: specifies a priority for the proxy within the list,
38500 higher values being tried first.
38501 The default priority is 1.
38502 .next
38503 &%weight%&: specifies a selection bias.
38504 Within a priority set servers are queried in a random fashion,
38505 weighted by this value.
38506 The default value for selection bias is 1.
38507 .endlist
38508
38509 Proxies from the list are tried according to their priority
38510 and weight settings until one responds.  The timeout for the
38511 overall connection applies to the set of proxied attempts.
38512
38513 .section Logging SECTproxyLog
38514 To log the (local) IP of a proxy in the incoming or delivery logline,
38515 add &"+proxy"& to the &%log_selector%& option.
38516 This will add a component tagged with &"PRX="& to the line.
38517
38518 . ////////////////////////////////////////////////////////////////////////////
38519 . ////////////////////////////////////////////////////////////////////////////
38520
38521 .chapter "Internationalisation" "CHAPi18n" &&&
38522          "Internationalisation""
38523 .cindex internationalisation "email address"
38524 .cindex EAI
38525 .cindex i18n
38526 .cindex UTF-8 "mail name handling"
38527
38528 Exim has support for Internationalised mail names.
38529 To include this it must be built with SUPPORT_I18N and the libidn library.
38530 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38531
38532 .section "MTA operations" SECTi18nMTA
38533 .cindex SMTPUTF8 "ESMTP option"
38534 The main configuration option &%smtputf8_advertise_hosts%& specifies
38535 a host list.  If this matches the sending host and
38536 accept_8bitmime is true (the default) then the ESMTP option
38537 SMTPUTF8 will be advertised.
38538
38539 If the sender specifies the SMTPUTF8 option on a MAIL command
38540 international handling for the message is enabled and
38541 the expansion variable &$message_smtputf8$& will have value TRUE.
38542
38543 The option &%allow_utf8_domains%& is set to true for this
38544 message. All DNS lookups are converted to a-label form
38545 whatever the setting of &%allow_utf8_domains%&
38546 when Exim is built with SUPPORT_I18N.
38547
38548 Both localparts and domain are maintained as the original
38549 UTF-8 form internally; any comparison or regular-expression use will
38550 require appropriate care.  Filenames created, eg. by
38551 the appendfile transport, will have UTF-8 names.
38552
38553 HELO names sent by the smtp transport will have any UTF-8
38554 components expanded to a-label form,
38555 and any certificate name checks will be done using the a-label
38556 form of the name.
38557
38558 .cindex log protocol
38559 .cindex SMTPUTF8 logging
38560 Log lines and Received-by: header lines will acquire a "utf8"
38561 prefix on the protocol element, eg. utf8esmtp.
38562
38563 The following expansion operators can be used:
38564 .code
38565 ${utf8_domain_to_alabel:str}
38566 ${utf8_domain_from_alabel:str}
38567 ${utf8_localpart_to_alabel:str}
38568 ${utf8_localpart_from_alabel:str}
38569 .endd
38570
38571 ACLs may use the following modifier:
38572 .display
38573 control = utf8_downconvert
38574 control = utf8_downconvert/<value>
38575 .endd
38576 This sets a flag requiring that addresses are converted to
38577 a-label form before smtp delivery, for use in a
38578 Message Submission Agent context.
38579 If a value is appended it may be:
38580 .display
38581 &`1  `& (default) mandatory downconversion
38582 &`0  `& no downconversion
38583 &`-1 `& if SMTPUTF8 not supported by destination host
38584 .endd
38585
38586 If mua_wrapper is set, the utf8_downconvert control
38587 is initially set to -1.
38588
38589
38590 There is no explicit support for VRFY and EXPN.
38591 Configurations supporting these should inspect
38592 &$smtp_command_argument$& for an SMTPUTF8 argument.
38593
38594 There is no support for LMTP on Unix sockets.
38595 Using the "lmtp" protocol option on an smtp transport,
38596 for LMTP over TCP, should work as expected.
38597
38598 There is no support for DSN unitext handling,
38599 and no provision for converting logging from or to UTF-8.
38600
38601
38602
38603 .section "MDA operations" SECTi18nMDA
38604 To aid in constructing names suitable for IMAP folders
38605 the following expansion operator can be used:
38606 .code
38607 ${imapfolder {<string>} {<sep>} {<specials>}}
38608 .endd
38609
38610 The string is converted from the charset specified by
38611 the "headers charset" command (in a filter file)
38612 or &%headers_charset%& main configuration option (otherwise),
38613 to the
38614 modified UTF-7 encoding specified by RFC 2060,
38615 with the following exception: All occurences of <sep>
38616 (which has to be a single character)
38617 are replaced with periods ("."), and all periods and slashes that are not
38618 <sep> and are not in the <specials> string are BASE64 encoded.
38619
38620 The third argument can be omitted, defaulting to an empty string.
38621 The second argument can be omitted, defaulting to "/".
38622
38623 This is the encoding used by Courier for Maildir names on disk, and followed
38624 by many other IMAP servers.
38625
38626 Examples:
38627 .display
38628 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38629 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38630 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38631 .endd
38632
38633 Note that the source charset setting is vital, and also that characters
38634 must be representable in UTF-16.
38635
38636
38637 . ////////////////////////////////////////////////////////////////////////////
38638 . ////////////////////////////////////////////////////////////////////////////
38639
38640 .chapter "Events" "CHAPevents" &&&
38641          "Events"
38642 .cindex events
38643
38644 The events mechanism in Exim can be used to intercept processing at a number
38645 of points.  It was originally invented to giave a way to do customised logging
38646 actions (for example, to a database) but can also be used to modify some
38647 processing actions.
38648
38649 Most installations will never need to use Events.
38650 The support can be left out of a build by defining DISABLE_EVENT=yes
38651 in &_Local/Makefile_&.
38652
38653 There are two major classes of events: main and transport.
38654 The main configuration option &%event_action%& controls reception events;
38655 a transport option &%event_action%& controls delivery events.
38656
38657 Both options are a string which is expanded when the event fires.
38658 An example might look like:
38659 .cindex logging custom
38660 .code
38661 event_action = ${if eq {msg:delivery}{$event_name} \
38662 {${lookup pgsql {SELECT * FROM record_Delivery( \
38663     '${quote_pgsql:$sender_address_domain}',\
38664     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38665     '${quote_pgsql:$domain}', \
38666     '${quote_pgsql:${lc:$local_part}}', \
38667     '${quote_pgsql:$host_address}', \
38668     '${quote_pgsql:${lc:$host}}', \
38669     '${quote_pgsql:$message_exim_id}')}} \
38670 } {}}
38671 .endd
38672
38673 Events have names which correspond to the point in process at which they fire.
38674 The name is placed in the variable &$event_name$& and the event action
38675 expansion must check this, as it will be called for every possible event type.
38676
38677 The current list of events is:
38678 .display
38679 &`msg:complete           after    main       `& per message
38680 &`msg:delivery           after    transport  `& per recipient
38681 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38682 &`msg:rcpt:defer         after    transport  `& per recipient
38683 &`msg:host:defer         after    transport  `& per attempt
38684 &`msg:fail:delivery      after    main       `& per recipient
38685 &`msg:fail:internal      after    main       `& per recipient
38686 &`tcp:connect            before   transport  `& per connection
38687 &`tcp:close              after    transport  `& per connection
38688 &`tls:cert               before   both       `& per certificate in verification chain
38689 &`smtp:connect           after    transport  `& per connection
38690 .endd
38691 New event types may be added in future.
38692
38693 The event name is a colon-separated list, defining the type of
38694 event in a tree of possibilities.  It may be used as a list
38695 or just matched on as a whole.  There will be no spaces in the name.
38696
38697 The second column in the table above describes whether the event fires
38698 before or after the action is associates with.  Those which fire before
38699 can be used to affect that action (more on this below).
38700
38701 An additional variable, &$event_data$&, is filled with information varying
38702 with the event type:
38703 .display
38704 &`msg:delivery         `& smtp confirmation mssage
38705 &`msg:rcpt:host:defer  `& error string
38706 &`msg:rcpt:defer       `& error string
38707 &`msg:host:defer       `& error string
38708 &`tls:cert             `& verification chain depth
38709 &`smtp:connect         `& smtp banner
38710 .endd
38711
38712 The :defer events populate one extra variable: &$event_defer_errno$&.
38713
38714 For complex operations an ACL expansion can be used in &%event_action%&
38715 however due to the multiple contextx that Exim operates in during
38716 the course of its processing:
38717 .ilist
38718 variables set in transport events will not be visible outside that
38719 transport call
38720 .next
38721 acl_m variables in a server context are lost on a new connection,
38722 and after smtp helo/ehlo/mail/starttls/rset commands
38723 .endlist
38724 Using an ACL expansion with the logwrite modifier can be
38725 a useful way of writing to the main log.
38726
38727 The expansion of the event_action option should normally
38728 return an empty string.  Should it return anything else the
38729 following will be forced:
38730 .display
38731 &`msg:delivery     `&  (ignored)
38732 &`msg:host:defer   `&  (ignored)
38733 &`msg:fail:delivery`&  (ignored)
38734 &`tcp:connect      `&  do not connect
38735 &`tcp:close        `&  (ignored)
38736 &`tls:cert         `&  refuse verification
38737 &`smtp:connect     `&  close connection
38738 .endd
38739 No other use is made of the result string.
38740
38741 For a tcp:connect event, if the connection is being made to a proxy
38742 then the address and port variables will be that of the proxy and not
38743 the target system.
38744
38745 For tls:cert events, if GnuTLS is in use this will trigger only per
38746 chain element received on the connection.
38747 For OpenSSL it will trigger for every chain element including those
38748 loaded locally.
38749
38750 . ////////////////////////////////////////////////////////////////////////////
38751 . ////////////////////////////////////////////////////////////////////////////
38752
38753 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38754          "Adding drivers or lookups"
38755 .cindex "adding drivers"
38756 .cindex "new drivers, adding"
38757 .cindex "drivers" "adding new"
38758 The following actions have to be taken in order to add a new router, transport,
38759 authenticator, or lookup type to Exim:
38760
38761 .olist
38762 Choose a name for the driver or lookup type that does not conflict with any
38763 existing name; I will use &"newdriver"& in what follows.
38764 .next
38765 Add to &_src/EDITME_& the line:
38766 .display
38767 <&'type'&>&`_NEWDRIVER=yes`&
38768 .endd
38769 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38770 code is not to be included in the binary by default, comment this line out. You
38771 should also add any relevant comments about the driver or lookup type.
38772 .next
38773 Add to &_src/config.h.defaults_& the line:
38774 .code
38775 #define <type>_NEWDRIVER
38776 .endd
38777 .next
38778 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38779 and create a table entry as is done for all the other drivers and lookup types.
38780 .next
38781 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38782 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38783 Add your &`NEWDRIVER`& to that list.
38784 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38785 simple form that most lookups have.
38786 .next
38787 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38788 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38789 driver or lookup type and add it to the definition of OBJ.
38790 .next
38791 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38792 &_src_&.
38793 .next
38794 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38795 as for other drivers and lookups.
38796 .endlist
38797
38798 Then all you need to do is write the code! A good way to start is to make a
38799 proforma by copying an existing module of the same type, globally changing all
38800 occurrences of the name, and cutting out most of the code. Note that any
38801 options you create must be listed in alphabetical order, because the tables are
38802 searched using a binary chop procedure.
38803
38804 There is a &_README_& file in each of the sub-directories of &_src_& describing
38805 the interface that is expected.
38806
38807
38808
38809
38810 . ////////////////////////////////////////////////////////////////////////////
38811 . ////////////////////////////////////////////////////////////////////////////
38812
38813 . /////////////////////////////////////////////////////////////////////////////
38814 . These lines are processing instructions for the Simple DocBook Processor that
38815 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38816 . PDFs than using xmlto and fop. They will be ignored by all other XML
38817 . processors.
38818 . /////////////////////////////////////////////////////////////////////////////
38819
38820 .literal xml
38821 <?sdop
38822   format="newpage"
38823   foot_right_recto="&chaptertitle;"
38824   foot_right_verso="&chaptertitle;"
38825 ?>
38826 .literal off
38827
38828 .makeindex "Options index"   "option"
38829 .makeindex "Variables index" "variable"
38830 .makeindex "Concept index"   "concept"
38831
38832
38833 . /////////////////////////////////////////////////////////////////////////////
38834 . /////////////////////////////////////////////////////////////////////////////